Stack (core_kernel.Core_kernel_

The implementation will grow the array as necessary, and will never automatically shrink the array. One can use set_capacity to explicitly resize the array.

include Core_kernel.Stack_intf.S

type 'a t

include sig ... end

val bin_t : 'a Bin_prot.Type_class.t ‑> 'a t Bin_prot.Type_class.t

val bin_read_t : 'a Bin_prot.Read.reader ‑> 'a t Bin_prot.Read.reader

val __bin_read_t__ : 'a Bin_prot.Read.reader ‑> (Core_kernel__.Import.int ‑> 'a t) Bin_prot.Read.reader

val bin_reader_t : 'a Bin_prot.Type_class.reader ‑> 'a t Bin_prot.Type_class.reader

val bin_size_t : 'a Bin_prot.Size.sizer ‑> 'a t Bin_prot.Size.sizer

val bin_write_t : 'a Bin_prot.Write.writer ‑> 'a t Bin_prot.Write.writer

val bin_writer_t : 'a Bin_prot.Type_class.writer ‑> 'a t Bin_prot.Type_class.writer

val bin_shape_t : Bin_prot.Shape.t ‑> Bin_prot.Shape.t

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 Core_kernel__.Import.Invariant.S1 with type a t := a t

type 'a t

val invariant : 'a Base__.Invariant_intf.inv ‑> 'a t Base__.Invariant_intf.inv

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 Core_kernel.Container.S1 with type a t := a t

type '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 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.

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.Commutative_group.S 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 minimum (resp maximum) element from the collection using the provided compare function, or None if the collection is empty. 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.

val max_elt : 'a t ‑> compare:('a ‑> 'a ‑> int) ‑> 'a option

val of_list : 'a Core_kernel__.Import.list ‑> 'a t

of_list l returns a stack whose top is the first element of l and bottom is the last element of l.

val create : Core_kernel__.Import.unit ‑> _ t

create () returns an empty stack.

val singleton : 'a ‑> 'a t

singleton a creates a new stack containing only a.

val push : 'a t ‑> 'a ‑> Core_kernel__.Import.unit

push t a adds a to the top of stack t.

val pop : 'a t ‑> 'a Core_kernel__.Import.option

pop t removes and returns the top element of t as Some a, or returns None if t is empty.

val pop_exn : 'a t ‑> 'a

val top : 'a t ‑> 'a Core_kernel__.Import.option

top t returns Some a, where a is the top of t, unless is_empty t, in which case top returns None.

val top_exn : 'a t ‑> 'a

val clear : _ t ‑> Core_kernel__.Import.unit

clear t discards all elements from t.

val copy : 'a t ‑> 'a t

copy t returns a copy of t.

val until_empty : 'a t ‑> ('a ‑> Core_kernel__.Import.unit) ‑> Core_kernel__.Import.unit

until_empty t f repeatedly pops an element a off of t and runs f a, until t becomes empty. It is fine if f adds more elements to t, in which case the most-recently-added element will be processed next.