package kcas_data

  1. Overview
  2. Docs

Module Stack.XtSource

Explicit transaction log passing on stacks.

Sourceval is_empty : xt:'x Kcas.Xt.t -> 'a t -> bool

is_empty s determines whether the stack s is empty.

Sourceval length : xt:'x Kcas.Xt.t -> 'a t -> int

length s returns the length of the stack s.

Sourceval clear : xt:'x Kcas.Xt.t -> 'a t -> unit

clear s removes all elements from the stack s.

Sourceval swap : xt:'x Kcas.Xt.t -> 'a t -> 'a t -> unit

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

Sourceval to_seq : xt:'x Kcas.Xt.t -> '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 : xt:'x Kcas.Xt.t -> 'a -> 'a t -> unit

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

Sourceval pop_opt : xt:'x Kcas.Xt.t -> '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 : xt:'x Kcas.Xt.t -> 'a t -> 'a option

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