Module `Set.Using_comparator`

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 -> Base.Sexp.t) -> ('cmp -> Base.Sexp.t) -> ('elt, 'cmp) t -> Base.Sexp.t

val t_of_sexp_direct : comparator:('elt, 'cmp) Base.Comparator.t -> (Base.Sexp.t -> 'elt) -> Base.Sexp.t -> ('elt, 'cmp) t

module Tree : sig ... end

include Base__.Set_intf.Accessors2 with type ('a, 'b) t := ('a, 'b) t with type ('a, 'b) tree := ('a, 'b) Tree.t with type ('a, 'b) named := ('a, 'b) Named.t

include Base.Container.S1_phantom_invariant

type ('a, 'phantom) t

val mem : ('a, _) t -> 'a -> equal:('a -> 'a -> bool) -> bool: Checks whether the provided element is there, using equal.

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) Base.Result.t) -> ('accum, 'e) Base.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 fold_until : ('a, _) t -> init:'accum -> f:('accum -> 'a -> ('accum, 'final) Base__.Container_intf.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final

fold_until t ~init ~f ~finish 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. If f never returns Stop _, the final result is computed by finish.

Example:

type maybe_negative =
  | Found_negative of int
  | All_nonnegative of { sum : int }

(** [first_neg_or_sum list] returns the first negative number in [list], if any,
    otherwise returns the sum of the list. *)
let first_neg_or_sum =
  List.fold_until ~init:0
    ~f:(fun sum x ->
      if x < 0
      then Stop (Found_negative x)
      else Continue (sum + x))
    ~finish:(fun sum -> All_nonnegative { sum })
;;

let x = first_neg_or_sum [1; 2; 3; 4; 5]
val x : maybe_negative = All_nonnegative {sum = 15}

let y = first_neg_or_sum [1; 2; -3; 4; 5]
val y : maybe_negative = Found_negative -3

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
val min_elt : ('a, _) t -> compare:('a -> 'a -> int) -> 'a option: Returns a min (resp max) element from the collection using the provided compare function. In case of a tie, the first element encountered while traversing the collection is returned. The implementation uses fold so it has the same complexity as fold. Returns None iff the collection is empty.

val max_elt : ('a, _) t -> compare:('a -> 'a -> int) -> 'a option

type ('a, 'cmp) tree

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) Base.Either.t Base.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

type ('a, 'cmp) named

module Named : sig ... end

val fold_until : ('a, _) t -> init:'b -> f:('b -> 'a -> ('b, 'final) Base__.Set_intf.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
val to_sequence : ?⁠order:[ `Increasing | `Decreasing ] -> ?⁠greater_or_equal_to:'a -> ?⁠less_or_equal_to:'a -> ('a, 'cmp) t -> 'a Base.Sequence.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) Base__.Set_intf.Merge_to_sequence_element.t Base.Sequence.t

include Base__.Set_intf.Creators2_with_comparator with type ('a, 'b) t := ('a, 'b) t with type ('a, 'b) tree := ('a, 'b) Tree.t with type ('a, 'b) set := ('a, 'b) t

type ('a, 'cmp) set
type ('a, 'cmp) t
type ('a, 'cmp) tree

val empty : comparator:('a, 'cmp) Base.Comparator.t -> ('a, 'cmp) t
val singleton : comparator:('a, 'cmp) Base.Comparator.t -> 'a -> ('a, 'cmp) t
val union_list : comparator:('a, 'cmp) Base.Comparator.t -> ('a, 'cmp) t list -> ('a, 'cmp) t
val of_list : comparator:('a, 'cmp) Base.Comparator.t -> 'a list -> ('a, 'cmp) t
val of_array : comparator:('a, 'cmp) Base.Comparator.t -> 'a array -> ('a, 'cmp) t
val of_sorted_array : comparator:('a, 'cmp) Base.Comparator.t -> 'a array -> ('a, 'cmp) t Base.Or_error.t
val of_sorted_array_unchecked : comparator:('a, 'cmp) Base.Comparator.t -> 'a array -> ('a, 'cmp) t
val of_increasing_iterator_unchecked : comparator:('a, 'cmp) Base.Comparator.t -> len:int -> f:(int -> 'a) -> ('a, 'cmp) t
val stable_dedup_list : comparator:('a, 'cmp) Base.Comparator.t -> 'a list -> 'a list
val map : comparator:('b, 'cmp) Base.Comparator.t -> ('a, _) set -> f:('a -> 'b) -> ('b, 'cmp) t
val filter_map : comparator:('b, 'cmp) Base.Comparator.t -> ('a, _) set -> f:('a -> 'b option) -> ('b, 'cmp) t
val of_tree : comparator:('a, 'cmp) Base.Comparator.t -> ('a, 'cmp) tree -> ('a, 'cmp) t

val comparator : ('a, 'cmp) t -> ('a, 'cmp) Base.Comparator.t
val hash_fold_direct : 'elt Base.Hash.folder -> ('elt, 'cmp) t Base.Hash.folder

module Empty_without_value_restriction : functor (Elt : Base.Comparator.S1) -> sig ... end