treemap

package
Version: v1.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2016 License: BSD-2-Clause Imports: 6 Imported by: 0

Documentation

Overview

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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Iterator

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

Iterator holding the iterator's state

func (*Iterator) Begin added in v1.2.0

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 added in v1.2.0

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 added in v1.2.0

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

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

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

func (*Iterator) Last added in v1.2.0

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

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 added in v1.1.0

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

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

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

type Map

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

Map holds the elements in a red-black tree

func NewWith

func NewWith(comparator utils.Comparator) *Map

NewWith instantiates a tree map with the custom comparator.

func NewWithIntComparator

func NewWithIntComparator() *Map

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

func NewWithStringComparator

func NewWithStringComparator() *Map

NewWithStringComparator instantiates a tree map with the StringComparator, i.e. keys are of type string.

func (*Map) All

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

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

func (m *Map) Clear()

Clear removes all elements from the map.

func (*Map) Each

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

func (m *Map) Empty() bool

Empty returns true if map does not contain any elements

func (*Map) Find

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) Get

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

func (m *Map) Iterator() Iterator

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

func (*Map) Keys

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

Keys returns all keys in-order

func (*Map) Map

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

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

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

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

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

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

func (m *Map) Size() int

Size returns number of elements in the map.

func (*Map) String

func (m *Map) String() string

String returns a string representation of container

func (*Map) Values

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

Values returns all values in-order based on the key.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL