structure

v0.2.2

structure v0.2.2 Structure.Stack View Source

A simple stack data structure. Supports push, pop and head operations.

Link to this section Summary

Types

empty_stack()
head_response()
pop_response()
stack()

Functions

empty?(stack)

Checks if a given stack is empty

from_list(list)

Creates a stack from a list

head(stack)

Returns the head of the stack

new()

Returns a new empty stack

pop(stack)

Pops top element from stack Returns {:ok, stack} for success, or {:error, :empty_stack} if the stack was empty

push(stack, item)

Pushes an item on the stack

size(stack)

Returns the size of a stack

Link to this section Types

Link to this type head_response() View Source 
head_response() :: {:ok, any} | {:error, atom}
Link to this type pop_response() View Source 
pop_response() :: {:ok, stack} | {:error, atom}

Link to this section Functions

Link to this function empty?(stack) View Source 
empty?(stack) :: boolean

Checks if a given stack is empty

Examples 

iex> Structure.Stack.empty?(%Structure.Stack{size: 0, list: []})
true
Link to this function from_list(list) View Source 
from_list([any]) :: stack

Creates a stack from a list.

Link to this function head(stack) View Source 
head(stack) :: head_response

Returns the head of the stack.

It should return {:ok, head}.

If the stack is empty, it returns {:error, :empty_stack} instead.

Examples 

iex> Structure.Stack.head(%Structure.Stack{size: 0, list: []})
{:error, :empty_stack}
Link to this function new() View Source 
new() :: empty_stack

Returns a new empty stack.

Link to this function pop(stack) View Source 
pop(stack) :: pop_response

Pops top element from stack Returns {:ok, stack} for success, or {:error, :empty_stack} if the stack was empty.

Link to this function push(stack, item) View Source 
push(stack, any) :: stack

Pushes an item on the stack.

Link to this function size(stack) View Source 
size(stack) :: non_neg_integer

Returns the size of a stack.