hashmap

package
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 14, 2022 License: BSD-2-Clause, ISC Imports: 5 Imported by: 1

Documentation

Overview

Package hashmap implements a map backed by a hash table.

Elements are unordered in the map.

Structure is not thread safe.

Reference: http://en.wikipedia.org/wiki/Associative_array

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Iterator added in v0.5.0

type Iterator[TKey comparable, TValue any] struct {
	// contains filtered or unexported fields
}

func (*Iterator[TKey, TValue]) Get added in v0.5.0

func (it *Iterator[TKey, TValue]) Get() (value TValue, found bool)

Get implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) GetAt added in v0.5.0

func (it *Iterator[TKey, TValue]) GetAt(i TKey) (value TValue, found bool)

GetAt implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) Index added in v0.5.0

func (it *Iterator[TKey, TValue]) Index() TKey

Index implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) IsBegin added in v0.5.0

func (it *Iterator[TKey, TValue]) IsBegin() bool

IsBegin implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) IsEnd added in v0.5.0

func (it *Iterator[TKey, TValue]) IsEnd() bool

IsEnd implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) IsEqual added in v0.5.0

func (it *Iterator[TKey, TValue]) IsEqual(other ds.ComparableIterator) bool

IsEqual implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) IsFirst added in v0.5.0

func (it *Iterator[TKey, TValue]) IsFirst() bool

IsFirst implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) IsLast added in v0.5.0

func (it *Iterator[TKey, TValue]) IsLast() bool

IsLast implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) IsValid added in v0.5.0

func (it *Iterator[TKey, TValue]) IsValid() bool

IsValid implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) MoveTo added in v0.5.0

func (it *Iterator[TKey, TValue]) MoveTo(i TKey)

MoveTo implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) Next added in v0.5.0

func (it *Iterator[TKey, TValue]) Next()

Next implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) NextN added in v0.5.0

func (it *Iterator[TKey, TValue]) NextN(i int)

NextN implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) Set added in v0.5.0

func (it *Iterator[TKey, TValue]) Set(value TValue) bool

Set implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) SetAt added in v0.5.0

func (it *Iterator[TKey, TValue]) SetAt(i TKey, value TValue) bool

SetAt implements ds.ReadWriteCompForRandCollIterator

func (*Iterator[TKey, TValue]) Size added in v0.5.0

func (it *Iterator[TKey, TValue]) Size() int

Size implements ds.ReadWriteCompForRandCollIterator

type Map

type Map[TKey comparable, TValue any] struct {
	// contains filtered or unexported fields
}

Map holds the elements in go's native map.

func New

func New[TKey comparable, TValue any]() *Map[TKey, TValue]

New instantiates a hash map.

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]) First added in v0.5.0

func (m *Map[TKey, TValue]) First() ds.ReadWriteCompForRandCollIterator[TKey, TValue]

Begin returns an initialized iterator, which points to one element before it's first. Unless Next() is called, the iterator is in an invalid state. First returns an initialized iterator, which points to it's first element.

func (*Map[TKey, TValue]) FromJSON

func (m *Map[TKey, TValue]) FromJSON(data []byte) error

FromJSON populates the map from the input JSON representation.

func (*Map[TKey, TValue]) Get

func (m *Map[TKey, TValue]) Get(key TKey) (value TValue, found bool)

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

func (m *Map[TKey, TValue]) IsEmpty() bool

Empty returns true if map does not contain any elements.

func (*Map[TKey, TValue]) MarshalJSON

func (m *Map[TKey, TValue]) MarshalJSON() ([]byte, error)

MarshalJSON @implements json.Marshaler

func (*Map[TKey, TValue]) MergeWith added in v0.3.0

func (m *Map[TKey, TValue]) MergeWith(other *maps.Map[TKey, TValue]) bool

func (*Map[TKey, TValue]) MergeWithSafe added in v0.3.0

func (m *Map[TKey, TValue]) MergeWithSafe(other *maps.Map[TKey, TValue], overwriteOriginal bool)

func (*Map[TKey, TValue]) NewIterator added in v0.5.0

func (m *Map[TKey, TValue]) NewIterator(m_ *Map[TKey, TValue]) *Iterator[TKey, TValue]

func (*Map[TKey, TValue]) NewOrderedIterator added in v0.5.0

func (m *Map[TKey, TValue]) NewOrderedIterator(m_ *Map[TKey, TValue], 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.ReadWriteUnordCompBidRandCollIterator[TKey, TValue]

OrderedBegin returns an initialized, reversed iterator, which points to one element before it's first. Unless Next() is called, the iterator is in an invalid state.

func (*Map[TKey, TValue]) OrderedEnd added in v0.5.0

func (m *Map[TKey, TValue]) OrderedEnd(comparator utils.Comparator[TKey]) ds.ReadWriteUnordCompBidRandCollIterator[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.ReadWriteUnordCompBidRandCollIterator[TKey, TValue]

OrderedFirst returns an initialized, reversed iterator, which points to it's first element.

func (*Map[TKey, TValue]) OrderedLast added in v0.5.0

func (m *Map[TKey, TValue]) OrderedLast(comparator utils.Comparator[TKey]) ds.ReadWriteUnordCompBidRandCollIterator[TKey, TValue]

OrderedLast returns an initialized, reversed iterator, which points to it's last element.

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]) Size

func (m *Map[TKey, TValue]) Size() int

Size returns number of elements in the map.

func (*Map[TKey, TValue]) ToJSON

func (m *Map[TKey, TValue]) ToJSON() ([]byte, error)

ToJSON outputs the JSON representation of the map.

func (*Map[TKey, TValue]) ToString added in v0.3.0

func (m *Map[TKey, TValue]) ToString() string

String returns a string representation of container.

func (*Map[TKey, TValue]) UnmarshalJSON

func (m *Map[TKey, TValue]) UnmarshalJSON(bytes []byte) error

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

DistanceTo implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) Get added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) Get() (value TValue, found bool)

Get implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) GetAt added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) GetAt(i TKey) (value TValue, found bool)

GetAt implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) Index added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) Index() TKey

Index implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) IsAfter added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) IsAfter(other ds.OrderedIterator) bool

IsAfter implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) IsBefore added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) IsBefore(other ds.OrderedIterator) bool

IsBefore implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) IsBegin added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) IsBegin() bool

IsBegin implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) IsEnd added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) IsEnd() bool

IsEnd implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) IsEqual added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) IsEqual(other ds.ComparableIterator) bool

IsEqual implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) IsFirst added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) IsFirst() bool

IsFirst implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) IsLast added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) IsLast() bool

IsLast implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) IsValid added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) IsValid() bool

IsValid implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) MoveBy added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) MoveBy(n int)

MoveBy implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) MoveTo added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) MoveTo(k TKey)

MoveTo implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) Next added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) Next()

Next implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) NextN added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) NextN(i int)

NextN implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) Previous added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) Previous()

Previous implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) PreviousN added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) PreviousN(n int)

PreviousN implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) Set added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) Set(value TValue) bool

Set implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) SetAt added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) SetAt(i TKey, value TValue) bool

SetAt implements ds.ReadWriteUnordCompBidRandCollIterator

func (*OrderedIterator[TKey, TValue]) Size added in v0.5.0

func (it *OrderedIterator[TKey, TValue]) Size() int

Size implements ds.ReadWriteUnordCompBidRandCollIterator

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL