Using comparator is a similar interface as the toplevel of Set
, except the functions
take a ~comparator:('elt, 'cmp) Comparator.t
where the functions at the toplevel of
Set
takes a ('elt, 'cmp) comparator
.
include sig ... end
val sexp_of_t : ('elt ‑> Base__.Sexplib.Sexp.t) ‑> ('cmp ‑> Base__.Sexplib.Sexp.t) ‑> ('elt, 'cmp) t ‑> Base__.Sexplib.Sexp.t
val t_of_sexp_direct : comparator:('elt, 'cmp) Comparator.t ‑> (Sexp.t ‑> 'elt) ‑> Sexp.t ‑> ('elt, 'cmp) t
module Tree : sig ... end
include Set_intf.Accessors2 with type (a, b) t := (a, b) t with type (a, b) tree := (a, b) Tree.t
include Container.S1_phantom_invariant
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 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
val invariants : (_, _) t ‑> bool
val mem : ('a, _) t ‑> 'a ‑> bool
val symmetric_diff : ('a, 'cmp) t ‑> ('a, 'cmp) t ‑> ('a, 'a) Either.t Sequence.t
val fold_until : ('a, _) t ‑> init:'b ‑> f:('b ‑> 'a ‑> ('b, 'stop) Set_intf.Continue_or_stop.t) ‑> ('b, 'stop) Set_intf.Finished_or_stopped_early.t
val fold_right : ('a, _) t ‑> init:'b ‑> f:('a ‑> 'b ‑> 'b) ‑> 'b
val elements : ('a, _) t ‑> 'a list
val min_elt : ('a, _) t ‑> 'a option
val min_elt_exn : ('a, _) t ‑> 'a
val max_elt : ('a, _) t ‑> 'a option
val max_elt_exn : ('a, _) t ‑> 'a
val choose : ('a, _) t ‑> 'a option
val choose_exn : ('a, _) t ‑> 'a
val find_exn : ('a, _) t ‑> f:('a ‑> bool) ‑> 'a
val find_index : ('a, _) t ‑> int ‑> 'a option
val nth : ('a, _) t ‑> int ‑> 'a option
val to_sequence : ?order:[ `Increasing | `Decreasing ] ‑> ?greater_or_equal_to:'a ‑> ?less_or_equal_to:'a ‑> ('a, 'cmp) t ‑> 'a Sequence.t
val merge_to_sequence : ?order:[ `Increasing | `Decreasing ] ‑> ?greater_or_equal_to:'a ‑> ?less_or_equal_to:'a ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t ‑> ('a, 'a) Set_intf.Merge_to_sequence_element.t Sequence.t
include Set_intf.Creators2_with_comparator with type (a, b) t := (a, b) t with type (a, b) tree := (a, b) Tree.t with type (a, b) set := (a, b) t
val empty : comparator:('a, 'cmp) Comparator.t ‑> ('a, 'cmp) t
val singleton : comparator:('a, 'cmp) Comparator.t ‑> 'a ‑> ('a, 'cmp) t
val union_list : comparator:('a, 'cmp) Comparator.t ‑> ('a, 'cmp) t list ‑> ('a, 'cmp) t
val of_list : comparator:('a, 'cmp) Comparator.t ‑> 'a list ‑> ('a, 'cmp) t
val of_array : comparator:('a, 'cmp) Comparator.t ‑> 'a array ‑> ('a, 'cmp) t
val of_sorted_array : comparator:('a, 'cmp) Comparator.t ‑> 'a array ‑> ('a, 'cmp) t Or_error.t
val of_sorted_array_unchecked : comparator:('a, 'cmp) Comparator.t ‑> 'a array ‑> ('a, 'cmp) t
val of_increasing_iterator_unchecked : comparator:('a, 'cmp) Comparator.t ‑> len:int ‑> f:(int ‑> 'a) ‑> ('a, 'cmp) t
val stable_dedup_list : comparator:('a, 'cmp) Comparator.t ‑> 'a list ‑> 'a list
val map : comparator:('b, 'cmp) Comparator.t ‑> ('a, _) set ‑> f:('a ‑> 'b) ‑> ('b, 'cmp) t
val filter_map : comparator:('b, 'cmp) Comparator.t ‑> ('a, _) set ‑> f:('a ‑> 'b option) ‑> ('b, 'cmp) t
val of_tree : comparator:('a, 'cmp) Comparator.t ‑> ('a, 'cmp) tree ‑> ('a, 'cmp) t
val comparator : ('a, 'cmp) t ‑> ('a, 'cmp) Comparator.t
val hash_fold_direct : 'elt Hash.folder ‑> ('elt, 'cmp) t Hash.folder
module Empty_without_value_restriction : functor (Elt : Comparator.S1) -> sig ... end