package core_kernel

  1. Overview
  2. Docs
package core_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type

A stack implemented with an array.

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 Stack_intf.S
type 'a t
include sig ... end
val bin_read_t : 'a Bin_prot.Read.reader -> 'a t Bin_prot.Read.reader
val __bin_read_t__ : 'a Bin_prot.Read.reader -> (Base.Int.t -> 'a t) Bin_prot.Read.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_shape_t : Bin_prot.Shape.t -> Bin_prot.Shape.t
val t_of_sexp : (Sexplib.Sexp.t -> 'a) -> Sexplib.Sexp.t -> 'a t
val sexp_of_t : ('a -> Sexplib.Sexp.t) -> 'a t -> Sexplib.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 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 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, 'stop) Base.Container_intf.Export.Continue_or_stop.t) -> ('accum, 'stop) Base.Container_intf.Export.Finished_or_stopped_early.t

fold_until t ~init ~f 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.

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 -> cmp:('a -> 'a -> int) -> 'a option

Returns a minimum (resp maximum) element from the collection using the provided cmp 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 -> cmp:('a -> 'a -> int) -> 'a option
val of_list : 'a Base.List.t -> '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 : Base.Unit.t -> _ 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 -> Base.Unit.t

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

val pop : 'a t -> 'a Base.Option.t

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 Base.Option.t

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 -> Base.Unit.t

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

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.

val capacity : _ t -> Base.Int.t

capacity t returns the length of the array backing t.

val set_capacity : _ t -> Base.Int.t -> Base.Unit.t

set_capacity t capacity sets the length of the array backing t to max capacity (length t). To shrink as much as possible, do set_capacity t 0.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct