gods: github.com/emirpasic/gods/trees/avltree Index | Files

package avltree

import "github.com/emirpasic/gods/trees/avltree"

Package avltree implements an AVL balanced binary tree.

Structure is not thread safe.

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

Index

Package Files

avltree.go iterator.go serialization.go

type Iterator Uses

type Iterator struct {
    // contains filtered or unexported fields
}

Iterator holding the iterator's state

func (*Iterator) Begin Uses

func (iterator *Iterator) Begin()

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

func (*Iterator) End Uses

func (iterator *Iterator) End()

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

func (*Iterator) First Uses

func (iterator *Iterator) 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) Key Uses

func (iterator *Iterator) Key() interface{}

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

func (*Iterator) Last Uses

func (iterator *Iterator) 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) Next Uses

func (iterator *Iterator) 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) Prev Uses

func (iterator *Iterator) 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) Value Uses

func (iterator *Iterator) Value() interface{}

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

type Node Uses

type Node struct {
    Key      interface{}
    Value    interface{}
    Parent   *Node    // Parent node
    Children [2]*Node // Children nodes
    // contains filtered or unexported fields
}

Node is a single element within the tree

func (*Node) Next Uses

func (n *Node) Next() *Node

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

func (*Node) Prev Uses

func (n *Node) Prev() *Node

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

func (*Node) String Uses

func (n *Node) String() string

type Tree Uses

type Tree struct {
    Root       *Node            // Root node
    Comparator utils.Comparator // Key comparator
    // contains filtered or unexported fields
}

Tree holds elements of the AVL tree.

func NewWith Uses

func NewWith(comparator utils.Comparator) *Tree

NewWith instantiates an AVL tree with the custom comparator.

func NewWithIntComparator Uses

func NewWithIntComparator() *Tree

NewWithIntComparator instantiates an AVL tree with the IntComparator, i.e. keys are of type int.

func NewWithStringComparator Uses

func NewWithStringComparator() *Tree

NewWithStringComparator instantiates an AVL tree with the StringComparator, i.e. keys are of type string.

func (*Tree) Ceiling Uses

func (t *Tree) Ceiling(key interface{}) (floor *Node, 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) Clear Uses

func (t *Tree) Clear()

Clear removes all nodes from the tree.

func (*Tree) Empty Uses

func (t *Tree) Empty() bool

Empty returns true if tree does not contain any nodes.

func (*Tree) Floor Uses

func (t *Tree) Floor(key interface{}) (floor *Node, found bool)

Floor Finds floor node of the input key, return the floor node or nil if no ceiling 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) FromJSON Uses

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

FromJSON populates the tree from the input JSON representation.

func (*Tree) Get Uses

func (t *Tree) Get(key interface{}) (value interface{}, 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) Iterator Uses

func (tree *Tree) Iterator() containers.ReverseIteratorWithKey

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

func (*Tree) Keys Uses

func (t *Tree) Keys() []interface{}

Keys returns all keys in-order

func (*Tree) Left Uses

func (t *Tree) Left() *Node

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

func (*Tree) Put Uses

func (t *Tree) Put(key interface{}, value interface{})

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

func (*Tree) Remove Uses

func (t *Tree) Remove(key interface{})

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

func (*Tree) Right Uses

func (t *Tree) Right() *Node

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

func (*Tree) Size Uses

func (t *Tree) Size() int

Size returns the number of elements stored in the tree.

func (*Tree) String Uses

func (t *Tree) String() string

String returns a string representation of container

func (*Tree) ToJSON Uses

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

ToJSON outputs the JSON representation of the tree.

func (*Tree) Values Uses

func (t *Tree) Values() []interface{}

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

Package avltree imports 5 packages (graph) and is imported by 14 packages. Updated 2019-02-15. Refresh now. Tools for package owners.