linkedhashmap

Documentation

Overview

Package linkedhashmap is a map that preserves insertion-order.

It is backed by a hash table to store values and doubly-linked list to store ordering.

Structure is not thread safe.

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

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 New[K comparable, V any]() *Map[K, V]
  • 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]) 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

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

func (iterator *Iterator[K, V]) First() bool

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

func (iterator *Iterator[K, V]) Last() bool

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

func (iterator *Iterator[K, V]) Next() bool

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

func (iterator *Iterator[K, V]) NextTo(f func(key K, value V) bool) bool

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

func (iterator *Iterator[K, V]) Prev() bool

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

func (iterator *Iterator[K, V]) PrevTo(f func(key K, value V) bool) bool

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.

func (*Iterator[K, V]) Value

func (iterator *Iterator[K, V]) Value() V

Value returns the current element's value. Does not modify the state of the iterator.

type Map

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

Map holds the elements in a regular hash table, and uses doubly-linked list to store key ordering.

func New

func New[K comparable, V any]() *Map[K, V]

New instantiates a linked-hash-map.

func (*Map[K, V]) All

func (m *Map[K, V]) All(f func(key K, value V) bool) bool

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

func (m *Map[K, V]) Any(f func(key K, value V) bool) bool

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

func (m *Map[K, V]) Clear()

Clear removes all elements from the map.

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

func (m *Map[K, V]) Empty() bool

Empty returns true if map does not contain any elements

func (*Map[K, V]) Find

func (m *Map[K, V]) Find(f func(key K, value V) bool) (k K, v V)

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

func (m *Map[K, V]) FromJSON(data []byte) error

FromJSON populates map from the input JSON representation.

func (*Map[K, V]) Get

func (m *Map[K, V]) Get(key K) (value V, found bool)

Get searches the element in the map 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 (*Map[K, V]) Iterator

func (m *Map[K, V]) Iterator() *Iterator[K, V]

Iterator returns a stateful iterator whose elements are key/value pairs.

func (*Map[K, V]) Keys

func (m *Map[K, V]) Keys() []K

Keys returns all keys in-order

func (*Map[K, V]) Map

func (m *Map[K, V]) Map(f func(key1 K, value1 V) (K, V)) *Map[K, V]

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

func (m *Map[K, V]) MarshalJSON() ([]byte, error)

MarshalJSON @implements json.Marshaler

func (*Map[K, V]) Put

func (m *Map[K, V]) Put(key K, value V)

Put inserts key-value pair into the map. Key should adhere to the comparator's type assertion, otherwise method panics.

func (*Map[K, V]) Remove

func (m *Map[K, V]) Remove(key K)

Remove removes the element from the map by key. Key should adhere to the comparator's type assertion, otherwise method panics.

func (*Map[K, V]) Select

func (m *Map[K, V]) Select(f func(key K, value V) bool) *Map[K, V]

Select returns a new container containing all elements for which the given function returns a true value.

func (*Map[K, V]) Size

func (m *Map[K, V]) Size() int

Size returns number of elements in the map.

func (*Map[K, V]) String

func (m *Map[K, V]) String() string

String returns a string representation of container

func (*Map[K, V]) ToJSON

func (m *Map[K, V]) ToJSON() ([]byte, error)

ToJSON outputs the JSON representation of map.

func (*Map[K, V]) UnmarshalJSON

func (m *Map[K, V]) UnmarshalJSON(bytes []byte) error

UnmarshalJSON @implements json.Unmarshaler

func (*Map[K, V]) Values

func (m *Map[K, V]) Values() []V

Values returns all values in-order based on the key.