mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-17 08:06:41 -05:00
83 lines
2 KiB
OCaml
83 lines
2 KiB
OCaml
|
|
(* This file is free software, part of containers. See file "license" for more details. *)
|
|
|
|
(** {1 Wrapper around Set}
|
|
|
|
@since 0.9 *)
|
|
|
|
type 'a sequence = ('a -> unit) -> unit
|
|
type 'a printer = Format.formatter -> 'a -> unit
|
|
|
|
module type OrderedType = Set.OrderedType
|
|
(** @since 1.5 *)
|
|
|
|
module type S = sig
|
|
include Set.S
|
|
|
|
val min_elt_opt : t -> elt option
|
|
(** Safe version of {!min_elt}.
|
|
@since 1.5 *)
|
|
|
|
val max_elt_opt : t -> elt option
|
|
(** Safe version of {!max_elt}.
|
|
@since 1.5 *)
|
|
|
|
val choose_opt : t -> elt option
|
|
(** Safe version of {!choose}.
|
|
@since 1.5 *)
|
|
|
|
val find_opt : elt -> t -> elt option
|
|
(** Safe version of {!find}.
|
|
@since 1.5 *)
|
|
|
|
val find_first : (elt -> bool) -> t -> elt
|
|
(** Find minimum element satisfying predicate.
|
|
@since 1.5 *)
|
|
|
|
val find_first_opt : (elt -> bool) -> t -> elt option
|
|
(** Safe version of {!find_first}.
|
|
@since 1.5 *)
|
|
|
|
val find_last : (elt -> bool) -> t -> elt
|
|
(** Find maximum element satisfying predicate.
|
|
@since 1.5 *)
|
|
|
|
val find_last_opt : (elt -> bool) -> t -> elt option
|
|
(** Safe version of {!find_last}.
|
|
@since 1.5 *)
|
|
|
|
val of_seq : elt sequence -> t
|
|
(** Build a set from the given [sequence] of elements. *)
|
|
|
|
val add_seq : t -> elt sequence -> t
|
|
(** @since 0.14 *)
|
|
|
|
val to_seq : t -> elt sequence
|
|
(** [to_seq t] converts the set [t] to a [sequence] of the elements. *)
|
|
|
|
val of_list : elt list -> t
|
|
(** Build a set from the given list of elements,
|
|
added in order using {!add}. *)
|
|
|
|
val add_list : t -> elt list -> t
|
|
(** @since 0.14 *)
|
|
|
|
val to_list : t -> elt list
|
|
(** [to_list t] converts the set [t] to a list of the elements. *)
|
|
|
|
val to_string :
|
|
?start:string -> ?stop:string -> ?sep:string ->
|
|
(elt -> string) -> t -> string
|
|
(** Print the set in a string
|
|
@since NEXT_RELEASE *)
|
|
|
|
val pp :
|
|
?start:string -> ?stop:string -> ?sep:string ->
|
|
elt printer -> t printer
|
|
(** Print the set. *)
|
|
|
|
end
|
|
|
|
module Make(O : Set.OrderedType) : S
|
|
with type t = Set.Make(O).t
|
|
and type elt = O.t
|