base v0.15.1 · OCaml Package

base

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.

type nonrec ('elt, 'cmp) t = ('elt, 'cmp) t

val sexp_of_t : 
  ('elt -> Sexplib0.Sexp.t) ->
  ('cmp -> Sexplib0.Sexp.t) ->
  ('elt, 'cmp) t ->
  Sexplib0.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 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 : (_, _) t -> bool

val mem : ('a, _) t -> 'a -> bool

val add : ('a, 'cmp) t -> 'a -> ('a, 'cmp) t

val remove : ('a, 'cmp) t -> 'a -> ('a, 'cmp) t

val union : ('a, 'cmp) t -> ('a, 'cmp) t -> ('a, 'cmp) t

val inter : ('a, 'cmp) t -> ('a, 'cmp) t -> ('a, 'cmp) t

val diff : ('a, 'cmp) t -> ('a, 'cmp) t -> ('a, 'cmp) t

val symmetric_diff : 
  ('a, 'cmp) t ->
  ('a, 'cmp) t ->
  ('a, 'a) Either.t Sequence.t

val compare_direct : ('a, 'cmp) t -> ('a, 'cmp) t -> int

val equal : ('a, 'cmp) t -> ('a, 'cmp) t -> bool

val is_subset : ('a, 'cmp) t -> of_:('a, 'cmp) t -> bool

val are_disjoint : ('a, 'cmp) t -> ('a, 'cmp) t -> bool

module Named : sig ... end

val fold_until : 
  ('a, _) t ->
  init:'b ->
  f:('b -> 'a -> ('b, 'final) Container.Continue_or_stop.t) ->
  finish:('b -> 'final) ->
  'final

val fold_right : ('a, _) t -> init:'b -> f:('a -> 'b -> 'b) -> 'b

val iter2 : 
  ('a, 'cmp) t ->
  ('a, 'cmp) t ->
  f:([ `Left of 'a | `Right of 'a | `Both of 'a * 'a ] -> unit) ->
  unit

val filter : ('a, 'cmp) t -> f:('a -> bool) -> ('a, 'cmp) t

val partition_tf : 
  ('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 : ('a, 'cmp) t -> 'a -> ('a, 'cmp) t * 'a option * ('a, 'cmp) t

val group_by : ('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 : ('a, 'cmp) t -> int -> ('a, 'cmp) t

val to_tree : ('a, 'cmp) t -> ('a, 'cmp) Tree.t

val to_sequence : 
  ?order:[ `Increasing | `Decreasing ] ->
  ?greater_or_equal_to:'a ->
  ?less_or_equal_to:'a ->
  ('a, 'cmp) t ->
  'a Sequence.t

val binary_search : 
  ('a, 'cmp) t ->
  compare:('a -> 'key -> int) ->
  Binary_searchable.Which_target_by_key.t ->
  'key ->
  'a option

val binary_search_segmented : 
  ('a, 'cmp) t ->
  segment_of:('a -> [ `Left | `Right ]) ->
  Binary_searchable.Which_target_by_segment.t ->
  'a option

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) 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) Tree.t ->
  ('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 (Elt : Comparator.S1) : sig ... end

package base