Stack

Deprecated: This module will be renamed to ImmutableStack in the v0.6.0 release of Grain.

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

1

import Stack from "stack"

Types

Type declarations included in the Stack module.

Stack.Stack

1

type Stack<a>

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

Values

Functions and constants included in the Stack module.

Stack.empty

1

empty : Stack<a>

An empty stack.

Stack.make

Deprecated: This will be removed in the v0.6.0 release of Grain.

1

make : () -> Stack<a>

Creates a new stack.

Returns:

Stack.isEmpty

1

isEmpty : Stack<a> -> Bool

Checks if the given stack contains no items.

Parameters:

Returns:

Stack.peek

1

peek : Stack<a> -> Option<a>

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

Parameters:

Returns:

Stack.push

1

push : (a, Stack<a>) -> Stack<a>

Adds a new item to the top of the stack.

Parameters:

Returns:

Stack.pop

1

pop : Stack<a> -> Stack<a>

Removes the item at the top of the stack.

Parameters:

Returns:

Stack.size

1

size : Stack<a> -> Number

Computes the size of the input stack.

Parameters:

Returns: