Skip to content

Latest commit

 

History

History
139 lines (71 loc) · 4.19 KB

File metadata and controls

139 lines (71 loc) · 4.19 KB

danmatrix


danmatrix / DanMatrixElementsIterator

Class: DanMatrixElementsIterator<T>

Defined in: src/iterators/danMatrixElementsIterator.ts:6

The class DanMatrixElementsIterator implements MatrixIterator interface and Iterable interface

Type Parameters

T

T

Implements

Constructors

Constructor

new DanMatrixElementsIterator<T>(matrix): DanMatrixElementsIterator<T>

Defined in: src/iterators/danMatrixElementsIterator.ts:20

The public class constructor

Parameters

matrix

DanMatrix<T>

the DanMatrix object

Returns

DanMatrixElementsIterator<T>

Methods

[iterator]()

[iterator](): Iterator<DanMatrixElement<T>>

Defined in: src/iterators/danMatrixElementsIterator.ts:99

A zero-argument function that returns an object, conforming to the Iterator Protocol. In Javascript/Typescript in order to be iterable, an object must implement the "@@iterator" method

Returns

Iterator<DanMatrixElement<T>>

an iterator object.

Implementation of

Iterable.[iterator]


current()

current(): DanMatrixElement<T> | undefined

Defined in: src/iterators/danMatrixElementsIterator.ts:40

Get the current row, or return undefined if the iterator was not yet started

Returns

DanMatrixElement<T> | undefined

Implementation of

MatrixIterator.current


hasNext()

hasNext(): boolean

Defined in: src/iterators/danMatrixElementsIterator.ts:83

Check if the iterator can return more elements

Returns

boolean

true if the iterator can return more elements, false if there are no elements left

Implementation of

MatrixIterator.hasNext


next()

next(): DanMatrixElement<T> | undefined

Defined in: src/iterators/danMatrixElementsIterator.ts:62

Get the next element, or return undefined if the iterator's end was reached

Returns

DanMatrixElement<T> | undefined

Implementation of

MatrixIterator.next


rewind()

rewind(): void

Defined in: src/iterators/danMatrixElementsIterator.ts:90

Restart the iterator

Returns

void

Implementation of

MatrixIterator.rewind