Stack

A stack is a LIFO (last-in-first-out) data structure where new values are added, retrieved, and removed from the end.

The default implementation is mutable, but an immutable stack implementation is available in the Immutable submodule.

1

from "stack" include Stack

Types

Type declarations included in the Stack module.

Stack.Stack

1

type Stack<a>

A mutable LIFO (last-in-first-out) data structure.

Values

Functions and constants included in the Stack module.

Stack.make

1

make : (?size: Number) => Stack<a>

Creates a new stack with an initial storage of the given size. As values are added or removed, the internal storage may grow or shrink. Generally, you won’t need to care about the storage size of your map and can use the default size.

Parameters:

Returns:

Stack.isEmpty

1

isEmpty : (stack: Stack<a>) => Bool

Checks if the given stack contains no items.

Parameters:

Returns:

Stack.size

1

size : (stack: Stack<a>) => Number

Computes the size of the input stack.

Parameters:

Returns:

Stack.peek

1

peek : (stack: Stack<a>) => Option<a>

Provides the value at the top of the stack, if it exists.

Parameters:

Returns:

Stack.push

1

push : (value: a, stack: Stack<a>) => Void

Adds a new item to the top of the stack.

Parameters:

Stack.pop

1

pop : (stack: Stack<a>) => Option<a>

Removes the item at the top of the stack.

Parameters:

Returns:

Stack.clear

1

clear : (stack: Stack<a>) => Void

Clears the stack by removing all of its elements

Parameters:

Stack.copy

1

copy : (stack: Stack<a>) => Stack<a>

Produces a shallow copy of the input stack.

Parameters:

Returns:

Stack.Immutable

An immutable stack implementation.

Types

Type declarations included in the Stack.Immutable module.

Stack.Immutable.ImmutableStack

1

type ImmutableStack<a>

ImmutableStacks are immutable data structures that store their data in a List.

Values

Functions and constants included in the Stack.Immutable module.

Stack.Immutable.empty

1

empty : ImmutableStack<a>

An empty stack.

Stack.Immutable.isEmpty

1

isEmpty : (stack: ImmutableStack<a>) => Bool

Checks if the given stack contains no items.

Parameters:

Returns:

Stack.Immutable.peek

1

peek : (stack: ImmutableStack<a>) => Option<a>

Provides the value at the top of the stack, if it exists.

Parameters:

Returns:

Stack.Immutable.push

1

push : (value: a, stack: ImmutableStack<a>) => ImmutableStack<a>

Adds a new item to the top of the stack.

Parameters:

Returns:

Stack.Immutable.pop

1

pop : (stack: ImmutableStack<a>) => ImmutableStack<a>

Removes the item at the top of the stack.

Parameters:

Returns:

Stack.Immutable.size

1

size : (stack: ImmutableStack<a>) => Number

Computes the size of the input stack.

Parameters:

Returns: