treebidimap

原文：https://pkg.go.dev/github.com/emirpasic/gods/v2@v2.0.0-alpha/maps/treebidimap

收录该文档时间： 2024-12-07T11:04:17+08:00

Overview

Package treebidimap implements a bidirectional map backed by two red-black tree.

​ 包 treebidimap 实现了一个双向映射，支持通过两个红黑树来维护映射关系。

This structure guarantees that the map will be in both ascending key and value order.

​ 这个结构确保映射的键和值都按升序排列。

Other than key and value ordering, the goal with this structure is to avoid duplication of elements, which can be significant if contained elements are large.

​ 除了键值排序外，这个结构的目标是避免元素的重复，这在元素较大时尤其重要。

A bidirectional map, or hash bag, is an associative data structure in which the (key,value) pairs form a one-to-one correspondence. Thus the binary relation is functional in each direction: value can also act as a key to key. A pair (a,b) thus provides a unique coupling between ‘a’ and ‘b’ so that ‘b’ can be found when ‘a’ is used as a key and ‘a’ can be found when ‘b’ is used as a key.

​ 双向映射，也叫哈希袋，是一种关联数据结构，其中的 (key, value) 对形成一一对应的关系。因此，该二元关系在每个方向上都是功能性的：值也可以作为键来查找键。一个 (a, b) 对提供了 a 和 b 之间的唯一配对，可以通过 a 查找 b，也可以通过 b 查找 a。

Structure is not thread safe.

​ 该结构不是线程安全的。

Reference: https://en.wikipedia.org/wiki/Bidirectional_map

常量

This section is empty.

变量

This section is empty.

函数

This section is empty.

类型

type Iterator

1
2
3

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

Iterator holding the iterator’s state

​ Iterator 持有迭代器的状态。

(*Iterator[K, V]) Begin

1

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.

​ Begin 将迭代器重置到其初始状态（即第一个元素之前）。调用 Next() 以获取第一个元素（如果存在）。

(*Iterator[K, V]) End

1

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.

​ End 将迭代器移动到最后一个元素之后的位置（即最后一个元素之后）。调用 Prev() 可以获取最后一个元素（如果存在）。

(*Iterator[K, V]) First

1

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

​ First 将迭代器移到第一个元素，并返回 true 如果存在第一个元素。如果 First() 返回 true，则可以通过 Key() 和 Value() 获取第一个元素的键和值。此操作会修改迭代器的状态。

(*Iterator[K, V]) Key

1

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

Key returns the current element’s key. Does not modify the state of the iterator.

​ Key 返回当前元素的键。此操作不会修改迭代器的状态。

(*Iterator[K, V]) Last

1

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.

​ Last 将迭代器移到最后一个元素，并返回 true 如果存在最后一个元素。如果 Last() 返回 true，则可以通过 Key() 和 Value() 获取最后一个元素的键和值。此操作会修改迭代器的状态。

(*Iterator[K, V]) Next

1

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.

​ Next 将迭代器移到下一个元素，并返回 true 如果存在下一个元素。如果 Next() 返回 true，则可以通过 Key() 和 Value() 获取下一个元素的键和值。第一次调用 Next() 会将迭代器指向第一个元素（如果存在）。此操作会修改迭代器的状态。

(*Iterator[K, V]) NextTo

1

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.

​ NextTo 将迭代器移到下一个满足给定条件（由传递的函数 f 指定）的元素，并返回 true 如果存在下一个满足条件的元素。如果 NextTo() 返回 true，则可以通过 Key() 和 Value() 获取该元素的键和值。此操作会修改迭代器的状态。

(*Iterator[K, V]) Prev

1

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.

​ Prev 将迭代器移到前一个元素，并返回 true 如果存在前一个元素。如果 Prev() 返回 true，则可以通过 Key() 和 Value() 获取前一个元素的键和值。此操作会修改迭代器的状态。

(*Iterator[K, V]) PrevTo

1

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.

​ PrevTo 将迭代器移到前一个满足给定条件（由传递的函数 f 指定）的元素，并返回 true 如果存在前一个满足条件的元素。如果 PrevTo() 返回 true，则可以通过 Key() 和 Value() 获取该元素的键和值。此操作会修改迭代器的状态。

(*Iterator[K, V]) Value

1

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

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

​ Value 返回当前元素的值。此操作不会修改迭代器的状态。

type Map

1
2
3

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

Map holds the elements in two red-black trees.

​ Map 使用两个红黑树来存储元素，并维护键值的排序。

func New

1

func New[K, V cmp.Ordered]() *Map[K, V]

New instantiates a bidirectional map.

​ New 创建并返回一个新的双向映射。

func NewWith

1

func NewWith[K, V comparable](keyComparator utils.Comparator[K], valueComparator utils.Comparator[V]) *Map[K, V]

NewWith instantiates a bidirectional map.

​ NewWith 使用提供的比较器创建一个双向映射。

(*Map[K, V]) All

1

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.

​ All 将容器中的每个元素传递给给定函数，并返回 true 如果函数对所有元素返回 true。

(*Map[K, V]) Any

1

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.

​ Any 将容器中的每个元素传递给给定函数，并返回 true 如果函数对任何元素返回 true。

(*Map[K, V]) Clear

1

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

Clear removes all elements from the map.

​ Clear 清空映射中的所有元素。

(*Map[K, V]) Each

1

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.

​ Each 将给定函数应用于每个元素，传递该元素的键和值。

(*Map[K, V]) Empty

1

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

Empty returns true if map does not contain any elements

​ Empty 返回布尔值，表示映射是否为空。

(*Map[K, V]) Find

1

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.

​ Find 将容器中的每个元素传递给给定函数，并返回第一个满足条件的元素的 (key, value)，如果没有元素匹配条件，则返回 nil, nil。

(*Map[K, V]) FromJSON

1

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

FromJSON populates the map from the input JSON representation.

​ FromJSON 从输入的 JSON 表示填充映射。

(*Map[K, V]) Get

1

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 map. Second return parameter is true if key was found, otherwise false.

​ Get 根据键从映射中查找元素，并返回其值（如果找到）或 nil（如果未找到）。第二个返回值为 true 如果键存在，否则为 false。

(*Map[K, V]) GetKey

1

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

GetKey searches the element in the map by value and returns its key or nil if value is not found in map. Second return parameter is true if value was found, otherwise false.

​ GetKey 根据值从映射中查找元素，并返回其键（如果找到）或 nil（如果未找到）。第二个返回值为 true 如果值存在，否则为 false。

(*Map[K, V]) Iterator

1

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

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

​ Iterator 返回一个状态可变的迭代器，该迭代器包含键值对。

(*Map[K, V]) Keys

1

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

Keys returns all keys (ordered).

​ Keys 返回所有的键（按顺序排列）。

(*Map[K, V]) Map

1

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.

​ Map 对每个元素调用给定的函数，并返回一个包含函数返回的键值对的容器。

(*Map[K, V]) MarshalJSON

1

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

MarshalJSON @implements json.Marshaler

​ MarshalJSON 实现了 json.Marshaler 接口。

(*Map[K, V]) Put

1

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

Put inserts element into the map.

​ Put 将元素插入映射。

(*Map[K, V]) Remove

1

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

Remove removes the element from the map by key.

​ Remove 根据键从映射中移除元素。

(*Map[K, V]) Select

1

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.

​ Select 返回一个新容器，包含所有满足给定条件的元素。

(*Map[K, V]) Size

1

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

Size returns number of elements in the map.

​ Size 返回映射中元素的数量。

(*Map[K, V]) String

1

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

String returns a string representation of container

​ String 返回容器的字符串表示。

(*Map[K, V]) ToJSON

1

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

ToJSON outputs the JSON representation of the map.

​ ToJSON 输出映射的 JSON 表示。

(*Map[K, V]) UnmarshalJSON

1

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

UnmarshalJSON @implements json.Unmarshaler

​ UnmarshalJSON 实现了 json.Unmarshaler 接口。

(*Map[K, V]) Values

1

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

Values returns all values (ordered).

​ Values 返回所有按顺序排列的值。