Module Base__Stack
module type S = sig ... end
include S
val t_of_sexp : (Base.Sexp.t -> 'a) -> Base.Sexp.t -> 'a t
val sexp_of_t : ('a -> Base.Sexp.t) -> 'a t -> Base.Sexp.t
include Base.Invariant.S1 with type 'a t := 'a t
val invariant : ('a -> unit) -> 'a t -> unit
fold
, iter
, find
, and find_map
visit the elements in order from the top of the stack to the bottom. to_list
and to_array
return the elements in order from the top of the stack to the bottom.
Iteration functions (iter
, fold
, etc.) have unspecified behavior (although they should still be memory-safe) when the stack is mutated while they are running (e.g. by having the passed-in function call push
or pop
on the stack).
include Base.Container.S1 with type 'a t := 'a t
val mem : 'a t -> 'a -> equal:('a -> 'a -> bool) -> bool
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
val fold_result : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'e) Base.Result.t) -> ('accum, 'e) Base.Result.t
val fold_until : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'final) Base__.Container_intf.Export.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final
val exists : 'a t -> f:('a -> bool) -> bool
val for_all : 'a t -> f:('a -> bool) -> bool
val count : 'a t -> f:('a -> bool) -> int
val sum : (module Base__.Container_intf.Summable with type t = 'sum) -> 'a t -> f:('a -> 'sum) -> 'sum
val find : 'a t -> f:('a -> bool) -> 'a option
val find_map : 'a t -> f:('a -> 'b option) -> 'b option
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
val max_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option
val of_list : 'a list -> 'a t
of_list l
returns a stack whose top is the first element ofl
and bottom is the last element ofl
.
val create : unit -> _ t
create ()
returns an empty stack.
val singleton : 'a -> 'a t
singleton a
creates a new stack containing onlya
.
val push : 'a t -> 'a -> unit
push t a
addsa
to the top of stackt
.
val pop : 'a t -> 'a option
pop t
removes and returns the top element oft
asSome a
, or returnsNone
ift
is empty.
val pop_exn : 'a t -> 'a
val top : 'a t -> 'a option
top t
returnsSome a
, wherea
is the top oft
, unlessis_empty t
, in which casetop
returnsNone
.
val until_empty : 'a t -> ('a -> unit) -> unit
until_empty t f
repeatedly pops an elementa
off oft
and runsf a
, untilt
becomes empty. It is fine iff
adds more elements tot
, in which case the most-recently-added element will be processed next.
val capacity : _ t -> int
capacity t
returns the length of the array backingt
.
val set_capacity : _ t -> int -> unit
set_capacity t capacity
sets the length of the array backingt
tomax capacity (length t)
. To shrink as much as possible, doset_capacity t 0
.