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

package redblacktree

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

Package redblacktree implements a red-black tree.

Used by TreeSet and TreeMap.

Structure is not thread safe.

References: http://en.wikipedia.org/wiki/Red%E2%80%93black_tree

Index

Package Files

iterator.go redblacktree.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 previous element and returns true if there was a previous element in the container. If Prev() returns true, then previous element's key and value can be retrieved by Key() and Value(). 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{}

    Left   *Node
    Right  *Node
    Parent *Node
    // contains filtered or unexported fields
}

Node is a single element within the tree

func (*Node) String Uses

func (node *Node) String() string

type Tree Uses

type Tree struct {
    Root *Node

    Comparator utils.Comparator
    // contains filtered or unexported fields
}

Tree holds elements of the red-black tree

func NewWith Uses

func NewWith(comparator utils.Comparator) *Tree

NewWith instantiates a red-black tree with the custom comparator.

func NewWithIntComparator Uses

func NewWithIntComparator() *Tree

NewWithIntComparator instantiates a red-black tree with the IntComparator, i.e. keys are of type int.

func NewWithStringComparator Uses

func NewWithStringComparator() *Tree

NewWithStringComparator instantiates a red-black tree with the StringComparator, i.e. keys are of type string.

func (*Tree) Ceiling Uses

func (tree *Tree) Ceiling(key interface{}) (ceiling *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 are smaller than the given node.

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

func (*Tree) Clear Uses

func (tree *Tree) Clear()

Clear removes all nodes from the tree.

func (*Tree) Empty Uses

func (tree *Tree) Empty() bool

Empty returns true if tree does not contain any nodes

func (*Tree) Floor Uses

func (tree *Tree) Floor(key interface{}) (floor *Node, 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 are 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 (tree *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() Iterator

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

func (*Tree) Keys Uses

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

Keys returns all keys in-order

func (*Tree) Left Uses

func (tree *Tree) Left() *Node

Left returns the left-most (min) node or nil if tree is empty.

func (*Tree) Put Uses

func (tree *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 (tree *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 (tree *Tree) Right() *Node

Right returns the right-most (max) node or nil if tree is empty.

func (*Tree) Size Uses

func (tree *Tree) Size() int

Size returns number of nodes in the tree.

func (*Tree) String Uses

func (tree *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 (tree *Tree) Values() []interface{}

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

Package redblacktree imports 5 packages (graph) and is imported by 58 packages. Updated 2018-09-24. Refresh now. Tools for package owners.