Class Iterator<Key, T, Unique, Source>

Iterator of map container storing elements in a vector.

author: Jeongho Nam - https://github.com/samchon

Type parameters

Key

Key type
T

Mapped type
Unique: boolean

Whether duplicated key is blocked or not
Source: ITreeMap<Key, T, Unique, Source, Iterator<Key, T, Unique, Source>, ReverseIterator<Key, T, Unique, Source>>

Source container type

Hierarchy

ArrayIteratorBase<Entry<Key, T>, Source, MapElementVector<Key, T, Unique, Source>, Iterator<Key, T, Unique, Source>, ReverseIterator<Key, T, Unique, Source>, IPair<Key, T>>
- Iterator

Implements

Iterator<Entry<Key, T>, Source, Iterator<Key, T, Unique, Source>, ReverseIterator<Key, T, Unique, Source>, IPair<Key, T>>
IRandomAccessIterator<Entry<Key, T>, Iterator<Key, T, Unique, Source>>
IteratorBase<Key, T, this> & Readonly<Iterator<Entry<Key, T>, Source, Iterator<Key, T, Unique, Source>, ReverseIterator<Key, T, Unique, Source>, IPair<Key, T>>>

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Iterator(array: MapElementVector<Key, T, Unique, Source>, index: number): Iterator

Inherited from ArrayIteratorBase.constructor
- Defined in internal/iterator/ArrayIteratorBase.ts:29
Initializer Constructor.

Parameters
- array: MapElementVector<Key, T, Unique, Source>
- index: number
  
  Index number.
Returns Iterator

Accessors

first

get first(): Key

- Defined in internal/container/associative/MapElementVector.ts:139
inheritdoc

Returns Key

second

get second(): T
set second(val: T): void

- Defined in internal/container/associative/MapElementVector.ts:147
inheritdoc

Returns T
- Defined in internal/container/associative/MapElementVector.ts:155
inheritdoc

Parameters
- val: T
Returns void

value

get value(): Entry<Key, T>
set value(val: Entry<Key, T>): void

Inherited from ArrayIteratorBase.value
- Defined in internal/iterator/ArrayIteratorBase.ts:78
Reference of the value.

inheritdoc

Returns Entry<Key, T>
Inherited from ArrayIteratorBase.value
- Defined in internal/iterator/ArrayIteratorBase.ts:86
Reference of the value.

inheritdoc

Parameters
- val: Entry<Key, T>
Returns void

Methods

advance

advance(n: number): Iterator<Key, T, Unique, Source>

Implementation of IRandomAccessIterator.advance

Inherited from ArrayIteratorBase.advance
- Defined in internal/iterator/ArrayIteratorBase.ts:113
Advance iterator.

Parameters
- n: number
  
  Step to advance.
Returns Iterator<Key, T, Unique, Source>

The advanced iterator.

equals

equals(obj: Iterator<Key, T, Unique, Source>): boolean

Inherited from ArrayIteratorBase.equals
- Defined in internal/iterator/ArrayIteratorBase.ts:124
inheritdoc

Parameters
- obj: Iterator<Key, T, Unique, Source>
Returns boolean

index

index(): number

Implementation of IRandomAccessIterator.index

Inherited from ArrayIteratorBase.index
- Defined in internal/iterator/ArrayIteratorBase.ts:70
Get index.

Returns number

The index.

next

next(): Iterator<Key, T, Unique, Source>

Implementation of IRandomAccessIterator.next

Inherited from ArrayIteratorBase.next
- Defined in internal/iterator/ArrayIteratorBase.ts:105
Get next iterator.

Returns Iterator<Key, T, Unique, Source>

The next iterator.

prev

prev(): Iterator<Key, T, Unique, Source>

Implementation of IRandomAccessIterator.prev

Inherited from ArrayIteratorBase.prev
- Defined in internal/iterator/ArrayIteratorBase.ts:97
Get previous iterator.

Returns Iterator<Key, T, Unique, Source>

The previous iterator.

reverse

reverse(): ReverseIterator<Key, T, Unique, Source>

Implementation of Iterator.reverse

Overrides ArrayIteratorBase.reverse
- Defined in internal/container/associative/MapElementVector.ts:128
inheritdoc

Returns ReverseIterator<Key, T, Unique, Source>

source

source(): Source

Implementation of Iterator.source

Overrides ArrayIteratorBase.source
- Defined in internal/container/associative/MapElementVector.ts:120
Get source container.

Returns Source

The source container.

Generated using TypeDoc