stacks

package

v0.2.0 Latest Latest Go to latest Published: Nov 24, 2023 License: Apache-2.0 Imports: 2 Imported by: 0

Details

This section is empty.

View Source

var ErrStackUnderflow = errors.New("stack underflow")

ErrStackUnderflow is returned when attempting to Pop from an empty Stack.

This section is empty.

type Stack[T comparable] struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Stack is an abstract data type that serves as a collection of elements.

func NewStack[T comparable]() Stack[T]

NewStack creates and returns an initialized stack.

func (s *Stack[T]) Peek() T

Peek returns the top element on the Stack, without removing it.

If the Stack is empty, nil is returned.

func (s *Stack[T]) Pop() (T, error)

Pop pops the top element off the stack, it can return an error if the Stack is empty.

func (s *Stack[T]) Push(e T)

Push pushes a new element onto the top of the Stack.