Retracted: Version contains broken tests
README
¶
BTree
Good performed algorithm in case of searching data inside. Thead-unsafe implementation.
Documentation
¶
Index ¶
- Constants
- Variables
- type Entry
- 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
- func (iterator *Iterator[K, V]) Last() bool
- func (iterator *Iterator[K, V]) Next() bool
- func (iterator *Iterator[K, V]) Prev() bool
- func (iterator *Iterator[K, V]) Value() any
- type Node
- type Tree
- func (tree *Tree[K, V]) Clear()
- func (tree *Tree[K, V]) Empty() bool
- func (tree *Tree[K, V]) Get(key K) (value V, found bool)
- func (tree *Tree[K, V]) Height() int
- 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]) LeftKey() any
- func (tree *Tree[K, V]) LeftValue() any
- 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]) RightKey() any
- func (tree *Tree[K, V]) RightValue() any
- func (tree *Tree[K, V]) Size() int
- func (tree *Tree[K, V]) String() string
- func (tree *Tree[K, V]) Values() []any
Constants ¶
const (
MinOrder = 3
)
Variables ¶
var (
ErrInvalidOrder = errors.New("invalid order, should be at least 3")
)
All kind of errors
Functions ¶
This section is empty.
Types ¶
type Entry ¶
type Entry[K comparable, V any] struct { Key K Value V }
Entry represents the key-value pair contained within nodes
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 ¶
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
Key returns the current element's key. Does not modify the state of the iterator.
func (*Iterator[K, V]) 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[K, V]) 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[K comparable, V any] struct { Parent *Node[K, V] Entries []*Entry[K, V] // Contained keys in node Children []*Node[K, V] // Children nodes }
Node is a single element within the tree
type Tree ¶
type Tree[K comparable, V any] struct { Root *Node[K, V] // Root node Comparator comparator.Comparator // Key comparator // contains filtered or unexported fields }
Tree holds elements of the B-tree
func NewWith ¶
func NewWith[K comparable, V any](order int, comparator comparator.Comparator) (*Tree[K, V], error)
NewWith instantiates a B-tree with the order (maximum number of children) and a custom key comparator.
func NewWithIntComparator ¶
NewWithIntComparator instantiates a B-tree with the order (maximum number of children) and the IntComparator, i.e. keys are of type int.
func NewWithStringComparator ¶
NewWithStringComparator instantiates a B-tree with the order (maximum number of children) and the StringComparator, i.e. keys are of type string.
func (*Tree[K, V]) 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[K, V]) Iterator ¶
Iterator returns a stateful iterator whose elements are key/value pairs.
func (*Tree[K, V]) Put ¶
func (tree *Tree[K, V]) Put(key K, value V)
Put inserts key-value pair node into the tree. If key already exists, then its value is updated with the new value. 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]) RightValue ¶
RightValue returns the right-most value or nil if tree is empty.
Source Files