base v0.13.1 · OCaml Package

A polymorphic Set.

include Container.S1
  with type 'elt t = ('elt, Comparator.Poly.comparator_witness) t

type 'elt t = ('elt, Comparator.Poly.comparator_witness) t

val length : 'a t -> int

val is_empty : 'a 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 Base__.Container_intf.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

type 'a tree

type comparator_witness

val invariants : _ t -> bool

val mem : 'a t -> 'a -> bool

val add : 'a t -> 'a -> 'a t

val remove : 'a t -> 'a -> 'a t

val union : 'a t -> 'a t -> 'a t

val inter : 'a t -> 'a t -> 'a t

val diff : 'a t -> 'a t -> 'a t

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

val compare_direct : 'a t -> 'a t -> int

val equal : 'a t -> 'a t -> bool

val is_subset : 'a t -> of_:'a t -> bool

type 'a named

module Named : sig ... end

val fold_until : 
  'a t ->
  init:'b ->
  f:('b -> 'a -> ('b, 'final) Base__.Container_intf.Export.Continue_or_stop.t) ->
  finish:('b -> 'final) ->
  'final

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

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

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

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

val group_by : 'a t -> equiv:('a -> 'a -> bool) -> 'a t list

val find_exn : 'a t -> f:('a -> bool) -> 'a

val nth : 'a t -> int -> 'a option

val remove_index : 'a t -> int -> 'a t

val to_tree : 'a t -> 'a tree

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

val binary_search : 
  'a 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 : 
  'a t ->
  segment_of:('a -> [ `Left | `Right ]) ->
  [ `Last_on_left | `First_on_right ] ->
  'a option

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

type ('a, 'cmp) set

val empty : 'a t

val singleton : 'a -> 'a t

val union_list : 'a t list -> 'a t

val of_list : 'a list -> 'a t

val of_array : 'a array -> 'a t

val of_sorted_array : 'a array -> 'a t Or_error.t

val of_sorted_array_unchecked : 'a array -> 'a t

val of_increasing_iterator_unchecked : len:int -> f:(int -> 'a) -> 'a t

val stable_dedup_list : 'a list -> 'a list

val map : ('a, _) set -> f:('a -> 'b) -> 'b t

val filter_map : ('a, _) set -> f:('a -> 'b option) -> 'b t

val of_tree : 'a tree -> 'a t

package base