Class SortedTree<K, V>

A SortedTree is a map that holds key value pairs ordered by keys. Any primitive value (and objects that implement Comparable or Ordered interfaces) can be used as keys or values.

See

Template

V

Type Parameters

K
V

Hierarchy

Mapping<K, V>
- SortedTree

Index

Constructors

Accessors

Methods

add clear contains delete empty entries freeze get has keys max min reversed set values

Constructors

constructor

new SortedTree<K, V>(iterable?: Iterable<[K, V]>, compareFn?: Comparer<any>): SortedTree<K, V>
Creates a new SortedTree object.
Type Parameters
- K
- V
Parameters
- Optional iterable: Iterable<[K, V]>
  
  Initialize the tree with entries.
- Optional compareFn: Comparer<any>
  
  The compare function to sort keys.
Returns SortedTree<K, V>
Overrides Mapping.constructor
- Defined in src/collections/SortedTree.ts:19

Accessors

length

get length(): number
Returns number
Inherited from Mapping.length
- Defined in src/collections/abc.ts:76

size

get size(): number
Returns the total key/value pairs in the tree.

Returns

Returns number
Overrides Mapping.size
- Defined in src/collections/SortedTree.ts:107

Methods

add

add(key: K): SortedTree<K, V>
Adds a new key with a null value.

Returns
Returns the Tree object.
Parameters
- key: K
Returns SortedTree<K, V>
Overrides Mapping.add
- Defined in src/collections/SortedTree.ts:29

clear

clear(): void
Removes all key/value pairs in the tree.

Returns void
Overrides Mapping.clear
- Defined in src/collections/SortedTree.ts:82

contains

contains(key: K): boolean
Returns true if the key exists in the tree.

Returns
true if key is found, otherwise false.
Parameters
- key: K
Returns boolean
Overrides Mapping.contains
- Defined in src/collections/SortedTree.ts:124

delete

delete(key: K): boolean
Returns true if the key existed in the tree and was removed.

Returns
true if key was removed, otherwise false.
Parameters
- key: K
Returns boolean
- Defined in src/collections/SortedTree.ts:75

empty

empty(): boolean
Check if there are no key/value pairs in the tree.

Returns
true if is empty.

Returns boolean
Overrides Mapping.empty
- Defined in src/collections/SortedTree.ts:115

entries

entries(): IterableIterator<[K, V]>
Returns a new iterator of all key value pairs ordered by their keys.

Returns

Returns IterableIterator<[K, V]>
Overrides Mapping.entries
- Defined in src/collections/SortedTree.ts:157

freeze

freeze(): SortedTree<K, V>
Freezes the tree which prevents adding, updating or removing any keys.

Returns

Returns SortedTree<K, V>
- Defined in src/collections/SortedTree.ts:90

get

get(key: K): V
Returns the value associated with the key or undefined.

Returns
The key value or undefined.
Parameters
- key: K
Returns V
Overrides Mapping.get
- Defined in src/collections/SortedTree.ts:39

has

has(key: K): boolean
Returns true if the key exists in the tree.

Returns
true if key is found, otherwise false.
Parameters
- key: K
Returns boolean
- Defined in src/collections/SortedTree.ts:133

keys

keys(): IterableIterator<K>
Returns a new iterator of all ordered keys in the tree.

Returns

Returns IterableIterator<K>
Overrides Mapping.keys
- Defined in src/collections/SortedTree.ts:141

max

max(): K
Returns the largest key in the tree.

Returns

Returns K
- Defined in src/collections/SortedTree.ts:66

min

min(): K
Returns the smallest key in the tree.

Returns

Returns K
- Defined in src/collections/SortedTree.ts:58

reversed

reversed(): IterableIterator<[K, V]>
Returns a new iterator of [K, V] pairs in reverse order of keys.

Returns

Returns IterableIterator<[K, V]>
- Defined in src/collections/SortedTree.ts:99

set

set(key: K, value: V): SortedTree<K, V>
Sets the value for the given key.

Returns
Returns the Tree object.
Parameters
- key: K
- value: V
Returns SortedTree<K, V>
Overrides Mapping.set
- Defined in src/collections/SortedTree.ts:49

values

values(): IterableIterator<V>
Returns a new iterator of all values ordered by their keys.

Returns

Returns IterableIterator<V>
Overrides Mapping.values
- Defined in src/collections/SortedTree.ts:149

Generated using TypeDoc