stack

Documentation

Index

• type Stack
  • func New[T any]() *Stack[T]
  • func (s *Stack[T]) Length() int
  • func (s *Stack[T]) Peek() (a T, b bool)
  • func (s *Stack[T]) Pop() (a T, b bool)
  • func (s *Stack[T]) Push(v T)

Types

type Stack

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

Stack is used to implement the last-in first-out.

func New

func New[T any]() *Stack[T]

New is used to create a new instance of the stack.

func (*Stack[T]) Length

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

Length is used to return the number of elements in the stack.

func (*Stack[T]) Peek

func (s *Stack[T]) Peek() (a T, b bool)

Peek is used to access the top-most element from the stack.

If there are no elements in the stack, then the default value of the type is returned and a boolean value false stating that no elements were popped.

func (*Stack[T]) Pop

func (s *Stack[T]) Pop() (a T, b bool)

Pop is used to remove the top-most element from the stack. It returns the value of the removed element.

If there are no elements in the stack, then the default value of the type is returned and a boolean value false stating that no elements were popped.

func (*Stack[T]) Push

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

Push is used to push an element to the stack.