avltree

Documentation

Overview

Package avltree implements an AVL balanced binary tree.

Structure is not thread safe.

References: https://en.wikipedia.org/wiki/AVL_tree

Index

• type Iterator
  • func (iterator *Iterator[K, V]) Begin()
  • func (iterator *Iterator[K, V]) End()
  • func (iterator *Iterator[K, V]) First() bool
  • func (iterator *Iterator[K, V]) Key() (k K)
  • func (iterator *Iterator[K, V]) Last() bool
  • func (iterator *Iterator[K, V]) Next() bool
  • func (iterator *Iterator[K, V]) NextTo(f func(key K, value V) bool) bool
  • func (iterator *Iterator[K, V]) Node() *Node[K, V]
  • func (iterator *Iterator[K, V]) Prev() bool
  • func (iterator *Iterator[K, V]) PrevTo(f func(key K, value V) bool) bool
  • func (iterator *Iterator[K, V]) Value() (v V)
• type Node
  • func (n *Node[K, V]) Next() *Node[K, V]
  • func (n *Node[K, V]) Prev() *Node[K, V]
  • func (n *Node[K, V]) Size() int
  • func (n *Node[K, V]) String() string
• type Tree
  • func New[K cmp.Ordered, V any]() *Tree[K, V]
  • func NewWith[K comparable, V any](comparator utils.Comparator[K]) *Tree[K, V]
  • func (tree *Tree[K, V]) Ceiling(key K) (floor *Node[K, V], found bool)
  • func (tree *Tree[K, V]) Clear()
  • func (tree *Tree[K, V]) Empty() bool
  • func (tree *Tree[K, V]) Floor(key K) (floor *Node[K, V], found bool)
  • func (tree *Tree[K, V]) FromJSON(data []byte) error
  • func (tree *Tree[K, V]) Get(key K) (value V, found bool)
  • func (tree *Tree[K, V]) GetNode(key K) *Node[K, V]
  • func (tree *Tree[K, V]) Iterator() *Iterator[K, V]
  • func (tree *Tree[K, V]) Keys() []K
  • func (tree *Tree[K, V]) Left() *Node[K, V]
  • func (tree *Tree[K, V]) MarshalJSON() ([]byte, error)
  • func (tree *Tree[K, V]) Put(key K, value V)
  • func (tree *Tree[K, V]) Remove(key K)
  • func (tree *Tree[K, V]) Right() *Node[K, V]
  • func (tree *Tree[K, V]) Size() int
  • func (tree *Tree[K, V]) String() string
  • func (tree *Tree[K, V]) ToJSON() ([]byte, error)
  • func (tree *Tree[K, V]) UnmarshalJSON(bytes []byte) error
  • func (tree *Tree[K, V]) Values() []V

Types

type Iterator

type Iterator[K comparable, V any] struct {
	// contains filtered or unexported fields
}

Iterator holding the iterator's state

func (*Iterator[K, V]) Begin

func (iterator *Iterator[K, V]) Begin()

Begin resets the iterator to its initial state (one-before-first) Call Next() to fetch the first element if any.

func (*Iterator[K, V]) End

func (iterator *Iterator[K, V]) End()

End moves the iterator past the last element (one-past-the-end). Call Prev() to fetch the last element if any.

func (*Iterator[K, V]) First

func (iterator *Iterator[K, V]) First() bool

First moves the iterator to the first element and returns true if there was a first element in the container. If First() returns true, then first element's key and value can be retrieved by Key() and Value(). Modifies the state of the iterator

func (*Iterator[K, V]) Key

func (iterator *Iterator[K, V]) Key() (k K)

Key returns the current element's key. Does not modify the state of the iterator.

func (*Iterator[K, V]) Last

func (iterator *Iterator[K, V]) Last() bool

Last moves the iterator to the last element and returns true if there was a last element in the container. If Last() returns true, then last element's key and value can be retrieved by Key() and Value(). Modifies the state of the iterator.

func (*Iterator[K, V]) Next

func (iterator *Iterator[K, V]) Next() bool

Next moves the iterator to the next element and returns true if there was a next element in the container. If Next() returns true, then next element's key and value can be retrieved by Key() and Value(). If Next() was called for the first time, then it will point the iterator to the first element if it exists. Modifies the state of the iterator.

func (*Iterator[K, V]) NextTo

func (iterator *Iterator[K, V]) NextTo(f func(key K, value V) bool) bool

NextTo moves the iterator to the next element from current position that satisfies the condition given by the passed function, and returns true if there was a next element in the container. If NextTo() returns true, then next element's key and value can be retrieved by Key() and Value(). Modifies the state of the iterator.

func (*Iterator[K, V]) Node

func (iterator *Iterator[K, V]) Node() *Node[K, V]

Node returns the current element's node. Does not modify the state of the iterator.

func (*Iterator[K, V]) Prev

func (iterator *Iterator[K, V]) Prev() bool

Prev moves the iterator to the next element and returns true if there was a previous element in the container. If Prev() returns true, then next element's key and value can be retrieved by Key() and Value(). If Prev() was called for the first time, then it will point the iterator to the first element if it exists. Modifies the state of the iterator.

func (*Iterator[K, V]) PrevTo

func (iterator *Iterator[K, V]) PrevTo(f func(key K, value V) bool) bool

PrevTo moves the iterator to the previous element from current position that satisfies the condition given by the passed function, and returns true if there was a next element in the container. If PrevTo() returns true, then next element's key and value can be retrieved by Key() and Value(). Modifies the state of the iterator.

func (*Iterator[K, V]) Value

func (iterator *Iterator[K, V]) Value() (v V)

Value returns the current element's value. Does not modify the state of the iterator.

type Node

type Node[K comparable, V any] struct {
	Key      K
	Value    V
	Parent   *Node[K, V]    // Parent node
	Children [2]*Node[K, V] // Children nodes
	// contains filtered or unexported fields
}

Node is a single element within the tree

func (*Node[K, V]) Next

func (n *Node[K, V]) Next() *Node[K, V]

Next returns the next element in an inorder walk of the AVL tree.

func (*Node[K, V]) Prev

func (n *Node[K, V]) Prev() *Node[K, V]

Prev returns the previous element in an inorder walk of the AVL tree.

func (*Node[K, V]) Size

func (n *Node[K, V]) Size() int

Size returns the number of elements stored in the subtree. Computed dynamically on each call, i.e. the subtree is traversed to count the number of the nodes.

func (*Node[K, V]) String

func (n *Node[K, V]) String() string

type Tree

type Tree[K comparable, V any] struct {
	Root       *Node[K, V]         // Root node
	Comparator utils.Comparator[K] // Key comparator
	// contains filtered or unexported fields
}

Tree holds elements of the AVL tree.

func New

func New[K cmp.Ordered, V any]() *Tree[K, V]

New instantiates an AVL tree with the built-in comparator for K

func NewWith

func NewWith[K comparable, V any](comparator utils.Comparator[K]) *Tree[K, V]

NewWith instantiates an AVL tree with the custom comparator.

func (*Tree[K, V]) Ceiling

func (tree *Tree[K, V]) Ceiling(key K) (floor *Node[K, V], found bool)

Ceiling finds ceiling node of the input key, return the ceiling node or nil if no ceiling is found. Second return parameter is true if ceiling was found, otherwise false.

Ceiling node is defined as the smallest node that is larger than or equal to the given node. A ceiling node may not be found, either because the tree is empty, or because all nodes in the tree is smaller than the given node.

Key should adhere to the comparator's type assertion, otherwise method panics.

func (*Tree[K, V]) Clear

func (tree *Tree[K, V]) Clear()

Clear removes all nodes from the tree.

func (*Tree[K, V]) Empty

func (tree *Tree[K, V]) Empty() bool

Empty returns true if tree does not contain any nodes.

func (*Tree[K, V]) Floor

func (tree *Tree[K, V]) Floor(key K) (floor *Node[K, V], found bool)

Floor Finds floor node of the input key, return the floor node or nil if no floor is found. Second return parameter is true if floor was found, otherwise false.

Floor node is defined as the largest node that is smaller than or equal to the given node. A floor node may not be found, either because the tree is empty, or because all nodes in the tree is larger than the given node.

Key should adhere to the comparator's type assertion, otherwise method panics.

func (*Tree[K, V]) FromJSON

func (tree *Tree[K, V]) FromJSON(data []byte) error

FromJSON populates the tree from the input JSON representation.

func (*Tree[K, V]) Get

func (tree *Tree[K, V]) Get(key K) (value V, found bool)

Get searches the node in the tree by key and returns its value or nil if key is not found in tree. Second return parameter is true if key was found, otherwise false. Key should adhere to the comparator's type assertion, otherwise method panics.

func (*Tree[K, V]) GetNode

func (tree *Tree[K, V]) GetNode(key K) *Node[K, V]

GetNode searches the node in the tree by key and returns its node or nil if key is not found in tree. Key should adhere to the comparator's type assertion, otherwise method panics.

func (*Tree[K, V]) Iterator

func (tree *Tree[K, V]) Iterator() *Iterator[K, V]

Iterator returns a stateful iterator whose elements are key/value pairs.

func (*Tree[K, V]) Keys

func (tree *Tree[K, V]) Keys() []K

Keys returns all keys in-order

func (*Tree[K, V]) Left

func (tree *Tree[K, V]) Left() *Node[K, V]

Left returns the minimum element of the AVL tree or nil if the tree is empty.

func (*Tree[K, V]) MarshalJSON

func (tree *Tree[K, V]) MarshalJSON() ([]byte, error)

MarshalJSON @implements json.Marshaler

func (*Tree[K, V]) Put

func (tree *Tree[K, V]) Put(key K, value V)

Put inserts node into the tree. Key should adhere to the comparator's type assertion, otherwise method panics.

func (*Tree[K, V]) Remove

func (tree *Tree[K, V]) Remove(key K)

Remove remove the node from the tree by key. Key should adhere to the comparator's type assertion, otherwise method panics.

func (*Tree[K, V]) Right

func (tree *Tree[K, V]) Right() *Node[K, V]

Right returns the maximum element of the AVL tree or nil if the tree is empty.

func (*Tree[K, V]) Size

func (tree *Tree[K, V]) Size() int

Size returns the number of elements stored in the tree.

func (*Tree[K, V]) String

func (tree *Tree[K, V]) String() string

String returns a string representation of container

func (*Tree[K, V]) ToJSON

func (tree *Tree[K, V]) ToJSON() ([]byte, error)

ToJSON outputs the JSON representation of the tree.

func (*Tree[K, V]) UnmarshalJSON

func (tree *Tree[K, V]) UnmarshalJSON(bytes []byte) error

UnmarshalJSON @implements json.Unmarshaler

func (*Tree[K, V]) Values

func (tree *Tree[K, V]) Values() []V

Values returns all values in-order based on the key.