Documentation
¶
Overview ¶
Package treebidimap implements a bidirectional map backed by two red-black tree.
This structure guarantees that the map will be in both ascending key and value order.
Other than key and value ordering, the goal with this structure is to avoid duplication of elements, which can be significant if contained elements are large.
A bidirectional map, or hash bag, is an associative data structure in which the (key,value) pairs form a one-to-one correspondence. Thus the binary relation is functional in each direction: value can also act as a key to key. A pair (a,b) thus provides a unique coupling between 'a' and 'b' so that 'b' can be found when 'a' is used as a key and 'a' can be found when 'b' is used as a key.
Structure is not thread safe.
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
- 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]) Prev() bool
- func (iterator *Iterator[K, V]) PrevTo(f func(key K, value V) bool) bool
- func (iterator *Iterator[K, V]) Value() V
- type Map
- func (m *Map[K, V]) All(f func(key K, value V) bool) bool
- func (m *Map[K, V]) Any(f func(key K, value V) bool) bool
- func (m *Map[K, V]) Clear()
- func (m *Map[K, V]) Each(f func(key K, value V))
- func (m *Map[K, V]) Empty() bool
- func (m *Map[K, V]) Find(f func(key K, value V) bool) (k K, v V)
- func (m *Map[K, V]) FromJSON(data []byte) error
- func (m *Map[K, V]) Get(key K) (value V, found bool)
- func (m *Map[K, V]) GetKey(value V) (key K, found bool)
- func (m *Map[K, V]) Iterator() *Iterator[K, V]
- func (m *Map[K, V]) Keys() []K
- func (m *Map[K, V]) Map(f func(key1 K, value1 V) (K, V)) *Map[K, V]
- func (m *Map[K, V]) MarshalJSON() ([]byte, error)
- func (m *Map[K, V]) Put(key K, value V)
- func (m *Map[K, V]) Remove(key K)
- func (m *Map[K, V]) Select(f func(key K, value V) bool) *Map[K, V]
- func (m *Map[K, V]) Size() int
- func (m *Map[K, V]) String() string
- func (m *Map[K, V]) ToJSON() ([]byte, error)
- func (m *Map[K, V]) UnmarshalJSON(bytes []byte) error
- func (m *Map[K, V]) Values() []V
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 ¶
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.
func (*Iterator[K, V]) NextTo ¶
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]) Prev ¶
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[K, V]) PrevTo ¶
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.
type Map ¶
type Map[K, V comparable] struct { // contains filtered or unexported fields }
Map holds the elements in two red-black trees.
func NewWith ¶
func NewWith[K, V comparable](keyComparator utils.Comparator[K], valueComparator utils.Comparator[V]) *Map[K, V]
NewWith instantiates a bidirectional map.
func (*Map[K, V]) All ¶
All passes each element of the container to the given function and returns true if the function returns true for all elements.
func (*Map[K, V]) Any ¶
Any passes each element of the container to the given function and returns true if the function ever returns true for any element.
func (*Map[K, V]) Each ¶
func (m *Map[K, V]) Each(f func(key K, value V))
Each calls the given function once for each element, passing that element's key and value.
func (*Map[K, V]) Find ¶
Find passes each element of the container to the given function and returns the first (key,value) for which the function is true or nil,nil otherwise if no element matches the criteria.
func (*Map[K, V]) Get ¶
Get searches the element in the map by key and returns its value or nil if key is not found in map. Second return parameter is true if key was found, otherwise false.
func (*Map[K, V]) GetKey ¶
GetKey searches the element in the map by value and returns its key or nil if value is not found in map. Second return parameter is true if value was found, otherwise false.
func (*Map[K, V]) Iterator ¶
Iterator returns a stateful iterator whose elements are key/value pairs.
func (*Map[K, V]) Map ¶
Map invokes the given function once for each element and returns a container containing the values returned by the given function as key/value pairs.
func (*Map[K, V]) MarshalJSON ¶
MarshalJSON @implements json.Marshaler
func (*Map[K, V]) Remove ¶
func (m *Map[K, V]) Remove(key K)
Remove removes the element from the map by key.
func (*Map[K, V]) Select ¶
Select returns a new container containing all elements for which the given function returns a true value.
func (*Map[K, V]) UnmarshalJSON ¶
UnmarshalJSON @implements json.Unmarshaler
Source Files