Module type Set.S

type elt
type compare_elt
type t
include Ppx_compare_lib.Comparable.S with type t := t
val compare : t Base__Ppx_compare_lib.compare
include Ppx_compare_lib.Equal.S with type t := t
val equal : t Base__Ppx_compare_lib.equal
val sexp_of_t : t -> Sexplib0.Sexp.t
type ('a, 'compare_a) comparer := 'a -> 'a -> int
type compare

compare types are equipped with functions to support use of @@deriving compare, equal, sexp on types parameterized by such singleton types for compare functions. These derived functions are never actually called, since the compare type parameters are phantom.

val compare_compare : compare -> compare -> int
val equal_compare : compare -> compare -> bool
val sexp_of_compare : compare -> Sexplib0.Sexp.t
val compare_of_sexp : Sexplib0.Sexp.t -> compare
val comparer : (t, compare) comparer
module Provide_of_sexp (_ : sig ... end) : sig ... end

Pretty-print

val pp_full : ?pre:(unit, Stdlib.Format.formatter, unit, unit) Stdlib.format4 -> ?suf:(unit, Stdlib.Format.formatter, unit, unit) Stdlib.format4 -> ?sep:(unit, Stdlib.Format.formatter, unit, unit) Stdlib.format4 -> (Stdlib.Format.formatter -> elt -> unit) -> Stdlib.Format.formatter -> t -> unit
module Provide_pp (_ : sig ... end) : sig ... end

Construct

val empty : t
val of_ : elt -> t
val of_option : elt option -> t
val of_list : elt list -> t
val add : elt -> t -> t
val add_option : elt option -> t -> t
val add_list : elt list -> t -> t
val remove : elt -> t -> t
val diff : t -> t -> t
val inter : t -> t -> t
val union : t -> t -> t
val diff_inter : t -> t -> t * t
val diff_inter_diff : t -> t -> t * t * t
val union_list : t list -> t

Query

val is_empty : t -> bool
val cardinal : t -> int
val mem : elt -> t -> bool
val subset : t -> of_:t -> bool
val disjoint : t -> t -> bool
val max_elt : t -> elt option
val only_elt : t -> elt option
val classify : t -> elt NS__.NS0.zero_one_many
val choose : t -> elt option

Find an unspecified element. Different elements may be chosen for equivalent sets. O(1).

val choose_exn : t -> elt

Find an unspecified element. Different elements may be chosen for equivalent sets. O(1).

val pop : t -> (elt * t) option

Find and remove an unspecified element. O(1).

val pop_exn : t -> elt * t

Find and remove an unspecified element. O(1).

val pop_min_elt_exn : t -> elt * t

Find and remove the minimum element. O(1).

val split : elt -> t -> t * bool * t
val find : elt -> t -> elt

Transform

val map : t -> f:(elt -> elt) -> t
val flat_map : t -> f:(elt -> t) -> t
val filter : t -> f:(elt -> bool) -> t
val filter_map : t -> f:(elt -> elt option) -> t

Map f over a set, removing any element e where f e = None.

val partition : t -> f:(elt -> bool) -> t * t

Traverse

val iter : t -> f:(elt -> unit) -> unit
val exists : t -> f:(elt -> bool) -> bool
val for_all : t -> f:(elt -> bool) -> bool
val fold : t -> 's -> f:(elt -> 's -> 's) -> 's
val reduce : t -> f:(elt -> elt -> elt) -> elt option
val fold_map : t -> 's -> f:(elt -> 's -> elt * 's) -> t * 's

Map f over a set while threading an accumulator through calls to f.

Convert

val to_list : t -> elt list
val to_iter : t -> (elt -> unit) -> unit
val of_iter : ((elt -> unit) -> unit) -> t