package base

  1. Overview
  2. Docs
package base
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Set.Using_comparatorSource

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.

Sourcetype nonrec ('elt, 'cmp) t = ('elt, 'cmp) t
Sourceval sexp_of_t : ('elt -> Sexp.t) -> ('cmp -> Sexp.t) -> ('elt, 'cmp) t -> Sexp.t
Sourceval t_of_sexp_direct : comparator:('elt, 'cmp) Comparator.t -> (Sexp.t -> 'elt) -> Sexp.t -> ('elt, 'cmp) t
Sourcemodule Tree : sig ... end
include Container.S1_phantom_invariant with type ('a, 'b) t := ('a, 'b) t
Sourceval length : (_, _) t -> int
Sourceval is_empty : (_, _) t -> bool
Sourceval iter : ('a, _) t -> f:('a -> unit) -> unit
Sourceval 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.

Sourceval 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.

Sourceval 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.

Sourceval 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.

Sourceval count : ('a, _) t -> f:('a -> bool) -> int

Returns the number of elements for which the provided function evaluates to true.

Sourceval 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.

Sourceval find : ('a, _) t -> f:('a -> bool) -> 'a option

Returns as an option the first element for which f evaluates to true.

Sourceval 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.

Sourceval to_list : ('a, _) t -> 'a list
Sourceval to_array : ('a, _) t -> 'a array
Sourceval invariants : (_, _) t -> bool
Sourceval mem : ('a, _) t -> 'a -> bool
Sourceval add : ('a, 'cmp) t -> 'a -> ('a, 'cmp) t
Sourceval remove : ('a, 'cmp) t -> 'a -> ('a, 'cmp) t
Sourceval union : ('a, 'cmp) t -> ('a, 'cmp) t -> ('a, 'cmp) t
Sourceval inter : ('a, 'cmp) t -> ('a, 'cmp) t -> ('a, 'cmp) t
Sourceval diff : ('a, 'cmp) t -> ('a, 'cmp) t -> ('a, 'cmp) t
Sourceval symmetric_diff : ('a, 'cmp) t -> ('a, 'cmp) t -> ('a, 'a) Either.t Sequence.t
Sourceval compare_direct : ('a, 'cmp) t -> ('a, 'cmp) t -> int
Sourceval equal : ('a, 'cmp) t -> ('a, 'cmp) t -> bool
Sourceval is_subset : ('a, 'cmp) t -> of_:('a, 'cmp) t -> bool
Sourceval are_disjoint : ('a, 'cmp) t -> ('a, 'cmp) t -> bool
Sourcemodule Named : sig ... end
Sourceval fold_until : ('a, _) t -> init:'b -> f:('b -> 'a -> ('b, 'final) Base__.Container_intf.Export.Continue_or_stop.t) -> finish:('b -> 'final) -> 'final
Sourceval fold_right : ('a, _) t -> init:'b -> f:('a -> 'b -> 'b) -> 'b
Sourceval iter2 : ('a, 'cmp) t -> ('a, 'cmp) t -> f:([ `Left of 'a | `Right of 'a | `Both of 'a * 'a ] -> unit) -> unit
Sourceval filter : ('a, 'cmp) t -> f:('a -> bool) -> ('a, 'cmp) t
Sourceval partition_tf : ('a, 'cmp) t -> f:('a -> bool) -> ('a, 'cmp) t * ('a, 'cmp) t
Sourceval elements : ('a, _) t -> 'a list
Sourceval min_elt : ('a, _) t -> 'a option
Sourceval min_elt_exn : ('a, _) t -> 'a
Sourceval max_elt : ('a, _) t -> 'a option
Sourceval max_elt_exn : ('a, _) t -> 'a
Sourceval choose : ('a, _) t -> 'a option
Sourceval choose_exn : ('a, _) t -> 'a
Sourceval split : ('a, 'cmp) t -> 'a -> ('a, 'cmp) t * 'a option * ('a, 'cmp) t
Sourceval group_by : ('a, 'cmp) t -> equiv:('a -> 'a -> bool) -> ('a, 'cmp) t list
Sourceval find_exn : ('a, _) t -> f:('a -> bool) -> 'a
Sourceval nth : ('a, _) t -> int -> 'a option
Sourceval remove_index : ('a, 'cmp) t -> int -> ('a, 'cmp) t
Sourceval to_tree : ('a, 'cmp) t -> ('a, 'cmp) Tree.t
Sourceval to_sequence : ?order:[ `Increasing | `Decreasing ] -> ?greater_or_equal_to:'a -> ?less_or_equal_to:'a -> ('a, 'cmp) t -> 'a Sequence.t
Sourceval binary_search_segmented : ('a, 'cmp) t -> segment_of:('a -> [ `Left | `Right ]) -> [ `Last_on_left | `First_on_right ] -> 'a option
Sourceval 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
Sourceval empty : comparator:('a, 'cmp) Comparator.t -> ('a, 'cmp) t
Sourceval singleton : comparator:('a, 'cmp) Comparator.t -> 'a -> ('a, 'cmp) t
Sourceval union_list : comparator:('a, 'cmp) Comparator.t -> ('a, 'cmp) t list -> ('a, 'cmp) t
Sourceval of_list : comparator:('a, 'cmp) Comparator.t -> 'a list -> ('a, 'cmp) t
Sourceval of_array : comparator:('a, 'cmp) Comparator.t -> 'a array -> ('a, 'cmp) t
Sourceval of_sorted_array : comparator:('a, 'cmp) Comparator.t -> 'a array -> ('a, 'cmp) t Or_error.t
Sourceval of_sorted_array_unchecked : comparator:('a, 'cmp) Comparator.t -> 'a array -> ('a, 'cmp) t
Sourceval of_increasing_iterator_unchecked : comparator:('a, 'cmp) Comparator.t -> len:int -> f:(int -> 'a) -> ('a, 'cmp) t
Sourceval stable_dedup_list : comparator:('a, 'cmp) Comparator.t -> 'a list -> 'a list
Sourceval map : comparator:('b, 'cmp) Comparator.t -> ('a, _) t -> f:('a -> 'b) -> ('b, 'cmp) t
Sourceval filter_map : comparator:('b, 'cmp) Comparator.t -> ('a, _) t -> f:('a -> 'b option) -> ('b, 'cmp) t
Sourceval of_tree : comparator:('a, 'cmp) Comparator.t -> ('a, 'cmp) Tree.t -> ('a, 'cmp) t
Sourceval comparator : ('a, 'cmp) t -> ('a, 'cmp) Comparator.t
Sourceval hash_fold_direct : 'elt Hash.folder -> ('elt, 'cmp) t Hash.folder
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct