Class TreeContainer<K, V>`Abstract`

Type Parameters

Hierarchy

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

Constructors

`Protected` constructor

new TreeContainer<K, V>(cmp?: ((x: K, y: K) => number), enableIndex?: boolean): TreeContainer<K, V>
Type Parameters
- K
- V
Parameters
- cmp: ((x: K, y: K) => number) = ...
  
  The compare function.
  - - (x: K, y: K): number
    - Parameters
      
      x: K
      
      y: K
      
      Returns number
- enableIndex: boolean = false
  
  Whether to enable iterator indexing function.
Returns TreeContainer<K, V>
Overrides Container.constructor
- Defined in src/container/TreeContainer/Base/index.ts:41

Methods

`Abstract` [iterator]

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

Returns Generator<K | [K, V], void, undefined>
Inherited from Container.[iterator]
- Defined in src/container/ContainerBase/index.ts:130

`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:99

`Abstract` begin

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

Returns ContainerIterator<K | [K, V]>
Inherited from Container.begin
- Defined in src/container/ContainerBase/index.ts:79

clear

clear(): void
Description
Clear the container.

Returns void
Overrides Container.clear
- Defined in src/container/TreeContainer/Base/index.ts:488

empty

empty(): boolean
Returns
Boolean about if the container is empty.

Returns boolean
Inherited from Container.empty
- Defined in src/container/ContainerBase/index.ts:66

`Abstract` end

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

Returns ContainerIterator<K | [K, V]>
Inherited from Container.end
- Defined in src/container/ContainerBase/index.ts:83

eraseElementByIterator

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

Example
```
container.eraseElementByIterator(container.begin());
```
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:571

eraseElementByKey

eraseElementByKey(_key: K): void
Description
Remove the element of the specified _key.
Parameters
- _key: K
  
  The _key you want to remove.
Returns void
- Defined in src/container/TreeContainer/Base/index.ts:565

eraseElementByPos

eraseElementByPos(pos: number): void
Description
Removes the element at the specified position.
Parameters
- pos: number
  
  The element's position you want to remove.
Returns void
Overrides Container.eraseElementByPos
- Defined in src/container/TreeContainer/Base/index.ts:530

`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.
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:109

`Abstract` forEach

forEach(callback: ((element: K | [K, V], index: number) => void)): void
Description
Iterate over all elements in the container.
Parameters
- callback: ((element: K | [K, V], index: number) => void)
  
  Callback function like Array.forEach.
  - - (element: K | [K, V], index: number): void
    - Parameters
      
      element: K | [K, V]
      
      index: number
      
      Returns void
Returns void
Inherited from Container.forEach
- Defined in src/container/ContainerBase/index.ts:104

`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:95

`Abstract` getElementByPos

getElementByPos(pos: number): K | [K, V]
Description
Gets the value of the element at the specified position.
Parameters
- pos: number
Returns K | [K, V]
Inherited from Container.getElementByPos
- Defined in src/container/ContainerBase/index.ts:113

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:586

`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:115

`Abstract` rBegin

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

Returns ContainerIterator<K | [K, V]>
Inherited from Container.rBegin
- Defined in src/container/ContainerBase/index.ts:87

`Abstract` rEnd

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

Returns ContainerIterator<K | [K, V]>
Inherited from Container.rEnd
- Defined in src/container/ContainerBase/index.ts:91

`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:163

`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:187

size

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

Returns number
Inherited from Container.size
- Defined in src/container/ContainerBase/index.ts:60

`Abstract` union

union(other: TreeContainer<K, V>): void
Description
Union the other tree to self.
Parameters
- other: TreeContainer<K, V>
  
  The other tree container you want to merge.
Returns void
- Defined in src/container/TreeContainer/Base/index.ts:192

updateKeyByIterator

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

Returns
Boolean about if the modification is successful.
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:500

`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:139

Class TreeContainer<K, V>Abstract

Type Parameters

K

V

Hierarchy

Index

Constructors

Methods

Constructors

Protected constructor

Type Parameters

K

V

Parameters

cmp: ((x: K, y: K) => number) = ...

Parameters

x: K

y: K

Returns number

enableIndex: boolean = false

Returns TreeContainer<K, V>

Methods

Abstract [iterator]

Description

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

Abstract back

Returns

Returns undefined | K | [K, V]

Abstract begin

Returns

Returns ContainerIterator<K | [K, V]>

clear

Description

Returns void

empty

Returns

Returns boolean

Abstract end

Returns

Returns ContainerIterator<K | [K, V]>

eraseElementByIterator

Description

Example

Parameters

iter: TreeIterator<K, V>

Returns TreeIterator<K, V>

eraseElementByKey

Description

Parameters

_key: K

Returns void

eraseElementByPos

Description

Parameters

pos: number

Returns void

Abstract find

Returns

Parameters

element: K | [K, V]

Returns ContainerIterator<K | [K, V]>

Abstract forEach

Description

Parameters

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

Parameters

element: K | [K, V]

index: number

Returns void

Returns void

Abstract front

Returns

Returns undefined | K | [K, V]

Abstract getElementByPos

Description

Parameters

pos: number

Returns K | [K, V]

getHeight

Description

Class TreeContainer<K, V>`Abstract`

`Protected` constructor

`Abstract` [iterator]

`Abstract` back

`Abstract` begin

`Abstract` end

`Abstract` find

`Abstract` forEach

`Abstract` front

`Abstract` getElementByPos

`Abstract` lowerBound

`Abstract` rBegin

`Abstract` rEnd

`Abstract` reverseLowerBound

`Abstract` reverseUpperBound

`Abstract` union

`Abstract` upperBound