gollection

README

Gollection

Gollection provides Generic Data Structures.

Requirement

GO 1.21 or higher

Support Structure

• Set
• Queue
• Stack
• Priority Queue
• B Tree
• AVL Tree

sync is implemented for thread safe

• Sync Map
• Sync Set
• Sync Queue
• Sync Stack
• Sync Priority Queue
• Sync B Tree
• Sync AVL Tree

Import

import "github.com/yanun0323/gollection/v2"

Overview

• Set

  • Contain
  • Len
  • Insert
  • Remove
  • ToSlice

• Queue

  • Len
  • Dequeue
  • Enqueue
  • Peek
  • ToSlice

• Stack

  • Len
  • Peek
  • Pop
  • Push
  • ToSlice

• Priority Queue

  • Len
  • Dequeue
  • Enqueue
  • Peek
  • ToSlice

• B Tree

  • Contain
  • Len
  • Insert
  • Remove
  • Search
  • Max
  • Min
  • RemoveMax
  • RemoveMin
  • Ascend
  • Descend

• AVL Tree

  • Contain
  • Len
  • Insert
  • Remove
  • Search
  • Max
  • Min
  • RemoveMax
  • RemoveMin
  • Ascend
  • Descend

License

© Yanun, 2022 ~ now

Released under the MIT License

Documentation

Index

• type AvlTree
  • func NewAvlTree[K Orderable, V any]() AvlTree[K, V]
• type BTree
  • func NewBTree[K Orderable, V any]() BTree[K, V]
• type Compare
• type Iter
• type MapIter
• type Orderable
• type PriorityQueue
  • func NewPriorityQueue[T any](score func(T, T) bool) PriorityQueue[T]
• type Queue
  • func NewQueue[T any]() Queue[T]
• type Set
  • func NewSet[T comparable]() Set[T]
• type Stack
  • func NewStack[T any]() Stack[T]
• type SyncAvlTree
  • func NewSyncAvlTree[K Orderable, V any]() SyncAvlTree[K, V]
• type SyncBTree
  • func NewSyncBTree[K Orderable, V any]() SyncBTree[K, V]
• type SyncMap
  • func NewSyncMap[K comparable, V any]() SyncMap[K, V]
• type SyncPriorityQueue
  • func NewSyncPriorityQueue[T any](score func(T, T) bool) SyncPriorityQueue[T]
• type SyncQueue
  • func NewSyncQueue[T any]() SyncQueue[T]
• type SyncSet
  • func NewSyncSet[T comparable]() SyncSet[T]
• type SyncStack
  • func NewSyncStack[T any]() SyncStack[T]
• type TreeIter

Types

type AvlTree

type AvlTree[K Orderable, V any] interface {
	Contain(key K) bool
	Len() int
	Insert(key K, value V)
	Remove(key K) (V, bool)
	Search(key K) (V, bool)
	Max() (K, V, bool)
	Min() (K, V, bool)
	RemoveMax() (K, V, bool)
	RemoveMin() (K, V, bool)
	Ascend(fn TreeIter[K, V])
	Descend(fn TreeIter[K, V])
}

func NewAvlTree

func NewAvlTree[K Orderable, V any]() AvlTree[K, V]

type BTree

type BTree[K Orderable, V any] interface {
	Contain(key K) bool
	Len() int
	Insert(key K, value V)
	Remove(key K) (V, bool)
	Search(key K) (V, bool)
	Max() (K, V, bool)
	Min() (K, V, bool)
	RemoveMax() (K, V, bool)
	RemoveMin() (K, V, bool)
	Ascend(fn TreeIter[K, V])
	Descend(fn TreeIter[K, V])
}

func NewBTree

func NewBTree[K Orderable, V any]() BTree[K, V]

type Compare

type Compare[T any] func(T, T) bool

type Iter

type Iter[T any] func(T) bool

type MapIter

type MapIter[K comparable, V any] func(K, V) bool

type Orderable

type Orderable cmp.Ordered

type PriorityQueue

type PriorityQueue[T any] interface {
	Len() int
	Dequeue() T
	Enqueue(...T)
	Peek() T
	ToSlice() []T
}

func NewPriorityQueue

func NewPriorityQueue[T any](score func(T, T) bool) PriorityQueue[T]

type Queue

type Queue[T any] interface {
	Len() int
	Dequeue() T
	Enqueue(...T)
	Peek() T
	ToSlice() []T
}

func NewQueue

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

type Set

type Set[T comparable] interface {
	Contain(T) bool
	Len() int
	Insert(...T)
	Remove(...T)
	ToSlice() []T
}

func NewSet

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

type Stack

type Stack[T any] interface {
	Len() int
	Peek() T
	Pop() T
	Push(...T)
	ToSlice() []T
}

func NewStack

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

type SyncAvlTree

type SyncAvlTree[K Orderable, V any] AvlTree[K, V]

func NewSyncAvlTree

func NewSyncAvlTree[K Orderable, V any]() SyncAvlTree[K, V]

type SyncBTree

type SyncBTree[K Orderable, V any] BTree[K, V]

func NewSyncBTree

func NewSyncBTree[K Orderable, V any]() SyncBTree[K, V]

type SyncMap

type SyncMap[K comparable, V any] interface {
	Clear()
	Clone() map[K]V
	Iter(fn func(key K, value V) bool)
	Len() int
	Load(key K) (V, bool)
	LoadAndSet(key K, fn func(value V) V)
	Store(key K, value V)
	Stores(fn func(store func(key K, value V)))
	Delete(key K)
}

func NewSyncMap

func NewSyncMap[K comparable, V any]() SyncMap[K, V]

type SyncPriorityQueue

type SyncPriorityQueue[T any] PriorityQueue[T]

func NewSyncPriorityQueue

func NewSyncPriorityQueue[T any](score func(T, T) bool) SyncPriorityQueue[T]

type SyncQueue

type SyncQueue[T any] Queue[T]

func NewSyncQueue

func NewSyncQueue[T any]() SyncQueue[T]

type SyncSet

type SyncSet[T comparable] Set[T]

func NewSyncSet

func NewSyncSet[T comparable]() SyncSet[T]

type SyncStack

type SyncStack[T any] Stack[T]

func NewSyncStack

func NewSyncStack[T any]() SyncStack[T]

type TreeIter

type TreeIter[K Orderable, V any] func(K, V) bool