queue

README

= A generics based Go Queue.

A simple stack with Push, Pop, Length, IsEmpty using Go generics.

This requires version 1.18beta1 of Go to be compiled and used.

This queue implemenation is based on using a slice and the
performance will be significantly different when poping
values thatn a queue based on a doublly linked list.  In this
implentation a copy of the queued dat ais made each time a
`Pop` occures.  This will result in an order(n) performance
for this operation.
A DLL based queue has a order(1) timing for the
same operation.

Documentation

Index

• Variables
• type Queue
  • func (ns *Queue[T]) Dequeue() (rv *T, err error)
  • func (ns *Queue[T]) Enqueue(t T)
  • func (ns *Queue[T]) IsEmpty() bool
  • func (ns *Queue[T]) Length() int
  • func (ns *Queue[T]) Peek() (*T, error)
  • func (ns *Queue[T]) Pop() error
  • func (ns *Queue[T]) Push(t T)

Variables

var ErrEmptyQueue = errors.New("Empty Queue")

An error to indicate that the stack is empty

Types

type Queue

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

Queue is a generic type buildt on top of a slice

func (*Queue[T]) Dequeue

func (ns *Queue[T]) Dequeue() (rv *T, err error)

Dequeue remove and return an element from the queue (if there is one), else return an error.

func (*Queue[T]) Enqueue

func (ns *Queue[T]) Enqueue(t T)

Enqueue is the same as Push. Enqueue will push new data of type [T any] onto the stack.

func (*Queue[T]) IsEmpty

func (ns *Queue[T]) IsEmpty() bool

IsEmpty will return true if the stack is empty

func (*Queue[T]) Length

func (ns *Queue[T]) Length() int

Length returns the number of elements in the stack.

func (*Queue[T]) Peek

func (ns *Queue[T]) Peek() (*T, error)

Peek returns the top element of the stack or an error indicating that the stack is empty.

func (*Queue[T]) Pop

func (ns *Queue[T]) Pop() error

Pop will remove the top element from the stack. An error is returned if the stack is empty.

func (*Queue[T]) Push

func (ns *Queue[T]) Push(t T)

Push will push new data of type [T any] onto the stack.