Class OrderedMap<K, V>

Type Parameters

Hierarchy

TreeContainer<K, V>
- OrderedMap

Constructors

constructor

new OrderedMap<K, V>(container?: initContainer<[K, V]>, cmp?: ((x: K, y: K) => number), enableIndex?: boolean): OrderedMap<K, V>
Type Parameters
- K
- V
Parameters
- container: initContainer<[K, V]> = []
  
  The initialization container.
- Optional cmp: ((x: K, y: K) => number)
  
  The compare function.
  - - (x: K, y: K): number
    - Parameters
      
      x: K
      
      y: K
      
      Returns number
- Optional enableIndex: boolean
  
  Whether to enable iterator indexing function.
Returns OrderedMap<K, V>
Overrides TreeContainer.constructor
- Defined in src/container/TreeContainer/OrderedMap.ts:37

Methods

[iterator]

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

Returns Generator<[K, V], void, undefined>
Overrides TreeContainer.[iterator]
- Defined in src/container/TreeContainer/OrderedMap.ts:141

back

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

Returns undefined | [K, V]
Overrides TreeContainer.back
- Defined in src/container/TreeContainer/OrderedMap.ts:77

begin

begin(): OrderedMapIterator<K, V>
Returns
Iterator pointing to the beginning element.

Returns OrderedMapIterator<K, V>
Overrides TreeContainer.begin
- Defined in src/container/TreeContainer/OrderedMap.ts:56

clear

clear(): void
Description
Clear the container.

Returns void
Inherited from TreeContainer.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 TreeContainer.empty
- Defined in src/container/ContainerBase/index.ts:66

end

end(): OrderedMapIterator<K, V>
Returns
Iterator pointing to the super end like c++.

Returns OrderedMapIterator<K, V>
Overrides TreeContainer.end
- Defined in src/container/TreeContainer/OrderedMap.ts:59

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>
Inherited from TreeContainer.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
Inherited from TreeContainer.eraseElementByKey
- 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
Inherited from TreeContainer.eraseElementByPos
- Defined in src/container/TreeContainer/Base/index.ts:530

find

find(_key: K): OrderedMapIterator<K, V>
Returns
An iterator pointing to the element if found, or super end if not found.
Parameters
- _key: K
  
  The element you want to find.
Returns OrderedMapIterator<K, V>
Overrides TreeContainer.find
- Defined in src/container/TreeContainer/OrderedMap.ts:111

forEach

forEach(callback: ((element: [K, V], index: number) => void)): void
Description
Iterate over all elements in the container.
Parameters
- callback: ((element: [K, V], index: number) => void)
  
  Callback function like Array.forEach.
  - - (element: [K, V], index: number): void
    - Parameters
      
      element: [K, V]
      
      index: number
      
      Returns void
Returns void
Overrides TreeContainer.forEach
- Defined in src/container/TreeContainer/OrderedMap.ts:82

front

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

Returns undefined | [K, V]
Overrides TreeContainer.front
- Defined in src/container/TreeContainer/OrderedMap.ts:72

getElementByKey

getElementByKey(_key: K): undefined | V
Description
Get the _value of the element of the specified _key.
Parameters
- _key: K
Returns undefined | V
- Defined in src/container/TreeContainer/OrderedMap.ts:121

getElementByPos

getElementByPos(pos: number): [K, V]
Description
Gets the value of the element at the specified position.
Parameters
- pos: number
Returns [K, V]
Overrides TreeContainer.getElementByPos
- Defined in src/container/TreeContainer/OrderedMap.ts:125

getHeight

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

Returns
Number about the height of the RB-tree.

Returns number
Inherited from TreeContainer.getHeight
- Defined in src/container/TreeContainer/Base/index.ts:586

lowerBound

lowerBound(_key: K): OrderedMapIterator<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 OrderedMapIterator<K, V>
Overrides TreeContainer.lowerBound
- Defined in src/container/TreeContainer/OrderedMap.ts:86

rBegin

rBegin(): OrderedMapIterator<K, V>
Returns
Iterator pointing to the end element.

Returns OrderedMapIterator<K, V>
Overrides TreeContainer.rBegin
- Defined in src/container/TreeContainer/OrderedMap.ts:62

rEnd

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

Returns OrderedMapIterator<K, V>
Overrides TreeContainer.rEnd
- Defined in src/container/TreeContainer/OrderedMap.ts:69

reverseLowerBound

reverseLowerBound(_key: K): OrderedMapIterator<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 OrderedMapIterator<K, V>
Overrides TreeContainer.reverseLowerBound
- Defined in src/container/TreeContainer/OrderedMap.ts:94

reverseUpperBound

reverseUpperBound(_key: K): OrderedMapIterator<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 OrderedMapIterator<K, V>
Overrides TreeContainer.reverseUpperBound
- Defined in src/container/TreeContainer/OrderedMap.ts:98

setElement

setElement(_key: K, _value: V, hint?: OrderedMapIterator<K, V>): void
Description
Insert a _key-_value pair or set _value by the given _key.
Parameters
- _key: K
  
  The _key want to insert.
- _value: V
  
  The _value want to set.
- Optional hint: OrderedMapIterator<K, V>
  
  You can give an iterator hint to improve insertion efficiency.
Returns void
- Defined in src/container/TreeContainer/OrderedMap.ts:108

size

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

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

union

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

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
Inherited from TreeContainer.updateKeyByIterator
- Defined in src/container/TreeContainer/Base/index.ts:500

upperBound

upperBound(_key: K): OrderedMapIterator<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 OrderedMapIterator<K, V>
Overrides TreeContainer.upperBound
- Defined in src/container/TreeContainer/OrderedMap.ts:90

Class OrderedMap<K, V>

Type Parameters

K

V

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

K

V

Parameters

container: initContainer<[K, V]> = []

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

Parameters

x: K

y: K

Returns number

Optional enableIndex: boolean

Returns OrderedMap<K, V>

Methods

[iterator]

Description

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

back

Returns

Returns undefined | [K, V]

begin

Returns

Returns OrderedMapIterator<K, V>

clear

Description

Returns void

empty

Returns

Returns boolean

end

Returns

Returns OrderedMapIterator<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

find

Returns

Parameters

_key: K

Returns OrderedMapIterator<K, V>

forEach

Description

Parameters

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

Parameters

element: [K, V]

index: number

Returns void

Returns void

front

Returns

Returns undefined | [K, V]

getElementByKey

Description

Parameters

_key: K

Returns undefined | V

getElementByPos

`Optional` cmp: ((x: K, y: K) => number)

`Optional` enableIndex: boolean

`Optional` hint: OrderedMapIterator<K, V>