gods: github.com/emirpasic/gods/maps/treebidimap Index | Files

package treebidimap

import "github.com/emirpasic/gods/maps/treebidimap"

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

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.

Structure is not thread safe.

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

Index

Package Files

enumerable.go iterator.go serialization.go treebidimap.go

type Iterator Uses

type Iterator struct {
    // contains filtered or unexported fields
}

Iterator holding the iterator's state

func (*Iterator) Begin Uses

func (iterator *Iterator) Begin()

Begin resets the iterator to its initial state (one-before-first) Call Next() to fetch the first element if any.

func (*Iterator) End Uses

func (iterator *Iterator) End()

End moves the iterator past the last element (one-past-the-end). Call Prev() to fetch the last element if any.

func (*Iterator) First Uses

func (iterator *Iterator) 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) Key Uses

func (iterator *Iterator) Key() interface{}

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

func (*Iterator) Last Uses

func (iterator *Iterator) 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) Next Uses

func (iterator *Iterator) 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) Prev Uses

func (iterator *Iterator) 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) Value Uses

func (iterator *Iterator) Value() interface{}

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

type Map Uses

type Map struct {
    // contains filtered or unexported fields
}

Map holds the elements in two red-black trees.

func NewWith Uses

func NewWith(keyComparator utils.Comparator, valueComparator utils.Comparator) *Map

NewWith instantiates a bidirectional map.

func NewWithIntComparators Uses

func NewWithIntComparators() *Map

NewWithIntComparators instantiates a bidirectional map with the IntComparator for key and value, i.e. keys and values are of type int.

func NewWithStringComparators Uses

func NewWithStringComparators() *Map

NewWithStringComparators instantiates a bidirectional map with the StringComparator for key and value, i.e. keys and values are of type string.

func (*Map) All Uses

func (m *Map) All(f func(key interface{}, value interface{}) 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) Any Uses

func (m *Map) Any(f func(key interface{}, value interface{}) 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) Clear Uses

func (m *Map) Clear()

Clear removes all elements from the map.

func (*Map) Each Uses

func (m *Map) Each(f func(key interface{}, value interface{}))

Each calls the given function once for each element, passing that element's key and value.

func (*Map) Empty Uses

func (m *Map) Empty() bool

Empty returns true if map does not contain any elements

func (*Map) Find Uses

func (m *Map) Find(f func(key interface{}, value interface{}) bool) (interface{}, interface{})

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

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

FromJSON populates the map from the input JSON representation.

func (*Map) Get Uses

func (m *Map) Get(key interface{}) (value interface{}, 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) GetKey Uses

func (m *Map) GetKey(value interface{}) (key interface{}, 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.

func (*Map) Iterator Uses

func (m *Map) Iterator() Iterator

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

func (*Map) Keys Uses

func (m *Map) Keys() []interface{}

Keys returns all keys (ordered).

func (*Map) Map Uses

func (m *Map) Map(f func(key1 interface{}, value1 interface{}) (interface{}, interface{})) *Map

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) Put Uses

func (m *Map) Put(key interface{}, value interface{})

Put inserts element into the map.

func (*Map) Remove Uses

func (m *Map) Remove(key interface{})

Remove removes the element from the map by key.

func (*Map) Select Uses

func (m *Map) Select(f func(key interface{}, value interface{}) bool) *Map

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

func (*Map) Size Uses

func (m *Map) Size() int

Size returns number of elements in the map.

func (*Map) String Uses

func (m *Map) String() string

String returns a string representation of container

func (*Map) ToJSON Uses

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

ToJSON outputs the JSON representation of the map.

func (*Map) Values Uses

func (m *Map) Values() []interface{}

Values returns all values (ordered).

Package treebidimap imports 7 packages (graph) and is imported by 3 packages. Updated 2018-09-21. Refresh now. Tools for package owners.