stack

Documentation

Overview

Package stack is a simple implementation of the stack data structure.

Example (BasicUsage)

package main

import (
	"fmt"

	"github.com/eng618/go-eng/ds/stack"
)

func main() {
	s := stack.New()

	s.Push(25)
	s.Push(1)
	s.Push(2)

	if v, err := s.Pop(); err == nil {
		fmt.Println("Pop returned", v)
	}
}

Output:

Pop returned 2

Example (SeededList)

package main

import (
	"fmt"

	"github.com/eng618/go-eng/ds/stack"
)

func main() {
	s := stack.NewSeeded([]stack.Item{1, 2, 3, 4, 5})

	if v, err := s.Pop(); err == nil {
		fmt.Println("Pop returned", v)
	}
}

Output:

Pop returned 5

Index

• type Item
• type Stack
  • func New() *Stack
  • func NewSeeded(xi []Item) *Stack
  • func (s *Stack) Pop() (i Item, err error)
  • func (s *Stack) Push(i Item) (ok bool)

Examples

• Package (BasicUsage)
• Package (SeededList)

Types

type Item

type Item int

Item is the type a stack accepts.

type Stack

type Stack struct {
	Items []Item
	// contains filtered or unexported fields
}

Stack is the structure to interact with the stack package.

func New

func New() *Stack

New creates an empty stack to be pushed too.

func NewSeeded

func NewSeeded(xi []Item) *Stack

NewSeeded creates a new stack with a seeded list xi.

func (*Stack) Pop

func (s *Stack) Pop() (i Item, err error)

Pop returns the last item placed on the stack. LIFO. Returns -1 if there is nothing on the list to return.

func (*Stack) Push

func (s *Stack) Push(i Item) (ok bool)

Push adds the provided item to the stack.