include Monad.S2 with type (a, b) t := (a, b) t
include Base__.Monad_intf.Syntax2 with type (a, e) t := (a, e) t
module Let_syntax : sig ... end
module Monad_infix : Base__.Monad_intf.Infix2 with type (a, e) t := (a, e) t
val return : 'a ‑> ('a, _) t
include Applicative.S2 with type (a, b) t := (a, b) t
val return : 'a ‑> ('a, _) t
module Applicative_infix : sig ... end
include Container.S1_phantom with type (a, b) t := (a, b) t
include Container_intf.S1_phantom_invariant with type (a, phantom) t := (a, phantom) t
val mem : ('a, _) t ‑> 'a ‑> equal:('a ‑> 'a ‑> bool) ‑> bool
Checks whether the provided element is there, using equal
.
val length : (_, _) t ‑> int
val is_empty : (_, _) t ‑> bool
val iter : ('a, _) t ‑> f:('a ‑> unit) ‑> unit
val fold : ('a, _) 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, _) 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, _) t ‑> init:'accum ‑> f:('accum ‑> 'a ‑> ('accum, 'stop) Container_intf.Continue_or_stop.t) ‑> ('accum, 'stop) Container_intf.Finished_or_stopped_early.t
fold_until t ~init ~f
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.
val exists : ('a, _) t ‑> f:('a ‑> bool) ‑> bool
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, _) t ‑> f:('a ‑> bool) ‑> bool
Returns true
if and only if the provided function evaluates to true
for all
elements. This is a short-circuiting operation.
val count : ('a, _) t ‑> f:('a ‑> bool) ‑> int
Returns the number of elements for which the provided function evaluates to true.
val sum : (module Commutative_group.S with type t = 'sum) ‑> ('a, _) t ‑> f:('a ‑> 'sum) ‑> 'sum
Returns the sum of f i
for all i
in the container.
val find : ('a, _) t ‑> f:('a ‑> bool) ‑> 'a option
Returns as an option
the first element for which f
evaluates to true.
val find_map : ('a, _) t ‑> f:('a ‑> 'b option) ‑> 'b option
Returns the first evaluation of f
that returns Some
, and returns None
if there
is no such element.
val to_list : ('a, _) t ‑> 'a list
val to_array : ('a, _) t ‑> 'a array
val min_elt : ('a, _) t ‑> cmp:('a ‑> 'a ‑> int) ‑> 'a option
Returns a min (resp max) element from the collection using the provided cmp
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, _) t ‑> cmp:('a ‑> 'a ‑> int) ‑> 'a option
module Args : Applicative.Args2 with type (a, e) arg := (a, e) t
val value : ('a, _) t ‑> default:'a ‑> 'a
val to_option : ('a, _) t ‑> 'a option
val with_return : ('a With_return.return ‑> 'b) ‑> ('a, 'b) t