Documentation
¶
Overview ¶
Package hashmap implements a map backed by a hash table.
Elements are unordered in the map.
Structure is not thread safe.
Index ¶
- type Map
- func New[TKey comparable, TValue any]() *Map[TKey, TValue]
- func NewFromIterator[TKey comparable, TValue any](begin ds.ReadCompForIndexMapIterator[TKey, TValue]) *Map[TKey, TValue]
- func NewFromIterators[TKey comparable, TValue any](begin ds.ReadCompForIndexMapIterator[TKey, TValue], ...) *Map[TKey, TValue]
- func NewFromMap[TKey comparable, TValue any](map_ map[TKey]TValue) *Map[TKey, TValue]
- func (m *Map[TKey, TValue]) Clear()
- func (m *Map[TKey, TValue]) FromJSON(data []byte) error
- func (m *Map[TKey, TValue]) Get(key TKey) (value TValue, found bool)
- func (m *Map[TKey, TValue]) GetKeys() []TKey
- func (map_ *Map[TKey, TValue]) GetMap() map[TKey]TValue
- func (m *Map[TKey, TValue]) GetValues() []TValue
- func (m *Map[TKey, TValue]) IsEmpty() bool
- func (m *Map[TKey, TValue]) MarshalJSON() ([]byte, error)
- func (m *Map[TKey, TValue]) MergeWith(other *maps.Map[TKey, TValue]) bool
- func (m *Map[TKey, TValue]) MergeWithSafe(other *maps.Map[TKey, TValue], overwriteOriginal bool)
- func (m *Map[TKey, TValue]) NewOrderedIterator(position int, comparator utils.Comparator[TKey]) *OrderedIterator[TKey, TValue]
- func (m *Map[TKey, TValue]) OrderedBegin(comparator utils.Comparator[TKey]) ds.ReadWriteOrdCompBidRandCollMapIterator[TKey, TValue]
- func (m *Map[TKey, TValue]) OrderedEnd(comparator utils.Comparator[TKey]) ds.ReadWriteOrdCompBidRandCollMapIterator[TKey, TValue]
- func (m *Map[TKey, TValue]) OrderedFirst(comparator utils.Comparator[TKey]) ds.ReadWriteOrdCompBidRandCollMapIterator[TKey, TValue]
- func (m *Map[TKey, TValue]) OrderedLast(comparator utils.Comparator[TKey]) ds.ReadWriteOrdCompBidRandCollMapIterator[TKey, TValue]
- func (m *Map[TKey, TValue]) Put(key TKey, value TValue)
- func (m *Map[TKey, TValue]) Remove(comparator utils.Comparator[TKey], key TKey)
- func (m *Map[TKey, TValue]) Size() int
- func (m *Map[TKey, TValue]) ToJSON() ([]byte, error)
- func (m *Map[TKey, TValue]) ToString() string
- func (m *Map[TKey, TValue]) UnmarshalJSON(bytes []byte) error
- type OrderedIterator
- func (it *OrderedIterator[TKey, TValue]) DistanceTo(other ds.OrderedIterator) int
- func (it *OrderedIterator[TKey, TValue]) Get() (value TValue, found bool)
- func (it *OrderedIterator[TKey, TValue]) GetAt(i int) (value TValue, found bool)
- func (it *OrderedIterator[TKey, TValue]) GetAtKey(i TKey) (value TValue, found bool)
- func (it *OrderedIterator[TKey, TValue]) GetKey() (key TKey, found bool)
- func (it *OrderedIterator[TKey, TValue]) Index() (index int, found bool)
- func (it *OrderedIterator[TKey, TValue]) IsAfter(other ds.OrderedIterator) bool
- func (it *OrderedIterator[TKey, TValue]) IsBefore(other ds.OrderedIterator) bool
- func (it *OrderedIterator[TKey, TValue]) IsBegin() bool
- func (it *OrderedIterator[TKey, TValue]) IsEnd() bool
- func (it *OrderedIterator[TKey, TValue]) IsEqual(other ds.ComparableIterator) bool
- func (it *OrderedIterator[TKey, TValue]) IsFirst() bool
- func (it *OrderedIterator[TKey, TValue]) IsLast() bool
- func (it *OrderedIterator[TKey, TValue]) IsValid() bool
- func (it *OrderedIterator[TKey, TValue]) MoveBy(n int) bool
- func (it *OrderedIterator[TKey, TValue]) MoveTo(n int) bool
- func (it *OrderedIterator[TKey, TValue]) MoveToKey(k TKey) bool
- func (it *OrderedIterator[TKey, TValue]) Next() bool
- func (it *OrderedIterator[TKey, TValue]) NextN(i int) bool
- func (it *OrderedIterator[TKey, TValue]) Previous() bool
- func (it *OrderedIterator[TKey, TValue]) PreviousN(n int) bool
- func (it *OrderedIterator[TKey, TValue]) Set(value TValue) bool
- func (it *OrderedIterator[TKey, TValue]) SetAt(i int, value TValue) bool
- func (it *OrderedIterator[TKey, TValue]) SetAtKey(i TKey, value TValue) bool
- func (it *OrderedIterator[TKey, TValue]) Size() int
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Map ¶
type Map[TKey comparable, TValue any] struct { // contains filtered or unexported fields }
Map holds the elements in go's native map.
func NewFromIterator ¶ added in v0.6.0
func NewFromIterator[TKey comparable, TValue any](begin ds.ReadCompForIndexMapIterator[TKey, TValue]) *Map[TKey, TValue]
NewFromIterator instantiates a new list containing the elements provided by the passed iterator.
func NewFromIterators ¶ added in v0.6.0
func NewFromIterators[TKey comparable, TValue any](begin ds.ReadCompForIndexMapIterator[TKey, TValue], end ds.CompIndexIterator[TKey]) *Map[TKey, TValue]
NewFromIterators instantiates a new list containing the elements provided by first, until it is equal to end. end is a sentinel and not included.
func NewFromMap ¶ added in v0.4.0
func NewFromMap[TKey comparable, TValue any](map_ map[TKey]TValue) *Map[TKey, TValue]
NewFromMap instantiates a new map containing the provided map.
func (*Map[TKey, TValue]) Clear ¶
func (m *Map[TKey, TValue]) Clear()
Clear removes all elements from the map.
func (*Map[TKey, TValue]) 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[TKey, TValue]) GetKeys ¶ added in v0.4.0
func (m *Map[TKey, TValue]) GetKeys() []TKey
GetKeys returns all keys (random order).
func (*Map[TKey, TValue]) GetMap ¶ added in v0.4.0
func (map_ *Map[TKey, TValue]) GetMap() map[TKey]TValue
GetMap returns the underlying map.
func (*Map[TKey, TValue]) GetValues ¶ added in v0.3.0
func (m *Map[TKey, TValue]) GetValues() []TValue
Values returns all values (random order).
func (*Map[TKey, TValue]) IsEmpty ¶ added in v0.3.0
Empty returns true if map does not contain any elements.
func (*Map[TKey, TValue]) MarshalJSON ¶
MarshalJSON @implements json.Marshaler
func (*Map[TKey, TValue]) MergeWithSafe ¶ added in v0.3.0
func (*Map[TKey, TValue]) NewOrderedIterator ¶ added in v0.5.0
func (m *Map[TKey, TValue]) NewOrderedIterator(position int, comparator utils.Comparator[TKey]) *OrderedIterator[TKey, TValue]
func (*Map[TKey, TValue]) OrderedBegin ¶ added in v0.5.0
func (m *Map[TKey, TValue]) OrderedBegin(comparator utils.Comparator[TKey]) ds.ReadWriteOrdCompBidRandCollMapIterator[TKey, TValue]
func (*Map[TKey, TValue]) OrderedEnd ¶ added in v0.5.0
func (m *Map[TKey, TValue]) OrderedEnd(comparator utils.Comparator[TKey]) ds.ReadWriteOrdCompBidRandCollMapIterator[TKey, TValue]
OrderedEnd returns an initialized,reversed iterator, which points to one element afrer it's last. Unless Previous() is called, the iterator is in an invalid state.
func (*Map[TKey, TValue]) OrderedFirst ¶ added in v0.5.0
func (m *Map[TKey, TValue]) OrderedFirst(comparator utils.Comparator[TKey]) ds.ReadWriteOrdCompBidRandCollMapIterator[TKey, TValue]
func (*Map[TKey, TValue]) OrderedLast ¶ added in v0.5.0
func (m *Map[TKey, TValue]) OrderedLast(comparator utils.Comparator[TKey]) ds.ReadWriteOrdCompBidRandCollMapIterator[TKey, TValue]
func (*Map[TKey, TValue]) Put ¶
func (m *Map[TKey, TValue]) Put(key TKey, value TValue)
Put inserts element into the map.
func (*Map[TKey, TValue]) Remove ¶
func (m *Map[TKey, TValue]) Remove(comparator utils.Comparator[TKey], key TKey)
Remove removes the element from the map by key.
func (*Map[TKey, TValue]) ToString ¶ added in v0.3.0
String returns a string representation of container.
func (*Map[TKey, TValue]) UnmarshalJSON ¶
UnmarshalJSON @implements json.Unmarshaler
type OrderedIterator ¶ added in v0.5.0
type OrderedIterator[TKey comparable, TValue any] struct { // contains filtered or unexported fields }
func (*OrderedIterator[TKey, TValue]) DistanceTo ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) DistanceTo(other ds.OrderedIterator) int
func (*OrderedIterator[TKey, TValue]) Get ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) Get() (value TValue, found bool)
func (*OrderedIterator[TKey, TValue]) GetAt ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) GetAt(i int) (value TValue, found bool)
func (*OrderedIterator[TKey, TValue]) GetAtKey ¶ added in v0.17.0
func (it *OrderedIterator[TKey, TValue]) GetAtKey(i TKey) (value TValue, found bool)
func (*OrderedIterator[TKey, TValue]) GetKey ¶ added in v0.17.0
func (it *OrderedIterator[TKey, TValue]) GetKey() (key TKey, found bool)
func (*OrderedIterator[TKey, TValue]) Index ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) Index() (index int, found bool)
func (*OrderedIterator[TKey, TValue]) IsAfter ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) IsAfter(other ds.OrderedIterator) bool
func (*OrderedIterator[TKey, TValue]) IsBefore ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) IsBefore(other ds.OrderedIterator) bool
func (*OrderedIterator[TKey, TValue]) IsBegin ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) IsBegin() bool
func (*OrderedIterator[TKey, TValue]) IsEnd ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) IsEnd() bool
func (*OrderedIterator[TKey, TValue]) IsEqual ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) IsEqual(other ds.ComparableIterator) bool
func (*OrderedIterator[TKey, TValue]) IsFirst ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) IsFirst() bool
func (*OrderedIterator[TKey, TValue]) IsLast ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) IsLast() bool
func (*OrderedIterator[TKey, TValue]) IsValid ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) IsValid() bool
func (*OrderedIterator[TKey, TValue]) MoveBy ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) MoveBy(n int) bool
func (*OrderedIterator[TKey, TValue]) MoveTo ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) MoveTo(n int) bool
func (*OrderedIterator[TKey, TValue]) MoveToKey ¶ added in v0.17.0
func (it *OrderedIterator[TKey, TValue]) MoveToKey(k TKey) bool
func (*OrderedIterator[TKey, TValue]) Next ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) Next() bool
func (*OrderedIterator[TKey, TValue]) NextN ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) NextN(i int) bool
func (*OrderedIterator[TKey, TValue]) Previous ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) Previous() bool
func (*OrderedIterator[TKey, TValue]) PreviousN ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) PreviousN(n int) bool
func (*OrderedIterator[TKey, TValue]) Set ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) Set(value TValue) bool
func (*OrderedIterator[TKey, TValue]) SetAt ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) SetAt(i int, value TValue) bool
func (*OrderedIterator[TKey, TValue]) SetAtKey ¶ added in v0.17.0
func (it *OrderedIterator[TKey, TValue]) SetAtKey(i TKey, value TValue) bool
func (*OrderedIterator[TKey, TValue]) Size ¶ added in v0.5.0
func (it *OrderedIterator[TKey, TValue]) Size() int