Class OrderedMapIterator<K, V>

Type Parameters

K
V

Hierarchy

TreeIterator<K, V>
- OrderedMapIterator

Index

Properties

iteratorType next pre

Accessors

Methods

Properties

`Readonly` iteratorType

iteratorType: IteratorType

Description

Iterator's type.

next

next: (() => OrderedMapIterator<K, V>)

Type declaration

- (): OrderedMapIterator<K, V>
- Returns OrderedMapIterator<K, V>

pre

pre: (() => OrderedMapIterator<K, V>)

Type declaration

- (): OrderedMapIterator<K, V>
- Returns OrderedMapIterator<K, V>

Accessors

index

get index(): number
Description
Get the sequential index of the iterator in the tree container.
Note: This function only takes effect when the specified tree container enableIndex = true.

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

pointer

get pointer(): [K, V]
Description
Pointers to element.

Returns
The value of the pointer's element.

Returns [K, V]
Overrides TreeIterator.pointer
- Defined in src/container/TreeContainer/OrderedMap.ts:8

Methods

copy

copy(): OrderedMapIterator<K, V>
Description
Get a copy of itself.
We do not guarantee the safety of this function.
Please ensure that the iterator will not fail.

Returns
The copy of self.

Returns OrderedMapIterator<K, V>
Overrides TreeIterator.copy
- Defined in src/container/TreeContainer/OrderedMap.ts:26

equals

equals(obj: TreeIterator<K, V>): boolean
Returns
Boolean about if this equals to obj.

Example
```
container.find(1).equals(container.end());
```
Parameters
- obj: TreeIterator<K, V>
  
  The other iterator you want to compare.
Returns boolean
Inherited from TreeIterator.equals
- Defined in src/container/TreeContainer/Base/TreeIterator.ts:94

Generated using TypeDoc