Documentation
¶
Overview ¶
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 ¶
- type Iterator
- func (iterator *Iterator) Begin()
- func (iterator *Iterator) End()
- func (iterator *Iterator) First() bool
- func (iterator *Iterator) HasNext() bool
- func (iterator *Iterator) HasPrev() bool
- func (iterator Iterator) IsBegin() bool
- func (iterator Iterator) IsEnd() bool
- func (iterator Iterator) Key() interface{}
- func (iterator *Iterator) Last() bool
- func (iterator *Iterator) Next() bool
- func (iterator *Iterator) Prev() bool
- func (iterator Iterator) Value() interface{}
- type Node
- type Tree
- func (tree *Tree) Begin() Iterator
- func (tree *Tree) Ceiling(key interface{}) (ceiling *Node, found bool)
- func (tree *Tree) Clear()
- func (tree *Tree) CopyFrom(rbt *Tree)
- func (tree *Tree) Empty() bool
- func (tree *Tree) End() Iterator
- func (tree *Tree) Floor(key interface{}) (floor *Node, found bool)
- func (tree *Tree) Get(key interface{}) Iterator
- func (tree *Tree) Insert(key interface{}, value interface{}) Iterator
- func (tree *Tree) Iterator() Iterator
- func (tree *Tree) Keys() []interface{}
- func (tree *Tree) Left() *Node
- func (tree *Tree) LowerBound(key interface{}) Iterator
- func (tree *Tree) New(comparator func(a, b interface{}) int)
- func (tree *Tree) Put(key interface{}, value interface{})
- func (tree *Tree) Remove(key interface{})
- func (tree *Tree) RemoveOne(itr Iterator)
- func (tree *Tree) Right() *Node
- func (tree *Tree) Size() int
- func (tree *Tree) String() string
- func (tree *Tree) UpperBound(key interface{}) Iterator
- func (tree *Tree) Values() []interface{}
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Iterator ¶
type Iterator struct {
// contains filtered or unexported fields
}
Iterator holding the iterator's state
func (*Iterator) Begin ¶
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 ¶
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 ¶
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 ¶
func (iterator Iterator) Key() interface{}
Key returns the current element's key. Does not modify the state of the iterator.
func (*Iterator) Last ¶
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 ¶
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.
type Node ¶
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
type Tree ¶
type Tree struct {
Root *Node
Comparator func(a, b interface{}) int
// contains filtered or unexported fields
}
Tree holds elements of the red-black tree
func NewWithIntComparator ¶
NewWithIntComparator instantiates a red-black tree with the IntComparator, i.e. keys are of type int.
func NewWithStringComparator ¶
NewWithStringComparator instantiates a red-black tree with the StringComparator, i.e. keys are of type string.
func (*Tree) Ceiling ¶
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) Floor ¶
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) Get ¶
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) LowerBound ¶
LowerBound returns an iterator pointing to the first element that is not less than the given key. Complexity: O(log N).
func (*Tree) Put ¶
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 ¶
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) UpperBound ¶
UpperBound returns an iterator pointing to the first element that is greater than the given key. Complexity: O(log N).
Source Files