Okasaki v1.0.1

Okasaki.Implementations.ConstantDeque (Okasaki v1.0.1) View Source

Deque is an implementation of Chris Okasaki's Purely Functional Deque

This means that pushing and popping to both ends of the double-ended-queue happen in constant (O(1)) time.

For the paper upon which this is based: http://www.westpoint.edu/eecs/SiteAssets/SitePages/Faculty Publication Documents/Okasaki/jfp95queue.pdf

Link to this section Summary

Types

t()

Functions

empty(opts \\ [])
empty?(constant_deque)
insert_left(deque, item)
insert_right(deque, item)
map(deque, fun)

Callback implementation for FunLand.Mappable.map/2.

member?(queue, item)
remove_left(deque)
remove_right(deque)
size(deque)
to_list(deque)

Link to this section Types

Link to this opaque

t()

View Source (opaque)

Specs

t()

Link to this section Functions

Link to this function

empty(opts \\ [])

View Source

Specs

empty(opts :: keyword()) :: t()
Link to this function

empty?(constant_deque)

View Source

Specs

empty?(t()) :: boolean()
Link to this function

insert_left(deque, item)

View Source

Specs

insert_left(t(), item :: any()) :: t()
Link to this function

insert_right(deque, item)

View Source

Specs

insert_right(t(), item :: any()) :: t()
Link to this function

map(deque, fun)

View Source

Specs

map(t(), (any() -> any())) :: t()

Callback implementation for FunLand.Mappable.map/2.

Link to this function

member?(queue, item)

View Source

Specs

member?(t(), item :: any()) :: boolean()
Link to this function

remove_left(deque)

View Source

Specs

remove_left(t()) :: {:ok, {any(), t()}} | {:error, :empty}
Link to this function

remove_right(deque)

View Source

Specs

remove_right(t()) :: {:ok, {any(), t()}} | {:error, :empty}
Link to this function

size(deque)

View Source

Specs

size(t()) :: non_neg_integer()
Link to this function

to_list(deque)

View Source

Specs

to_list(t()) :: list()