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

package treemap

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

Package treemap implements a map backed by red-black tree.

Elements are ordered by key in the map.

Structure is not thread safe.

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

Index

Package Files

enumerable.go iterator.go serialization.go treemap.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 a red-black tree

func NewWith Uses

func NewWith(comparator utils.Comparator) *Map

NewWith instantiates a tree map with the custom comparator.

func NewWithIntComparator Uses

func NewWithIntComparator() *Map

NewWithIntComparator instantiates a tree map with the IntComparator, i.e. keys are of type int.

func NewWithStringComparator Uses

func NewWithStringComparator() *Map

NewWithStringComparator instantiates a tree map with the StringComparator, i.e. keys 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) Ceiling Uses

func (m *Map) Ceiling(key interface{}) (foundKey interface{}, foundValue interface{})

Ceiling finds the ceiling key-value pair for the input key. In case that no ceiling is found, then both returned values will be nil. It's generally enough to check the first value (key) for nil, which determines if ceiling was found.

Ceiling key is defined as the smallest key that is larger than or equal to the given key. A ceiling key may not be found, either because the map is empty, or because all keys in the map are smaller than the given key.

Key should adhere to the comparator's type assertion, otherwise method panics.

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

func (m *Map) Floor(key interface{}) (foundKey interface{}, foundValue interface{})

Floor finds the floor key-value pair for the input key. In case that no floor is found, then both returned values will be nil. It's generally enough to check the first value (key) for nil, which determines if floor was found.

Floor key is defined as the largest key that is smaller than or equal to the given key. A floor key may not be found, either because the map is empty, or because all keys in the map are larger than the given key.

Key should adhere to the comparator's type assertion, otherwise method panics.

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 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) 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 in-order

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

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

Max returns the maximum key and its value from the tree map. Returns nil, nil if map is empty.

func (*Map) Min Uses

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

Min returns the minimum key and its value from the tree map. Returns nil, nil if map is empty.

func (*Map) Put Uses

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

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

func (*Map) Remove Uses

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

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

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 in-order based on the key.

Package treemap imports 6 packages (graph) and is imported by 20 packages. Updated 2019-08-08. Refresh now. Tools for package owners.