jon.recoil.org

Module Stdlib.StackSource

Last-in first-out stacks.

This module implements stacks (LIFOs), with in-place modification.

Unsynchronized accesses

Unsynchronized accesses to a stack may lead to an invalid queue state. Thus, concurrent accesses to stacks must be synchronized (for instance with a Mutex.t).

Sourcetype !('a : value_or_null) t

The type of stacks containing elements of type 'a.

Sourceexception Empty

Raised when Stack.pop or Stack.top is applied to an empty stack.

Sourceval create : ('a : value_or_null). unit -> 'a Stdlib.Stack.t @@ portable

Return a new stack, initially empty.

Sourceval push : ('a : value_or_null). 'a -> 'a Stdlib.Stack.t -> unit @@ portable

push x s adds the element x at the top of stack s.

Sourceval pop : ('a : value_or_null). 'a Stdlib.Stack.t -> 'a @@ portable

pop s removes and returns the topmost element in stack s, or raises Empty if the stack is empty.

Sourceval pop_opt : ('a : value_or_null). 'a Stdlib.Stack.t -> 'a option @@ portable

pop_opt s removes and returns the topmost element in stack s, or returns None if the stack is empty.

  • since 4.08
Sourceval drop : ('a : value_or_null). 'a Stdlib.Stack.t -> unit @@ portable

drop s removes the topmost element in stack s, or raises Empty if the stack is empty.

  • since 5.1
Sourceval top : ('a : value_or_null). 'a Stdlib.Stack.t -> 'a @@ portable

top s returns the topmost element in stack s, or raises Empty if the stack is empty.

Sourceval top_opt : ('a : value_or_null). 'a Stdlib.Stack.t -> 'a option @@ portable

top_opt s returns the topmost element in stack s, or None if the stack is empty.

  • since 4.08
Sourceval clear : ('a : value_or_null). 'a Stdlib.Stack.t -> unit @@ portable

Discard all elements from a stack.

Sourceval copy : ('a : value_or_null). 'a Stdlib.Stack.t -> 'a Stdlib.Stack.t @@ portable

Return a copy of the given stack.

Sourceval is_empty : ('a : value_or_null). 'a Stdlib.Stack.t -> bool @@ portable

Return true if the given stack is empty, false otherwise.

Sourceval length : ('a : value_or_null). 'a Stdlib.Stack.t -> int @@ portable

Return the number of elements in a stack. Time complexity O(1)

Sourceval iter : ('a : value_or_null). ('a -> unit) -> 'a Stdlib.Stack.t -> unit @@ portable

iter f s applies f in turn to all elements of s, from the element at the top of the stack to the element at the bottom of the stack. The stack itself is unchanged.

Sourceval fold : ('acc : value_or_null) ('a : value_or_null). ('acc -> 'a -> 'acc) -> 'acc -> 'a Stdlib.Stack.t -> 'acc @@ portable

fold f accu s is (f (... (f (f accu x1) x2) ...) xn) where x1 is the top of the stack, x2 the second element, and xn the bottom element. The stack is unchanged.

  • since 4.03

Stacks and Sequences

Sourceval to_seq : ('a : value_or_null). 'a Stdlib.Stack.t -> 'a Stdlib.Seq.t @@ portable

Iterate on the stack, top to bottom. It is safe to modify the stack during iteration.

  • since 4.07
Sourceval add_seq : ('a : value_or_null). 'a Stdlib.Stack.t -> 'a Stdlib.Seq.t -> unit @@ portable

Add the elements from the sequence on the top of the stack.

  • since 4.07
Sourceval of_seq : ('a : value_or_null). 'a Stdlib.Seq.t -> 'a Stdlib.Stack.t @@ portable

Create a stack from the sequence.

  • since 4.07