stella v0.6.0 Queue

Documentation for Queue data structure

Link to this section Summary

Functions

Deletes element from queue

Adds element to queue

Checks if queue is empty

Creates a new, empty qeue

Link to this section Functions

Specs

dequeue(list()) :: list()

Deletes element from queue

Examples

iex> Queue.dequeue([1])
[]

iex> Queue.dequeue([])
[]

iex> Queue.dequeue([1, 2, 3])
[2, 3]

iex> Queue.dequeue([1, "2", :atom])
["2", :atom]
Link to this function

enqueue(queue, element)

Specs

enqueue(list(), any()) :: list()

Adds element to queue

Examples

iex> Queue.enqueue([1], 2)
[1, 2]

iex> Queue.enqueue([1], 2)
[1, 2]

iex> Queue.enqueue([1, "2", :atom], 5)
[1, "2", :atom, 5]
Link to this function

is_empty(queue)

Specs

is_empty(list()) :: boolean()

Checks if queue is empty

Examples

iex> Queue.is_empty([])
true

iex> Queue.is_empty([1, "2", :atom, 5])
false

Specs

new() :: []

Creates a new, empty qeue

Examples

iex> Queue.new()
[]