treemap

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

• type Map
  • func New[K cmp.Ordered, V any]() *Map[K, V]
  • func NewWith[K comparable, V any](comparator dsgo.Comparator[K]) *Map[K, V]
  • func (m *Map[K, V]) Ceiling(key K) (foundKey K, foundValue V, ok bool)
  • func (m *Map[K, V]) Clear()
  • func (m *Map[K, V]) Empty() bool
  • func (m *Map[K, V]) Floor(key K) (foundKey K, foundValue V, ok bool)
  • func (m *Map[K, V]) Get(key K) (value V, found bool)
  • func (m *Map[K, V]) Inorder(handler func(key K, value V))
  • func (m *Map[K, V]) Keys() []K
  • func (m *Map[K, V]) Len() int
  • func (m *Map[K, V]) Max() (key K, value V, ok bool)
  • func (m *Map[K, V]) Min() (key K, value V, ok bool)
  • func (m *Map[K, V]) Put(key K, value V)
  • func (m *Map[K, V]) Remove(key K)
  • func (m *Map[K, V]) String() string
  • func (m *Map[K, V]) Values() []V

Types

type Map

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

Map holds the elements in a red-black tree

func New

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

New instantiates a tree map with the built-in comparator for K

func NewWith

func NewWith[K comparable, V any](comparator dsgo.Comparator[K]) *Map[K, V]

NewWith instantiates a tree map with the custom comparator.

func (*Map[K, V]) Ceiling

func (m *Map[K, V]) Ceiling(key K) (foundKey K, foundValue V, ok bool)

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[K, V]) Clear

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

Clear removes all elements from the map.

func (*Map[K, V]) Empty

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

Empty returns true if map does not contain any elements

func (*Map[K, V]) Floor

func (m *Map[K, V]) Floor(key K) (foundKey K, foundValue V, ok bool)

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[K, V]) Get

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 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[K, V]) Inorder

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

Inorer travels the tree in-order with a handler.

func (*Map[K, V]) Keys

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

Keys returns all keys in-order

func (*Map[K, V]) Len

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

Len returns number of elements in the map.

func (*Map[K, V]) Max

func (m *Map[K, V]) Max() (key K, value V, ok bool)

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

func (*Map[K, V]) Min

func (m *Map[K, V]) Min() (key K, value V, ok bool)

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

func (*Map[K, V]) Put

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

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

func (*Map[K, V]) Remove

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

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

func (*Map[K, V]) String

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

String returns a string representation of container

func (*Map[K, V]) Values

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

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