Module Core_kernel.Bag
module type S = Core_kernel__.Bag_intf.S
The module type of the Bag module.
include S
module Elt : sig ... end
include Ppx_sexp_conv_lib.Sexpable.S1 with type 'a t := 'a t
val t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a t
val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t
Much of a bag's interface comes from the generic Base.Container
module.
include Container.S1 with type 'a t := 'a t
val mem : 'a t -> 'a -> equal:('a -> 'a -> bool) -> bool
Checks whether the provided element is there, using
equal
.
val length : 'a t -> int
val is_empty : 'a 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
returnsf (... f (f (f init e1) e2) e3 ...) en
, wheree1..en
are the elements oft
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 offold
that runs in theResult
monad. Iff
returns anError _
, that value is returned without any additional invocations off
.
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 offold
. Iff
returnsStop _
the computation ceases and results in that value. Iff
returnsContinue _
, the fold will proceed. Iff
never returnsStop _
, the final result is computed byfinish
.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 totrue
. 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 totrue
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 alli
in the container.
val find : 'a t -> f:('a -> bool) -> 'a option
Returns as an
option
the first element for whichf
evaluates to true.
val find_map : 'a t -> f:('a -> 'b option) -> 'b option
Returns the first evaluation of
f
that returnsSome
, and returnsNone
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 minimum (resp maximum) element from the collection using the provided
compare
function, orNone
if the collection is empty. In case of a tie, the first element encountered while traversing the collection is returned. The implementation usesfold
so it has the same complexity asfold
.
val max_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option
include Core_kernel__.Import.Invariant.S1 with type 'a t := 'a t
val invariant : 'a Base__.Invariant_intf.inv -> 'a t Base__.Invariant_intf.inv
val create : Core_kernel__.Import.unit -> 'a t
create ()
returns an empty bag.
val add : 'a t -> 'a -> 'a Elt.t
add t v
addsv
to the bagt
, returning an element that can later be removed from the bag.add
runs in constant time.
val add_unit : 'a t -> 'a -> Core_kernel__.Import.unit
val mem_elt : 'a t -> 'a Elt.t -> Core_kernel__.Import.bool
mem_elt t elt
returns whether or notelt
is int
. It is likemem
(included fromContainer
), but it takes an'a Elt.t
instead of an'a
and runs in constant time instead of linear time.
val remove : 'a t -> 'a Elt.t -> Core_kernel__.Import.unit
remove t elt
removeselt
from the bagt
, raising an exception ifelt
is not in the bag.remove
runs in constant time.
val choose : 'a t -> 'a Elt.t Core_kernel__.Import.option
choose t
returns some element in the bag.
val remove_one : 'a t -> 'a Core_kernel__.Import.option
remove_one t
removes some element from the bag, and returns its value.remove_one
runs in constant time.
val clear : 'a t -> Core_kernel__.Import.unit
clear t
removes all elements from the bag.clear
runs in constant time.
val filter_inplace : 'a t -> f:('a -> Core_kernel__.Import.bool) -> Core_kernel__.Import.unit
filter_inplace t ~f
removes all the elements fromt
that don't satisfyf
.
val iter_elt : 'a t -> f:('a Elt.t -> Core_kernel__.Import.unit) -> Core_kernel__.Import.unit
val find_elt : 'a t -> f:('a -> Core_kernel__.Import.bool) -> 'a Elt.t Core_kernel__.Import.option
find_elt t ~f
returns the first element in the bag satisfyingf
, returningNone
if none is found.
val until_empty : 'a t -> ('a -> Core_kernel__.Import.unit) -> Core_kernel__.Import.unit
until_empty t f
repeatedly removes valuesv
fromt
, runningf v
on each one, untilt
is empty. Runningf
may add elements tot
if it wants.
val transfer : src:'a t -> dst:'a t -> Core_kernel__.Import.unit
transfer ~src ~dst
moves all of the elements fromsrc
todst
in constant time.
val of_list : 'a Core_kernel__.Import.list -> 'a t
val elts : 'a t -> 'a Elt.t Core_kernel__.Import.list
val unchecked_iter : 'a t -> f:('a -> Core_kernel__.Import.unit) -> Core_kernel__.Import.unit
unchecked_iter t ~f
behaves likeiter t ~f
except thatf
is allowed to modifyt
. Elements added byf
may or may not be visited; elements removed byf
that have not been visited will not be visited. It is an (undetected) error to delete the current element.