OCaml logo

base

Full standard library replacement for OCaml
IN THIS PACKAGE
Module Base . Set . Using_comparator . Tree
type ('a, 'cmp) t

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.

val sexp_of_t : ( 'a -> Sexplib0.Sexp.t ) -> ( 'cmp -> Sexplib0.Sexp.t ) -> ( 'a, 'cmp ) t -> Sexplib0.Sexp.t
val t_of_sexp_direct : comparator:( 'elt, 'cmp ) Comparator.t -> ( Sexp.t -> 'elt ) -> Sexp.t -> ( 'elt, 'cmp ) t
module Named : sig ... end
include Container.S1_phantom_invariant with type ('a, 'b) t := ( 'a, 'b ) t
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 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 Container.Summable 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 invariants : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> bool
val mem : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> 'a -> bool
val add : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> 'a -> ( 'a, 'cmp ) t
val remove : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> 'a -> ( 'a, 'cmp ) t
val union : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t
val inter : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t
val diff : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t
val symmetric_diff : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t -> ( 'a, 'a ) Either.t Sequence.t
val compare_direct : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t -> int
val equal : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t -> bool
val is_subset : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> of_:( 'a, 'cmp ) t -> bool
val are_disjoint : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t -> bool
val fold_until : ( 'a, _ ) t -> init:'accum -> f:( 'accum -> 'a -> ( 'accum, 'final ) Container.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 ) 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 ) Comparator.t -> ( 'a, 'cmp ) t -> f:( 'a -> bool ) -> ( 'a, 'cmp ) t
val partition_tf : comparator:( 'a, 'cmp ) 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 ) Comparator.t -> ( 'a, 'cmp ) t -> 'a -> ( 'a, 'cmp ) t * 'a option * ( 'a, 'cmp ) t
val group_by : comparator:( 'a, 'cmp ) 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 ) Comparator.t -> ( 'a, 'cmp ) t -> int -> ( 'a, 'cmp ) t
val to_tree : ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t
val to_sequence : comparator:( 'a, 'cmp ) Comparator.t -> ?order:[ `Increasing | `Decreasing ] -> ?greater_or_equal_to:'a -> ?less_or_equal_to:'a -> ( 'a, 'cmp ) t -> 'a Sequence.t
val binary_search_segmented : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> segment_of:( 'a -> [ `Left | `Right ] ) -> Binary_searchable.Which_target_by_segment.t -> 'a option
val merge_to_sequence : comparator:( 'a, 'cmp ) Comparator.t -> ?order:[ `Increasing | `Decreasing ] -> ?greater_or_equal_to:'a -> ?less_or_equal_to:'a -> ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t -> ( 'a, 'a ) Sequence.Merge_with_duplicates_element.t Sequence.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_sequence : comparator:( 'a, 'cmp ) Comparator.t -> 'a Sequence.t -> ( '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, _ ) t -> f:( 'a -> 'b ) -> ( 'b, 'cmp ) t
val filter_map : comparator:( 'b, 'cmp ) Comparator.t -> ( 'a, _ ) t -> f:( 'a -> 'b option ) -> ( 'b, 'cmp ) t
val of_tree : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'cmp ) t -> ( 'a, 'cmp ) t
val empty_without_value_restriction : ( _, _ ) t