lstructs

README

Lam-Structures

This is a useful test to publish to the golang packages and allows users to pull from here

Please refer to all of the functions and data structures in https://pkg.go.dev/github.com/edelille/lstructs

How to use

1. Import via "github.com/edelille/lstructs" on top of the file
2. Grab it using $ go get github.com/edelille/lstructs
3. Update using $ go mod tidy

Example Code

package main

import (
    "fmt"

    ls "github.com/edelille/lstructs"
)

func main() {
    // Initialize the data structure
    stack := ls.NewStack[int]()

    // Push onto the Stack!
    stack.Push(5)

    // Peek on top of the Stack!
    fmt.Println(stack.Peek())   // Should print 5

    // Pop off the top!
    fmt.Println(stack.Pop())   // Should print 5, and removes 5 off of stack

    fmt.Println(stack.Size())   // Should print 0
    fmt.Println(stack.IsEmpty())   // Should print true
}

Documentation

Index

• func Equals[T comparable](x, y T) bool
• func Less[T constraints.Ordered](x, y T) bool
• func Swap[T any](arr []T, i, j int)
• type BST
  • func NewBST[T comparable](less LessFn[T]) *BST[T]
  • func (b *BST[T]) InorderTraversal() []T
  • func (b *BST[T]) Insert(x T)
  • func (b *BST[T]) PostorderTraversal() []T
  • func (b *BST[T]) PreorderTraversal() []T
  • func (b *BST[T]) Rebalance()
  • func (b *BST[T]) Remove(x T)
  • func (b *BST[T]) Search(x T) bool
  • func (b *BST[T]) Size() int
• type BSTNode
• type Deque
  • func NewDeque[T any]() *Deque[T]
  • func (d *Deque[T]) IsEmpty() bool
  • func (d *Deque[T]) PeekLeft() T
  • func (d *Deque[T]) PeekRight() T
  • func (d *Deque[T]) PopLeft() T
  • func (d *Deque[T]) PopRight() T
  • func (d *Deque[T]) PushLeft(x T)
  • func (d *Deque[T]) PushRight(x T)
  • func (d *Deque[T]) Size() int
• type EqualsFn
• type Heap
  • func NewHeap[T comparable](less LessFn[T]) *Heap[T]
  • func (h *Heap[T]) Delete(x T) bool
  • func (h *Heap[T]) Insert(x T)
  • func (h *Heap[T]) IsEmpty() bool
  • func (h *Heap[T]) Peek() T
  • func (h *Heap[T]) Pop() T
  • func (h *Heap[T]) Size() int
• type LessFn
• type Queue
  • func NewQueue[T any]() *Queue[T]
  • func (q *Queue[T]) Dequeue() T
  • func (q *Queue[T]) Enqueue(x T)
  • func (q *Queue[T]) IsEmpty() bool
  • func (q *Queue[T]) Peek() T
  • func (q *Queue[T]) Size() int
• type Set
  • func NewSet[T comparable]() *Set[T]
  • func (s *Set[T]) Add(x T)
  • func (s *Set[T]) Clear()
  • func (s *Set[T]) Has(x T) bool
  • func (s *Set[T]) IsEmpty() bool
  • func (s *Set[T]) Remove(x T)
  • func (s *Set[T]) Size() int
• type Stack
  • func NewStack[T any]() *Stack[T]
  • func (s *Stack[T]) IsEmpty() bool
  • func (s *Stack[T]) Peek() T
  • func (s *Stack[T]) Pop() T
  • func (s *Stack[T]) Push(x T)
  • func (s *Stack[T]) Size() int

Functions

func Equals

func Equals[T comparable](x, y T) bool

func Less

func Less[T constraints.Ordered](x, y T) bool

func Swap

func Swap[T any](arr []T, i, j int)

Types

type BST

type BST[T comparable] struct {
	Length int
	Head   *BSTNode[T]
	Less   LessFn[T]
}

func NewBST

func NewBST[T comparable](less LessFn[T]) *BST[T]

func (*BST[T]) InorderTraversal

func (b *BST[T]) InorderTraversal() []T

func (*BST[T]) Insert

func (b *BST[T]) Insert(x T)

func (*BST[T]) PostorderTraversal

func (b *BST[T]) PostorderTraversal() []T

func (*BST[T]) PreorderTraversal

func (b *BST[T]) PreorderTraversal() []T

func (*BST[T]) Rebalance

func (b *BST[T]) Rebalance()

func (*BST[T]) Remove

func (b *BST[T]) Remove(x T)

func (*BST[T]) Search

func (b *BST[T]) Search(x T) bool

func (*BST[T]) Size

func (b *BST[T]) Size() int

type BSTNode

type BSTNode[T comparable] struct {
	Val   T
	Left  *BSTNode[T]
	Right *BSTNode[T]
}

type Deque

type Deque[T any] struct {
	Length int
	Data   []T
}

func NewDeque

func NewDeque[T any]() *Deque[T]

func (*Deque[T]) IsEmpty

func (d *Deque[T]) IsEmpty() bool

func (*Deque[T]) PeekLeft

func (d *Deque[T]) PeekLeft() T

func (*Deque[T]) PeekRight

func (d *Deque[T]) PeekRight() T

func (*Deque[T]) PopLeft

func (d *Deque[T]) PopLeft() T

func (*Deque[T]) PopRight

func (d *Deque[T]) PopRight() T

func (*Deque[T]) PushLeft

func (d *Deque[T]) PushLeft(x T)

func (*Deque[T]) PushRight

func (d *Deque[T]) PushRight(x T)

func (*Deque[T]) Size

func (d *Deque[T]) Size() int

type EqualsFn

type EqualsFn[T comparable] func(x, y T) bool

type Heap

type Heap[T comparable] struct {
	Length int
	Data   []T
	// contains filtered or unexported fields
}

func NewHeap

func NewHeap[T comparable](less LessFn[T]) *Heap[T]

func (*Heap[T]) Delete

func (h *Heap[T]) Delete(x T) bool

The delete function will return True on successful deletion

func (*Heap[T]) Insert

func (h *Heap[T]) Insert(x T)

func (*Heap[T]) IsEmpty

func (h *Heap[T]) IsEmpty() bool

func (*Heap[T]) Peek

func (h *Heap[T]) Peek() T

func (*Heap[T]) Pop

func (h *Heap[T]) Pop() T

func (*Heap[T]) Size

func (h *Heap[T]) Size() int

type LessFn

type LessFn[T comparable] func(x, y T) bool

type Queue

type Queue[T any] struct {
	Length int
	Data   []T
}

func NewQueue

func NewQueue[T any]() *Queue[T]

func (*Queue[T]) Dequeue

func (q *Queue[T]) Dequeue() T

func (*Queue[T]) Enqueue

func (q *Queue[T]) Enqueue(x T)

func (*Queue[T]) IsEmpty

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

func (*Queue[T]) Peek

func (q *Queue[T]) Peek() T

func (*Queue[T]) Size

func (q *Queue[T]) Size() int

type Set

type Set[T comparable] struct {
	Length int
	Data   map[T]interface{}
}

func NewSet

func NewSet[T comparable]() *Set[T]

func (*Set[T]) Add

func (s *Set[T]) Add(x T)

func (*Set[T]) Clear

func (s *Set[T]) Clear()

func (*Set[T]) Has

func (s *Set[T]) Has(x T) bool

func (*Set[T]) IsEmpty

func (s *Set[T]) IsEmpty() bool

func (*Set[T]) Remove

func (s *Set[T]) Remove(x T)

func (*Set[T]) Size

func (s *Set[T]) Size() int

type Stack

type Stack[T any] struct {
	Length int
	Data   []T
}

func NewStack

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

func (*Stack[T]) IsEmpty

func (s *Stack[T]) IsEmpty() bool

func (*Stack[T]) Peek

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

func (*Stack[T]) Pop

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

func (*Stack[T]) Push

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

func (*Stack[T]) Size

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