stack

Documentation

Overview

Package stack implements a stack built using a linked list.

Index

• type Stack
  • func New1[T any](t T) *Stack[T]
  • func (s *Stack[T]) Len() int
  • func (s *Stack[T]) Peek() T
  • func (s *Stack[T]) Pop() T
  • func (s *Stack[T]) Push(elem T)
  • func (s *Stack[T]) Swap(elem T) T

Types

type Stack

type Stack[T any] struct {
	// contains filtered or unexported fields
}

Stack is a stack that uses a linked list to store its elements.

The zero value for a Stack is an empty stack ready to use.

func New1

func New1[T any](t T) *Stack[T]

func (*Stack[T]) Len

func (s *Stack[T]) Len() int

Len returns the length of the stack.

func (*Stack[T]) Peek

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

Peek returns the element at the top of the stack without removing it.

If the stack is of length 0, Peek will panic.

func (*Stack[T]) Pop

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

Pop takes the top-most element from the stack and removes it.

If the stack is of length 0, Pop will panic.

func (*Stack[T]) Push

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

Push puts elem on top of the stack.

func (*Stack[T]) Swap

func (s *Stack[T]) Swap(elem T) T

Swap swaps the top-most element for elem, returning the element previously at the top.

If the stack is of length 0, Swap will panic.