Class TreeIterator<K, V>`Abstract`

Type Parameters

K
V

Hierarchy

ContainerIterator<K | [K, V]>
- TreeIterator
  - OrderedSetIterator
  - OrderedMapIterator

Index

Properties

iteratorType next pre

Accessors

Methods

Properties

`Readonly` iteratorType

iteratorType: IteratorType

Description

Iterator's type.

next

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

Type declaration

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

pre

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

Type declaration

- (): TreeIterator<K, V>
- Returns TreeIterator<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
- Defined in src/container/TreeContainer/Base/TreeIterator.ts:69

`Abstract` pointer

get pointer(): T
Description
Pointers to element.

Returns
The value of the pointer's element.

Returns T
Inherited from ContainerIterator.pointer
- Defined in src/container/ContainerBase/index.ts:22
set pointer(newValue: T): void
Description
Set pointer's value (some containers are unavailable).
Parameters
- newValue: T
  
  The new value you want to set.
Returns void
Inherited from ContainerIterator.pointer
- Defined in src/container/ContainerBase/index.ts:27

Methods

`Abstract` copy

copy(): ContainerIterator<K | [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 ContainerIterator<K | [K, V]>
Inherited from ContainerIterator.copy
- Defined in src/container/ContainerBase/index.ts:48

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
Overrides ContainerIterator.equals
- Defined in src/container/TreeContainer/Base/TreeIterator.ts:94

Generated using TypeDoc