Class TreeContainer<K, V>`Abstract`

Type Parameters

Hierarchy

Container<K | [K, V]>
- TreeContainer
  - OrderedSet
  - OrderedMap

Index

Accessors

length

get length(): number
Returns
The size of the container.

Example
```
const container = new Vector([1, 2]);
console.log(container.length); // 2
```
Returns number
Inherited from Container.length
- Defined in src/container/ContainerBase/index.ts:101

Methods

size

size(): number
Returns
The size of the container.

Example
```
const container = new Vector([1, 2]);
console.log(container.size()); // 2
```
Returns number
Inherited from Container.size
- Defined in src/container/ContainerBase/index.ts:110

empty

empty(): boolean
Returns
Whether the container is empty.

Example
```
container.clear();
console.log(container.empty());  // true
```
Returns boolean
Inherited from Container.empty
- Defined in src/container/ContainerBase/index.ts:119

`Abstract` begin

begin(): ContainerIterator<K | [K, V]>
Returns
Iterator pointing to the beginning element.

Example
```
const begin = container.begin();
const end = container.end();
for (const it = begin; !it.equals(end); it.next()) {
  doSomething(it.pointer);
}
```
Returns ContainerIterator<K | [K, V]>
Inherited from Container.begin
- Defined in src/container/ContainerBase/index.ts:141

`Abstract` end

end(): ContainerIterator<K | [K, V]>
Returns
Iterator pointing to the super end like c++.

Example
```
const begin = container.begin();
const end = container.end();
for (const it = begin; !it.equals(end); it.next()) {
  doSomething(it.pointer);
}
```
Returns ContainerIterator<K | [K, V]>
Inherited from Container.end
- Defined in src/container/ContainerBase/index.ts:151

`Abstract` rBegin

rBegin(): ContainerIterator<K | [K, V]>
Returns
Iterator pointing to the end element.

Example
```
const rBegin = container.rBegin();
const rEnd = container.rEnd();
for (const it = rBegin; !it.equals(rEnd); it.next()) {
  doSomething(it.pointer);
}
```
Returns ContainerIterator<K | [K, V]>
Inherited from Container.rBegin
- Defined in src/container/ContainerBase/index.ts:161

`Abstract` rEnd

rEnd(): ContainerIterator<K | [K, V]>
Returns
Iterator pointing to the super begin like c++.

Example
```
const rBegin = container.rBegin();
const rEnd = container.rEnd();
for (const it = rBegin; !it.equals(rEnd); it.next()) {
  doSomething(it.pointer);
}
```
Returns ContainerIterator<K | [K, V]>
Inherited from Container.rEnd
- Defined in src/container/ContainerBase/index.ts:171

`Abstract` front

front(): undefined | K | [K, V]
Returns
The first element of the container.

Returns undefined | K | [K, V]
Inherited from Container.front
- Defined in src/container/ContainerBase/index.ts:175

`Abstract` back

back(): undefined | K | [K, V]
Returns
The last element of the container.

Returns undefined | K | [K, V]
Inherited from Container.back
- Defined in src/container/ContainerBase/index.ts:179

`Abstract` find

find(element: K | [K, V]): ContainerIterator<K | [K, V]>
Returns
An iterator pointing to the element if found, or super end if not found.

Example
```
container.find(1).equals(container.end());
```
Parameters
- element: K | [K, V]
  
  The element you want to find.
Returns ContainerIterator<K | [K, V]>
Inherited from Container.find
- Defined in src/container/ContainerBase/index.ts:186

`Abstract` forEach

forEach(callback: ((element: K | [K, V], index: number, container: Container<K | [K, V]>) => void)): void
Description
Iterate over all elements in the container.

Example
```
container.forEach((element, index) => console.log(element, index));
```
Parameters
- callback: ((element: K | [K, V], index: number, container: Container<K | [K, V]>) => void)
  
  Callback function like Array.forEach.
  - - (element: K | [K, V], index: number, container: Container<K | [K, V]>): void
    - Parameters
      
      element: K | [K, V]
      
      index: number
      
      container: Container<K | [K, V]>
      
      Returns void
Returns void
Inherited from Container.forEach
- Defined in src/container/ContainerBase/index.ts:193

`Abstract` getElementByPos

getElementByPos(pos: number): K | [K, V]
Description
Gets the value of the element at the specified position.

Example
```
const val = container.getElementByPos(-1); // throw a RangeError
```
Parameters
- pos: number
Returns K | [K, V]
Inherited from Container.getElementByPos
- Defined in src/container/ContainerBase/index.ts:199

`Abstract` [iterator]

[iterator](): Generator<K | [K, V], void, unknown>
Description
Using for for...of syntax like Array.

Example
```
for (const element of container) {
  console.log(element);
}
```
Returns Generator<K | [K, V], void, unknown>
Inherited from Container.[iterator]
- Defined in src/container/ContainerBase/index.ts:226

clear

clear(): void
Description
Clear the container.

Example
```
container.clear();
console.log(container.empty());  // true
```
Returns void
Overrides Container.clear
- Defined in src/container/TreeContainer/Base/index.ts:460

updateKeyByIterator

updateKeyByIterator(iter: TreeIterator<K, V>, key: K): boolean
Description
Update node's key by iterator.

Returns
Whether the modification is successful.

Example
```
const st = new orderedSet([1, 2, 5]);
const iter = st.find(2);
st.updateKeyByIterator(iter, 3); // then st will become [1, 3, 5]
```
Parameters
- iter: TreeIterator<K, V>
  
  The iterator you want to change.
- key: K
  
  The key you want to update.
Returns boolean
- Defined in src/container/TreeContainer/Base/index.ts:476

eraseElementByPos

eraseElementByPos(pos: number): number
Description
Removes the element at the specified position.

Returns
The container length after erasing.

Example
```
container.eraseElementByPos(-1); // throw a RangeError
```
Parameters
- pos: number
  
  The element's position you want to remove.
Returns number
Overrides Container.eraseElementByPos
- Defined in src/container/TreeContainer/Base/index.ts:508

eraseElementByKey

eraseElementByKey(key: K): boolean
Description
Remove the element of the specified key.

Returns
Whether erase successfully.
Parameters
- key: K
  
  The key you want to remove.
Returns boolean
- Defined in src/container/TreeContainer/Base/index.ts:519

eraseElementByIterator

eraseElementByIterator(iter: TreeIterator<K, V>): TreeIterator<K, V>
Description
Removes element by iterator and move iter to next.

Returns
The next iterator.

Example
```
container.eraseElementByIterator(container.begin());
container.eraseElementByIterator(container.end()); // throw a RangeError
```
Parameters
- iter: TreeIterator<K, V>
  
  The iterator you want to erase.
Returns TreeIterator<K, V>
Overrides Container.eraseElementByIterator
- Defined in src/container/TreeContainer/Base/index.ts:526

getHeight

getHeight(): number
Description
Get the height of the tree.

Returns
Number about the height of the RB-tree.

Returns number
- Defined in src/container/TreeContainer/Base/index.ts:549

`Abstract` reverseUpperBound

reverseUpperBound(key: K): TreeIterator<K, V>
Returns
An iterator to the first element less than the given key.
Parameters
- key: K
  
  The given key you want to compare.
Returns TreeIterator<K, V>
- Defined in src/container/TreeContainer/Base/index.ts:561

`Abstract` union

union(other: TreeContainer<K, V>): number
Description
Union the other tree to self.

Returns
The size of the tree after union.
Parameters
- other: TreeContainer<K, V>
  
  The other tree container you want to merge.
Returns number
- Defined in src/container/TreeContainer/Base/index.ts:567

`Abstract` reverseLowerBound

reverseLowerBound(key: K): TreeIterator<K, V>
Returns
An iterator to the first element not greater than the given key.
Parameters
- key: K
  
  The given key you want to compare.
Returns TreeIterator<K, V>
- Defined in src/container/TreeContainer/Base/index.ts:572

`Abstract` lowerBound

lowerBound(key: K): TreeIterator<K, V>
Returns
An iterator to the first element not less than the given key.
Parameters
- key: K
  
  The given key you want to compare.
Returns TreeIterator<K, V>
- Defined in src/container/TreeContainer/Base/index.ts:577

`Abstract` upperBound

upperBound(key: K): TreeIterator<K, V>
Returns
An iterator to the first element greater than the given key.
Parameters
- key: K
  
  The given key you want to compare.
Returns TreeIterator<K, V>
- Defined in src/container/TreeContainer/Base/index.ts:582

Properties

enableIndex

enableIndex: boolean

Class TreeContainer<K, V>Abstract

Type Parameters

K

V

Hierarchy

Index

Accessors

Methods

Properties

Accessors

length

Returns

Example

Returns number

Methods

size

Returns

Example

Returns number

empty

Returns

Example

Returns boolean

Abstract begin

Returns

Example

Returns ContainerIterator<K | [K, V]>

Abstract end

Returns

Example

Returns ContainerIterator<K | [K, V]>

Abstract rBegin

Returns

Example

Returns ContainerIterator<K | [K, V]>

Abstract rEnd

Returns

Example

Returns ContainerIterator<K | [K, V]>

Abstract front

Returns

Returns undefined | K | [K, V]

Abstract back

Returns

Returns undefined | K | [K, V]

Abstract find

Returns

Example

Parameters

element: K | [K, V]

Returns ContainerIterator<K | [K, V]>

Abstract forEach

Description

Example

Parameters

callback: ((element: K | [K, V], index: number, container: Container<K | [K, V]>) => void)

Parameters

element: K | [K, V]

index: number

container: Container<K | [K, V]>

Returns void

Returns void

Abstract getElementByPos

Description

Example

Parameters

pos: number

Returns K | [K, V]

Abstract [iterator]

Description

Example

Returns Generator<K | [K, V], void, unknown>

clear

Description

Example

Returns void

updateKeyByIterator

Description

Returns

Example

Class TreeContainer<K, V>`Abstract`

`Abstract` begin

`Abstract` end

`Abstract` rBegin

`Abstract` rEnd

`Abstract` front

`Abstract` back

`Abstract` find

`Abstract` forEach

`Abstract` getElementByPos

`Abstract` [iterator]

`Abstract` reverseUpperBound

`Abstract` union

`Abstract` reverseLowerBound

`Abstract` lowerBound

`Abstract` upperBound