bimap

Documentation

Index

• type BiMap
  • func NewBiMap[K comparable, V comparable]() *BiMap[K, V]
  • func NewBiMapFromMap[K comparable, V comparable](m map[K]V) *BiMap[K, V]
  • func (b *BiMap[K, V]) Delete(key K)
  • func (b *BiMap[K, V]) GetByKey(key K) (V, bool)
  • func (b *BiMap[K, V]) GetByValue(value V) (K, bool)
  • func (b *BiMap[K, V]) GetKeys() []K
  • func (b *BiMap[K, V]) GetValues() []V
  • func (b *BiMap[K, V]) Put(key K, value V)

Types

type BiMap

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

BiMap represents a bidirectional map

func NewBiMap

func NewBiMap[K comparable, V comparable]() *BiMap[K, V]

NewBiMap creates a new BiMap

func NewBiMapFromMap

func NewBiMapFromMap[K comparable, V comparable](m map[K]V) *BiMap[K, V]

NewBiMapFromMap NewBiMap creates a new BiMap from a map.

func (*BiMap[K, V]) Delete

func (b *BiMap[K, V]) Delete(key K)

Delete removes a key-value pair

func (*BiMap[K, V]) GetByKey

func (b *BiMap[K, V]) GetByKey(key K) (V, bool)

GetByKey retrieves the value for a given key

func (*BiMap[K, V]) GetByValue

func (b *BiMap[K, V]) GetByValue(value V) (K, bool)

GetByValue retrieves the key for a given value

func (*BiMap[K, V]) GetKeys

func (b *BiMap[K, V]) GetKeys() []K

GetKeys returns all keys of the BiMap

func (*BiMap[K, V]) GetValues

func (b *BiMap[K, V]) GetValues() []V

GetValues returns all the values of the BiMap

func (*BiMap[K, V]) Put

func (b *BiMap[K, V]) Put(key K, value V)

Put adds a key-value pair to the BiMap