package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type

This module defines the Set module for Core. Functions that construct a set take as an argument the comparator for the element type.

This module uses the same organizational approach as Map.

type ('elt, 'cmp) t = ('elt, 'cmp) Base.Set.t

The type of a set. The first type parameter identifies the type of the element, and the second identifies the comparator, which determines the comparison function that is used for ordering elements in this set. Many operations (e.g., union), require that they be passed sets with the same element type and the same comparator type.

include Ppx_compare_lib.Comparable.S2 with type ('elt, 'cmp) t := ('elt, 'cmp) t
val compare : 'a Base__Ppx_compare_lib.compare -> 'b Base__Ppx_compare_lib.compare -> ('a, 'b) t Base__Ppx_compare_lib.compare
type ('k, 'cmp) comparator = ('k, 'cmp) Comparator.Module.t
  • deprecated [since 2022-07] use [Comparator.Module.t] instead
module Tree : sig ... end
module Using_comparator : sig ... end
val invariants : (_, _) t -> Base.Bool.t

Tests internal invariants of the set data structure. Returns true on success.

val comparator_s : ('a, 'cmp) t -> ('a, 'cmp) Comparator.Module.t

Returns a first-class module that can be used to build other map/set/etc with the same notion of comparison.

val comparator : ('a, 'cmp) t -> ('a, 'cmp) Comparator.t
val empty : ('a, 'cmp) Comparator.Module.t -> ('a, 'cmp) t

Creates an empty set based on the provided comparator.

val singleton : ('a, 'cmp) Comparator.Module.t -> 'a -> ('a, 'cmp) t

Creates a set based on the provided comparator that contains only the provided element.

val length : (_, _) t -> Base.Int.t

Returns the cardinality of the set. O(1).

val is_empty : (_, _) t -> Base.Bool.t

is_empty t is true iff t is empty. O(1).

val mem : ('a, _) t -> 'a -> Base.Bool.t

mem t a returns true iff a is in t. O(log n).

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

add t a returns a new set with a added to t, or returns t if mem t a. O(log n).

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

remove t a returns a new set with a removed from t if mem t a, or returns t otherwise. O(log n).

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

union t1 t2 returns the union of the two sets. O(length t1 + length t2).

val union_list : ('a, 'cmp) Comparator.Module.t -> ('a, 'cmp) t Base.List.t -> ('a, 'cmp) t

union c list returns the union of all the sets in list. The c argument is required for the case where list is empty. O(max(List.length list, n log n)), where n is the sum of sizes of the input sets.

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

inter t1 t2 computes the intersection of sets t1 and t2. O(length t1 + length t2).

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

diff t1 t2 computes the set difference t1 - t2, i.e., the set containing all elements in t1 that are not in t2. O(length t1 + length t2).

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

symmetric_diff t1 t2 returns a sequence of changes between t1 and t2. It is intended to be efficient in the case where t1 and t2 share a large amount of structure. In the case where t2 (resp. t1) is obtained by applying k additions and/or removals to t1 (resp. t2), this runs in min(O(k log n), O(n)), where n is length t1 + length t2.

val compare_direct : ('a, 'cmp) t -> ('a, 'cmp) t -> Base.Int.t

compare_direct t1 t2 compares the sets t1 and t2. It returns the same result as compare, but unlike compare, doesn't require arguments to be passed in for the type parameters of the set. O(length t1 + length t2).

val hash_fold_direct : 'a Core__.Import.Hash.folder -> ('a, 'cmp) t Core__.Import.Hash.folder

Hash function: a building block to use when hashing data structures containing sets in them. hash_fold_direct hash_fold_key is compatible with compare_direct iff hash_fold_key is compatible with (comparator s).compare of the set s being hashed.

val equal : ('a, 'cmp) t -> ('a, 'cmp) t -> Base.Bool.t

equal t1 t2 returns true iff the two sets have the same elements. O(length t1 + length t2)

val exists : ('a, _) t -> f:('a -> Base.Bool.t) -> Base.Bool.t

exists t ~f returns true iff there exists an a in t for which f a. O(n), but returns as soon as it finds an a for which f a.

val for_all : ('a, _) t -> f:('a -> Base.Bool.t) -> Base.Bool.t

for_all t ~f returns true iff for all a in t, f a. O(n), but returns as soon as it finds an a for which not (f a).

val count : ('a, _) t -> f:('a -> Base.Bool.t) -> Base.Int.t

count t returns the number of elements of t for which f returns true. O(n).

val sum : (module Core__.Set_intf.Container.Summable with type t = 'sum) -> ('a, _) t -> f:('a -> 'sum) -> 'sum

sum t returns the sum of f t for each t in the set. O(n).

val find : ('a, _) t -> f:('a -> Base.Bool.t) -> 'a Base.Option.t

find t f returns an element of t for which f returns true, with no guarantee as to which element is returned. O(n), but returns as soon as a suitable element is found.

val find_map : ('a, _) t -> f:('a -> 'b Base.Option.t) -> 'b Base.Option.t

find_map t f returns b for some a in t for which f a = Some b. If no such a exists, then find returns None. O(n), but returns as soon as a suitable element is found.

val find_exn : ('a, _) t -> f:('a -> Base.Bool.t) -> 'a

Like find, but throws an exception on failure.

val nth : ('a, _) t -> Base.Int.t -> 'a Base.Option.t

nth t i returns the ith smallest element of t, in O(log n) time. The smallest element has i = 0. Returns None if i < 0 or i >= length t.

val remove_index : ('a, 'cmp) t -> Base.Int.t -> ('a, 'cmp) t

remove_index t i returns a version of t with the ith smallest element removed, in O(log n) time. The smallest element has i = 0. Returns t if i < 0 or i >= length t.

val is_subset : ('a, 'cmp) t -> of_:('a, 'cmp) t -> Base.Bool.t

is_subset t1 ~of_:t2 returns true iff t1 is a subset of t2.

val are_disjoint : ('a, 'cmp) t -> ('a, 'cmp) t -> Base.Bool.t

are_disjoint t1 t2 returns true iff is_empty (inter t1 t2), but is more efficient.

module Named : sig ... end

Named allows the validation of subset and equality relationships between sets. A Named.t is a record of a set and a name, where the name is used in error messages, and Named.is_subset and Named.equal validate subset and equality relationships respectively.

val of_list : ('a, 'cmp) Comparator.Module.t -> 'a Base.List.t -> ('a, 'cmp) t

The list or array given to of_list and of_array need not be sorted.

val of_sequence : ('a, 'cmp) Comparator.Module.t -> 'a Sequence.t -> ('a, 'cmp) t
val of_array : ('a, 'cmp) Comparator.Module.t -> 'a Base.Array.t -> ('a, 'cmp) t
val of_hash_set : ('a, 'cmp) Comparator.Module.t -> 'a Hash_set.t -> ('a, 'cmp) t
val of_hashtbl_keys : ('a, 'cmp) Comparator.Module.t -> ('a, _) Hashtbl.t -> ('a, 'cmp) t
val to_list : ('a, _) t -> 'a Base.List.t

to_list and to_array produce sequences sorted in ascending order according to the comparator.

val to_array : ('a, _) t -> 'a Base.Array.t
val to_tree : ('a, 'cmp) t -> ('a, 'cmp) Tree.t
val of_tree : ('a, 'cmp) Comparator.Module.t -> ('a, 'cmp) Tree.t -> ('a, 'cmp) t
val of_sorted_array : ('a, 'cmp) Comparator.Module.t -> 'a Base.Array.t -> ('a, 'cmp) t Or_error.t

Create set from sorted array. The input must be sorted (either in ascending or descending order as given by the comparator) and contain no duplicates, otherwise the result is an error. The complexity of this function is O(n).

val of_sorted_array_unchecked : ('a, 'cmp) Comparator.Module.t -> 'a Base.Array.t -> ('a, 'cmp) t

Similar to of_sorted_array, but without checking the input array.

val of_increasing_iterator_unchecked : ('a, 'cmp) Comparator.Module.t -> len:Base.Int.t -> f:(Base.Int.t -> 'a) -> ('a, 'cmp) t

of_increasing_iterator_unchecked c ~len ~f behaves like of_sorted_array_unchecked c (Array.init len ~f), with the additional restriction that a decreasing order is not supported. The advantage is not requiring you to allocate an intermediate array. f will be called with 0, 1, ... len - 1, in order.

val stable_dedup_list : ('a, _) Comparator.Module.t -> 'a Base.List.t -> 'a Base.List.t

stable_dedup_list is here rather than in the List module because the implementation relies crucially on sets, and because doing so allows one to avoid uses of polymorphic comparison by instantiating the functor at a different implementation of Comparator and using the resulting stable_dedup_list.

val map : ('b, 'cmp) Comparator.Module.t -> ('a, _) t -> f:('a -> 'b) -> ('b, 'cmp) t

map c t ~f returns a new set created by applying f to every element in t. The returned set is based on the provided c. O(n log n).

val filter_map : ('b, 'cmp) Comparator.Module.t -> ('a, _) t -> f:('a -> 'b Base.Option.t) -> ('b, 'cmp) t

Like map, except elements for which f returns None will be dropped.

val filter : ('a, 'cmp) t -> f:('a -> Base.Bool.t) -> ('a, 'cmp) t

filter t ~f returns the subset of t for which f evaluates to true. O(n log n).

val fold : ('a, _) t -> init:'accum -> f:('accum -> 'a -> 'accum) -> 'accum

fold t ~init ~f folds over the elements of the set from smallest to largest.

val fold_result : ('a, _) t -> init:'accum -> f:('accum -> 'a -> ('accum, 'e) Result.t) -> ('accum, 'e) Result.t

fold_result ~init ~f folds over the elements of the set from smallest to largest, short circuiting the fold if f accum x is an Error _

val fold_until : ('a, _) t -> init:'accum -> f:('accum -> 'a -> ('accum, 'final) Core__.Set_intf.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final

fold_until t ~init ~f is a short-circuiting version of fold. If f returns Stop _ the computation ceases and results in that value. If f returns Continue _, the fold will proceed.

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

Like fold, except that it goes from the largest to the smallest element.

val iter : ('a, _) t -> f:('a -> Base.Unit.t) -> Base.Unit.t

iter t ~f calls f on every element of t, going in order from the smallest to largest.

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

Iterate two sets side by side. Complexity is O(m+n) where m and n are the sizes of the two input sets. As an example, with the inputs 0; 1 and 1; 2, f will be called with `Left 0; `Both (1, 1); and `Right 2.

val partition_tf : ('a, 'cmp) t -> f:('a -> Base.Bool.t) -> ('a, 'cmp) t * ('a, 'cmp) t

If a, b = partition_tf set ~f then a is the elements on which f produced true, and b is the elements on which f produces false.

val elements : ('a, _) t -> 'a Base.List.t

Same as to_list.

val min_elt : ('a, _) t -> 'a Base.Option.t

Returns the smallest element of the set. O(log n).

val min_elt_exn : ('a, _) t -> 'a

Like min_elt, but throws an exception when given an empty set.

val max_elt : ('a, _) t -> 'a Base.Option.t

Returns the largest element of the set. O(log n).

val max_elt_exn : ('a, _) t -> 'a

Like max_elt, but throws an exception when given an empty set.

val choose : ('a, _) t -> 'a Base.Option.t

returns an arbitrary element, or None if the set is empty.

val choose_exn : ('a, _) t -> 'a

Like choose, but throws an exception on an empty set.

val split : ('a, 'cmp) t -> 'a -> ('a, 'cmp) t * 'a Base.Option.t * ('a, 'cmp) t

split t x produces a triple (t1, maybe_x, t2).

t1 is the set of elements strictly less than x, maybe_x is the member (if any) of t which compares equal to x, t2 is the set of elements strictly larger than x.

val split_le_gt : ('a, 'cmp) t -> 'a -> ('a, 'cmp) t * ('a, 'cmp) t

split_le_gt t x produces a pair (t1, t2).

t1 is the set of elements less than or equal to x, t2 is the set of elements strictly larger than x.

val split_lt_ge : ('a, 'cmp) t -> 'a -> ('a, 'cmp) t * ('a, 'cmp) t

split_lt_ge t x produces a pair (t1, t2).

t1 is the set of elements strictly less than x, t2 is the set of elements larger or equal to x.

val group_by : ('a, 'cmp) t -> equiv:('a -> 'a -> Base.Bool.t) -> ('a, 'cmp) t Base.List.t

If equiv is an equivalence predicate, then group_by set ~equiv produces a list of equivalence classes (i.e., a set-theoretic quotient). E.g.,

let chars = Set.of_list ['A'; 'a'; 'b'; 'c'] in
let equiv c c' = Char.equal (Char.uppercase c) (Char.uppercase c') in
group_by chars ~equiv

produces:

[Set.of_list ['A';'a']; Set.singleton 'b'; Set.singleton 'c']

group_by runs in O(n^2) time, so if you have a comparison function, it's usually much faster to use Set.of_list.

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

to_sequence t converts the set t to a sequence of the elements between greater_or_equal_to and less_or_equal_to inclusive in the order indicated by order. If greater_or_equal_to > less_or_equal_to the sequence is empty. Cost is O(log n) up front and amortized O(1) for each element produced.

binary_search t ~compare which elt returns the element in t specified by compare and which, if one exists.

t must be sorted in increasing order according to compare, where compare and elt divide t into three (possibly empty) segments:

      |  < elt  |  = elt  |  > elt  |

binary_search returns an element on the boundary of segments as specified by which. See the diagram below next to the which variants.

binary_search does not check that compare orders t, and behavior is unspecified if compare doesn't order t. Behavior is also unspecified if compare mutates t.

val binary_search_segmented : ('a, 'cmp) t -> segment_of:('a -> [ `Left | `Right ]) -> [ `Last_on_left | `First_on_right ] -> 'a Base.Option.t

binary_search_segmented t ~segment_of which takes a segment_of function that divides t into two (possibly empty) segments:

      | segment_of elt = `Left | segment_of elt = `Right |

binary_search_segmented returns the element on the boundary of the segments as specified by which: `Last_on_left yields the last element of the left segment, while `First_on_right yields the first element of the right segment. It returns None if the segment is empty.

binary_search_segmented does not check that segment_of segments t as in the diagram, and behavior is unspecified if segment_of doesn't segment t. Behavior is also unspecified if segment_of mutates t.

module Merge_to_sequence_element : sig ... end

Produces the elements of the two sets between greater_or_equal_to and less_or_equal_to in order, noting whether each element appears in the left set, the right set, or both. In the both case, both elements are returned, in case the caller can distinguish between elements that are equal to the sets' comparator. Runs in O(length t + length t').

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) Merge_to_sequence_element.t Sequence.t
val to_map : ('key, 'cmp) t -> f:('key -> 'data) -> ('key, 'data, 'cmp) Base.Map.t

Convert a set to or from a map. to_map takes a function to produce data for each key. Both functions run in O(n) time (assuming the function passed to to_map runs in constant time).

val of_map_keys : ('key, _, 'cmp) Base.Map.t -> ('key, 'cmp) t
val quickcheck_generator : ('key, 'cmp) Comparator.Module.t -> 'key Quickcheck.Generator.t -> ('key, 'cmp) t Quickcheck.Generator.t
val quickcheck_observer : 'key Quickcheck.Observer.t -> ('key, 'cmp) t Quickcheck.Observer.t
val quickcheck_shrinker : 'key Quickcheck.Shrinker.t -> ('key, 'cmp) t Quickcheck.Shrinker.t

Polymorphic sets

Module Poly deals with sets that use OCaml's polymorphic comparison to compare elements.

module Poly : sig ... end

Signatures and functors for building Set modules

module type Elt_plain = Set_intf.Elt_plain
module type Elt = Set_intf.Elt

The signature that something needs to match in order to be used as a set element.

module type Elt_binable = Set_intf.Elt_binable

The signature that something needs to match in order to be used as a set element if the resulting set is going to support bin_io.

module type S_plain = Set_intf.S_plain

Module signature for a Set that doesn't support of_sexp.

module type S = Set_intf.S

Module signature for a Set.

module type S_binable = Set_intf.S_binable

Module signature for a Set that supports bin_io.

module Make_plain (Elt : Elt_plain) : S_plain with type Elt.t = Elt.t

Make builds a set from an element type that has a compare function but doesn't have a comparator. This generates a new comparator.

module Make (Elt : Elt) : S with type Elt.t = Elt.t
module Make_binable (Elt : Elt_binable) : S_binable with type Elt.t = Elt.t
module Make_using_comparator (Elt : sig ... end) : S with type Elt.t = Elt.t with type Elt.comparator_witness = Elt.comparator_witness

Make_using_comparator builds a set from an element type that has a comparator.

module Elt_bin_io = Set_intf.Elt_bin_io
include Set_intf.For_deriving with type ('a, 'b) t := ('a, 'b) t
include Base.Set.For_deriving with type ('a, 'b) t := ('a, 'b) t
module type Sexp_of_m = sig ... end
module type M_of_sexp = sig ... end
module type M_sexp_grammar = sig ... end
module type Compare_m = sig ... end
module type Equal_m = sig ... end
module type Hash_fold_m = sig ... end
val sexp_of_m__t : (module Sexp_of_m with type t = 'elt) -> ('elt, 'cmp) t -> Base__.Sexp.t
val m__t_of_sexp : (module M_of_sexp with type comparator_witness = 'cmp and type t = 'elt) -> Base__.Sexp.t -> ('elt, 'cmp) t
val m__t_sexp_grammar : (module M_sexp_grammar with type t = 'elt) -> ('elt, 'cmp) t Sexplib0.Sexp_grammar.t
val compare_m__t : (module Compare_m) -> ('elt, 'cmp) t -> ('elt, 'cmp) t -> int
val equal_m__t : (module Equal_m) -> ('elt, 'cmp) t -> ('elt, 'cmp) t -> bool
val hash_fold_m__t : (module Hash_fold_m with type t = 'elt) -> Base__.Hash.state -> ('elt, 'a) t -> Base__.Hash.state
val hash_m__t : (module Hash_fold_m with type t = 'elt) -> ('elt, 'a) t -> int
module M = Base.Set.M

The following *bin* functions support bin-io on base-style sets, e.g.:

type t = Set.M(String).t [@@deriving bin_io]
val bin_shape_m__t : ('a, 'b) Set_intf.Elt_bin_io.t -> Bin_prot.Shape.t
val bin_size_m__t : ('a, 'b) Set_intf.Elt_bin_io.t -> ('a, 'b) t Bin_prot.Size.sizer
val bin_write_m__t : ('a, 'b) Set_intf.Elt_bin_io.t -> ('a, 'b) t Bin_prot.Write.writer
val bin_read_m__t : ('a, 'b) Set_intf.Elt_bin_io.t -> ('a, 'b) t Bin_prot.Read.reader
val __bin_read_m__t__ : ('a, 'b) Set_intf.Elt_bin_io.t -> (Base.Int.t -> ('a, 'b) t) Bin_prot.Read.reader

The following quickcheck* functions support deriving quickcheck on base-style sets, e.g.:

type t = Set.M(String).t [@@deriving quickcheck]
module type Quickcheck_generator_m = sig ... end
module type Quickcheck_observer_m = sig ... end
module type Quickcheck_shrinker_m = sig ... end
val quickcheck_generator_m__t : (module Quickcheck_generator_m with type comparator_witness = 'cmp and type t = 'a) -> ('a, 'cmp) t Quickcheck.Generator.t
val quickcheck_observer_m__t : (module Quickcheck_observer_m with type comparator_witness = 'cmp and type t = 'a) -> ('a, 'cmp) t Quickcheck.Observer.t
val quickcheck_shrinker_m__t : (module Quickcheck_shrinker_m with type comparator_witness = 'cmp and type t = 'a) -> ('a, 'cmp) t Quickcheck.Shrinker.t
module Make_tree (Elt : sig ... end) : sig ... end
module Stable : sig ... end

The following types and functors may be used to define stable modules.

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