package saturn_lockfree

You can search for identifiers within the package.

in-package search v0.2.0

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Saturn_lockfree.Stack`Source

Classic multi-producer multi-consumer Treiber stack.

All function are lockfree. It is the recommended starting point when needing LIFO structure.

Sourcetype 'a t

Type of Treiber stack holding items of type t.

Sourceval create : unit -> 'a t

create () returns a new and empty Treiber stack.

Sourceval is_empty : 'a t -> bool

is_empty s checks whether stack s is empty.

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

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

Sourceexception Empty

Raised when pop or peek is applied to an empty queue.

Sourceval pop : 'a t -> 'a

pop s removes and returns the topmost element in the stack s.

Sourceval pop_opt : 'a t -> 'a option

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