package core_kernel

  1. Overview
  2. Docs
package core_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type
type ('a, -'perms) t
val t_of_sexp : (Ppx_sexp_conv_lib.Sexp.t -> 'a) -> (Ppx_sexp_conv_lib.Sexp.t -> 'perms) -> Ppx_sexp_conv_lib.Sexp.t -> ('a, 'perms) t
val sexp_of_t : ('a -> Ppx_sexp_conv_lib.Sexp.t) -> ('perms -> Ppx_sexp_conv_lib.Sexp.t) -> ('a, 'perms) t -> Ppx_sexp_conv_lib.Sexp.t
val bin_t : 'a Bin_prot.Type_class.t -> 'perms Bin_prot.Type_class.t -> ('a, 'perms) t Bin_prot.Type_class.t
val bin_read_t : 'a Bin_prot.Read.reader -> 'perms Bin_prot.Read.reader -> ('a, 'perms) t Bin_prot.Read.reader
val __bin_read_t__ : 'a Bin_prot.Read.reader -> 'perms Bin_prot.Read.reader -> (Base.Int.t -> ('a, 'perms) t) Bin_prot.Read.reader
val bin_size_t : 'a Bin_prot.Size.sizer -> 'perms Bin_prot.Size.sizer -> ('a, 'perms) t Bin_prot.Size.sizer
val bin_write_t : 'a Bin_prot.Write.writer -> 'perms Bin_prot.Write.writer -> ('a, 'perms) t Bin_prot.Write.writer
include Container.S1_permissions with type ('a, 'perms) t := ('a, 'perms) t
val mem : ('a, [> Perms.Export.read ]) t -> 'a -> equal:('a -> 'a -> Base.Bool.t) -> Base.Bool.t

Checks whether the provided element is there, using polymorphic compare if equal is not provided.

val length : (_, [> Perms.Export.read ]) t -> Base.Int.t
val is_empty : (_, [> Perms.Export.read ]) t -> Base.Bool.t
val iter : ('a, [> Perms.Export.read ]) t -> f:('a -> Base.Unit.t) -> Base.Unit.t
val fold : ('a, [> Perms.Export.read ]) t -> init:'accum -> f:('accum -> 'a -> 'accum) -> 'accum

fold t ~init ~f returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of t

val fold_result : ('a, [> Perms.Export.read ]) t -> init:'accum -> f:('accum -> 'a -> ('accum, 'e) Result.t) -> ('accum, 'e) Result.t

fold_result t ~init ~f is a short-circuiting version of fold that runs in the Result monad. If f returns an Error _, that value is returned without any additional invocations of f.

val fold_until : ('a, [> Perms.Export.read ]) t -> init:'accum -> f:('accum -> 'a -> ('accum, 'final) Base.Container.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final

fold_until t ~init ~f ~finish is a short-circuiting version of fold. If f returns Stop _ the computation ceases and results in that value. If f returns Continue _, the fold will proceed. If f never returns Stop _, the final result is computed by finish.

val exists : ('a, [> Perms.Export.read ]) t -> f:('a -> Base.Bool.t) -> Base.Bool.t

Returns true if and only if there exists an element for which the provided function evaluates to true. This is a short-circuiting operation.

val for_all : ('a, [> Perms.Export.read ]) t -> f:('a -> Base.Bool.t) -> Base.Bool.t

Returns true if and only if the provided function evaluates to true for all elements. This is a short-circuiting operation.

val count : ('a, [> Perms.Export.read ]) t -> f:('a -> Base.Bool.t) -> Base.Int.t

Returns the number of elements for which the provided function evaluates to true.

val sum : (module Base.Commutative_group.S with type t = 'sum) -> ('a, [> Perms.Export.read ]) t -> f:('a -> 'sum) -> 'sum

Returns the sum of f i for i in the container

val find : ('a, [> Perms.Export.read ]) t -> f:('a -> Base.Bool.t) -> 'a Base.Option.t

Returns as an option the first element for which f evaluates to true.

val find_map : ('a, [> Perms.Export.read ]) t -> f:('a -> 'b Base.Option.t) -> 'b Base.Option.t

Returns the first evaluation of f that returns Some, and returns None if there is no such element.

val to_list : ('a, [> Perms.Export.read ]) t -> 'a Base.List.t
val to_array : ('a, [> Perms.Export.read ]) t -> 'a Base.Array.t
val min_elt : ('a, [> Perms.Export.read ]) t -> compare:('a -> 'a -> Base.Int.t) -> 'a Base.Option.t

Returns a min (resp max) element from the collection using the provided compare function. In case of a tie, the first element encountered while traversing the collection is returned. The implementation uses fold so it has the same complexity as fold. Returns None iff the collection is empty.

val max_elt : ('a, [> Perms.Export.read ]) t -> compare:('a -> 'a -> Base.Int.t) -> 'a Base.Option.t
val create : 'a -> ('a, [< _ Perms.Export.perms ]) t
val read_only : ('a, [> Perms.Export.read ]) t -> ('a, Perms.Export.read) t
val (!) : ('a, [> Perms.Export.read ]) t -> 'a

get and (!) are two names for the same function.

val get : ('a, [> Perms.Export.read ]) t -> 'a
val set : ('a, [> Perms.Export.write ]) t -> 'a -> Base.Unit.t

set and (:=) are two names for the same function.

val (:=) : ('a, [> Perms.Export.write ]) t -> 'a -> Base.Unit.t
val of_ref : 'a Base.Ref.t -> ('a, [< Perms.Export.read_write ]) t
val to_ref : ('a, [> Perms.Export.read_write ]) t -> 'a Base.Ref.t
val swap : ('a, [> Perms.Export.read_write ]) t -> ('a, [> Perms.Export.read_write ]) t -> Base.Unit.t
val replace : ('a, [> Perms.Export.read_write ]) t -> ('a -> 'a) -> Base.Unit.t
val set_temporarily : ('a, [> Perms.Export.read_write ]) t -> 'a -> f:(Base.Unit.t -> 'b) -> 'b
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct