stack

Documentation

Index

• func IsEmpty[T any](stack []T) bool
• func IsFull[T any](stack []T) bool
• func Peek[T any](stack []T) (T, error)
• func PeekN[T any](stack []T, n uint) ([]T, error)
• func Pop[T any](stack []T) ([]T, T, error)
• func PopN[T any](stack []T, n uint) ([]T, []T, error)
• func Push[T any](stack []T, val T) ([]T, error)
• func PushMany[T any](stack []T, vals []T) ([]T, error)

Functions

func IsEmpty

func IsEmpty[T any](stack []T) bool

IsEmpty returns true iff stack is empty.

func IsFull

func IsFull[T any](stack []T) bool

IsFull returns true iff stack is full, i.e. at capacity.

func Peek

func Peek[T any](stack []T) (T, error)

Peek copies the top element of the stack.

Returns the element on the top of the stack or ErrEmpty if stack is empty. FIXME needs testing

func PeekN

func PeekN[T any](stack []T, n uint) ([]T, error)

PeekN peeks for the top `n` elements on the stack.

Returns slice of top `n` elements, or ErrEmpty if more elements are requested than are present. FIXME needs testing

func Pop

func Pop[T any](stack []T) ([]T, T, error)

Pop pops an element off the stack.

Returns updated stack and element, or ErrEmpty if stack is empty. FIXME needs testing

func PopN

func PopN[T any](stack []T, n uint) ([]T, []T, error)

PopN pops `n` elements off the stack.

Returns updated stack and elements, or ErrEmpty if more elements are popped than are present. FIXME needs testing

func Push

func Push[T any](stack []T, val T) ([]T, error)

Push pushes an element onto the stack.

Returns the updated stack, or ErrFull if stack is at full capacity.

func PushMany

func PushMany[T any](stack []T, vals []T) ([]T, error)

PushMany pushes a sequence of elements onto the stack.

Returns updated stack, or ErrFull if sequence is larger than capacity. FIXME needs testing (PushMany must end up in reverse order)