Module type 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
returnsf (... f (f (f init e1) e2) e3 ...) en
, wheree1..en
are the elements oft
.
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 offold
that runs in theResult
monad. Iff
returns anError _
, that value is returned without any additional invocations off
.
val fold_until : ('a, _) t -> init:'accum -> f:('accum -> 'a -> ('accum, 'final) Base__.Container_intf.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final
fold_until t ~init ~f ~finish
is a short-circuiting version offold
. Iff
returnsStop _
the computation ceases and results in that value. Iff
returnsContinue _
, the fold will proceed. Iff
never returnsStop _
, the final result is computed byfinish
.Example:
type maybe_negative = | Found_negative of int | All_nonnegative of { sum : int } (** [first_neg_or_sum list] returns the first negative number in [list], if any, otherwise returns the sum of the list. *) let first_neg_or_sum = List.fold_until ~init:0 ~f:(fun sum x -> if x < 0 then Stop (Found_negative x) else Continue (sum + x)) ~finish:(fun sum -> All_nonnegative { sum }) ;; let x = first_neg_or_sum [1; 2; 3; 4; 5] val x : maybe_negative = All_nonnegative {sum = 15} let y = first_neg_or_sum [1; 2; -3; 4; 5] val y : maybe_negative = Found_negative -3
val exists : ('a, _) t -> f:('a -> bool) -> bool
Returns
true
if and only if there exists an element for which the provided function evaluates totrue
. 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 totrue
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__.Container_intf.Summable with type t = 'sum) -> ('a, _) t -> f:('a -> 'sum) -> 'sum
Returns the sum of
f i
for alli
in the container.
val find : ('a, _) t -> f:('a -> bool) -> 'a option
Returns as an
option
the first element for whichf
evaluates to true.
val find_map : ('a, _) t -> f:('a -> 'b option) -> 'b option
Returns the first evaluation of
f
that returnsSome
, and returnsNone
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 -> compare:('a -> 'a -> int) -> 'a option
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 usesfold
so it has the same complexity asfold
. ReturnsNone
iff the collection is empty.
val max_elt : ('a, _) t -> compare:('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
module Named : sig ... end
val fold_until : ('a, _) t -> init:'accum -> f:('accum -> 'a -> ('accum, 'final) Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final
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 nth : ('a, _) t -> int -> 'a option
val remove_index : comparator:('a, 'cmp) Base.Comparator.t -> ('a, 'cmp) t -> int -> ('a, 'cmp) t
val to_tree : ('a, 'cmp) t -> ('a, 'cmp) tree
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 binary_search : comparator:('a, 'cmp) Base.Comparator.t -> ('a, 'cmp) t -> compare:('a -> 'key -> int) -> [ `Last_strictly_less_than | `Last_less_than_or_equal_to | `Last_equal_to | `First_equal_to | `First_greater_than_or_equal_to | `First_strictly_greater_than ] -> 'key -> 'a option
val binary_search_segmented : comparator:('a, 'cmp) Base.Comparator.t -> ('a, 'cmp) t -> segment_of:('a -> [ `Left | `Right ]) -> [ `Last_on_left | `First_on_right ] -> 'a option
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) Merge_to_sequence_element.t Base.Sequence.t