package kcas_data

  1. Overview
  2. Docs

Module Kcas_data.StackSource

Last-In First-Out (LIFO) stack.

The interface provides a subset of the OCaml Stdlib.Stack module. add_seq is not provided at all. Compositional versions of iter, fold, pop, and top are not provided.

The implementation is essentially a Treiber stack with randomized exponential backoff and support for constant time length.

Common interface

Sourcetype !'a t

The type of stacks containing elements of type 'a.

Sourceexception Empty

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

Sourceval create : unit -> 'a t

create () returns a new empty stack.

Sourceval copy : 'a t -> 'a t

copy s returns a copy of the stack s.

Sourceval of_seq : 'a Seq.t -> 'a t

of_seq xs creates a stack from the sequence xs.

Compositional interfaces

Sourcemodule Tx : sig ... end

Transactions on stacks.

Sourcemodule Xt : sig ... end

Explicit transaction log passing on stacks.

Non-compositional interface

Sourceval is_empty : 'a t -> bool

is_empty s determines whether the stack s is empty.

Sourceval length : 'a t -> int

length s returns the length of the stack s.

Sourceval clear : 'a t -> unit

clear s removes all elements from the stack s.

Sourceval swap : 'a t -> 'a t -> unit

swap s1 s2 exchanges the contents of the stacks s1 and s2.

Sourceval to_seq : 'a t -> 'a Seq.t

to_seq s returns a domain safe sequence for iterating through the elements of the stack top to bottom.

The sequence is based on a constant time, O(1), snapshot of the stack and modifications of the stack have no effect on the sequence.

Sourceval push : 'a -> 'a t -> unit

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

Sourceval pop_opt : 'a t -> 'a option

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

Sourceval top_opt : 'a t -> 'a option

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

Sourceval pop : 'a t -> 'a

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

Sourceval top : 'a t -> 'a

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

Sourceval iter : ('a -> unit) -> 'a t -> unit

iter f s is equivalent to Seq.iter f (to_seq s).

Sourceval fold : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'b

fold f s is equivalent to Seq.fold_left f a (to_seq s).