bimap

Documentation

Index

• type BiMap
  • func New[K, V comparable]() *BiMap[K, V]
  • func (m *BiMap[K, V]) DeleteKey(key K) (V, bool)
  • func (m *BiMap[K, V]) DeleteValue(val V) (K, bool)
  • func (m *BiMap[K, V]) GetKey(val V) (K, bool)
  • func (m *BiMap[K, V]) GetValue(key K) (V, bool)
  • func (m *BiMap[K, _]) HasKey(key K) bool
  • func (m *BiMap[_, V]) HasValue(val V) bool
  • func (m *BiMap[K, V]) Len() int
  • func (m *BiMap[K, V]) Put(key K, val V) []Entry[K, V]
• type Entry

Types

type BiMap

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

BiMap is a bi-directional map.

func New

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

New creates a new empty bimap.

func (*BiMap[K, V]) DeleteKey

func (m *BiMap[K, V]) DeleteKey(key K) (V, bool)

DeleteKey removes [key] from the map and returns the value it mapped to.

func (*BiMap[K, V]) DeleteValue

func (m *BiMap[K, V]) DeleteValue(val V) (K, bool)

DeleteValue removes [val] from the map and returns the key that mapped to it.

func (*BiMap[K, V]) GetKey

func (m *BiMap[K, V]) GetKey(val V) (K, bool)

GetKey that maps to the provided value.

func (*BiMap[K, V]) GetValue

func (m *BiMap[K, V]) GetValue(key K) (V, bool)

GetValue that is mapped to the provided key.

func (*BiMap[K, _]) HasKey

func (m *BiMap[K, _]) HasKey(key K) bool

HasKey returns true if [key] is in the map.

func (*BiMap[_, V]) HasValue

func (m *BiMap[_, V]) HasValue(val V) bool

HasValue returns true if [val] is in the map.

func (*BiMap[K, V]) Len

func (m *BiMap[K, V]) Len() int

Len return the number of entries in this map.

func (*BiMap[K, V]) Put

func (m *BiMap[K, V]) Put(key K, val V) []Entry[K, V]

Put the key value pair into the map. If either [key] or [val] was previously in the map, the previous entries will be removed and returned.

Note: Unlike normal maps, it's possible that Put removes 0, 1, or 2 existing entries to ensure that mappings are one-to-one.

type Entry

type Entry[K, V any] struct {
	Key   K
	Value V
}