A Tree.t
contains just the tree data structure that a set is based on, without
including the comparator. Accordingly, any operation on a Tree.t
must also take
as an argument the corresponding comparator.
include sig ... end
val sexp_of_t : ('elt ‑> Sexplib.Sexp.t) ‑> ('cmp ‑> Sexplib.Sexp.t) ‑> ('elt, 'cmp) t ‑> Sexplib.Sexp.t
include Set_intf.Creators_and_accessors2_with_comparator with type (a, b) set := (a, b) t with type (a, b) t := (a, b) t with type (a, b) tree := (a, b) t
include Set_intf.Accessors2_with_comparator
include Set_intf.Set_intf.Accessors2_with_comparator
include Base.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) Base.Result.t) ‑> ('accum, 'e) Base.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) Base.Container_intf.Continue_or_stop.t) ‑> ('accum, 'stop) Base.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 Base.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
val invariants : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> bool
val mem : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> 'a ‑> bool
val add : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> 'a ‑> ('a, 'cmp) t
val remove : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> 'a ‑> ('a, 'cmp) t
val union : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t
val inter : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t
val diff : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t
val symmetric_diff : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t ‑> ('a, 'a) Base.Either.t Base.Sequence.t
val compare_direct : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t ‑> int
val equal : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t ‑> bool
val is_subset : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> of_:('a, 'cmp) t ‑> bool
val subset : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t ‑> bool
val fold_until : ('a, _) t ‑> init:'accum ‑> f:('accum ‑> 'a ‑> ('accum, 'stop) Set_intf.Set_intf.Continue_or_stop.t) ‑> ('accum, 'stop) Set_intf.Set_intf.Finished_or_stopped_early.t
val fold_right : ('a, _) t ‑> init:'accum ‑> f:('a ‑> 'accum ‑> 'accum) ‑> 'accum
val iter2 : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t ‑> f:([ `Left of 'a | `Right of 'a | `Both of 'a * 'a ] ‑> unit) ‑> unit
val filter : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> f:('a ‑> bool) ‑> ('a, 'cmp) t
val partition_tf : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> f:('a ‑> bool) ‑> ('a, 'cmp) t * ('a, 'cmp) t
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 split : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> 'a ‑> ('a, 'cmp) t * 'a option * ('a, 'cmp) t
val group_by : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> equiv:('a ‑> 'a ‑> bool) ‑> ('a, 'cmp) t list
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 remove_index : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t ‑> int ‑> ('a, 'cmp) t
val to_sequence : comparator:('a, 'cmp) Base.Comparator.t ‑> ?order:[ `Increasing | `Decreasing ] ‑> ?greater_or_equal_to:'a ‑> ?less_or_equal_to:'a ‑> ('a, 'cmp) t ‑> 'a Base.Sequence.t
val merge_to_sequence : comparator:('a, 'cmp) Base.Comparator.t ‑> ?order:[ `Increasing | `Decreasing ] ‑> ?greater_or_equal_to:'a ‑> ?less_or_equal_to:'a ‑> ('a, 'cmp) t ‑> ('a, 'cmp) t ‑> ('a, 'a) Set_intf.Set_intf.Merge_to_sequence_element.t Base.Sequence.t
val to_map : comparator:('a, 'cmp) Comparator.t ‑> ('a, 'cmp) t ‑> f:('a ‑> 'b) ‑> ('a, 'b, 'cmp) Map.t
val obs : 'a Quickcheck.Observer.t ‑> ('a, 'cmp) t Quickcheck.Observer.t
val shrinker : comparator:('a, 'cmp) Comparator.t ‑> 'a Quickcheck.Shrinker.t ‑> ('a, 'cmp) t Quickcheck.Shrinker.t
include Set_intf.Creators2_with_comparator with type (a, b) t := (a, b) t with type (a, b) tree := (a, b) tree
include Set_intf.Set_intf.Creators2_with_comparator
val empty : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t
val singleton : comparator:('a, 'cmp) Base.Comparator.t ‑> 'a ‑> ('a, 'cmp) t
val union_list : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) t list ‑> ('a, 'cmp) t
val of_list : comparator:('a, 'cmp) Base.Comparator.t ‑> 'a list ‑> ('a, 'cmp) t
val of_array : comparator:('a, 'cmp) Base.Comparator.t ‑> 'a array ‑> ('a, 'cmp) t
val of_sorted_array : comparator:('a, 'cmp) Base.Comparator.t ‑> 'a array ‑> ('a, 'cmp) t Base.Or_error.t
val of_sorted_array_unchecked : comparator:('a, 'cmp) Base.Comparator.t ‑> 'a array ‑> ('a, 'cmp) t
val of_increasing_iterator_unchecked : comparator:('a, 'cmp) Base.Comparator.t ‑> len:int ‑> f:(int ‑> 'a) ‑> ('a, 'cmp) t
val stable_dedup_list : comparator:('a, 'cmp) Base.Comparator.t ‑> 'a list ‑> 'a list
val map : comparator:('b, 'cmp) Base.Comparator.t ‑> ('a, _) set ‑> f:('a ‑> 'b) ‑> ('b, 'cmp) t
val filter_map : comparator:('b, 'cmp) Base.Comparator.t ‑> ('a, _) set ‑> f:('a ‑> 'b option) ‑> ('b, 'cmp) t
val of_tree : comparator:('a, 'cmp) Base.Comparator.t ‑> ('a, 'cmp) tree ‑> ('a, 'cmp) t
val of_hash_set : comparator:('a, 'cmp) Comparator.t ‑> 'a Hash_set.t ‑> ('a, 'cmp) t
val of_hashtbl_keys : comparator:('a, 'cmp) Comparator.t ‑> ('a, _) Hashtbl.t ‑> ('a, 'cmp) t
val gen : comparator:('a, 'cmp) Comparator.t ‑> 'a Quickcheck.Generator.t ‑> ('a, 'cmp) t Quickcheck.Generator.t