Skip to content

Latest commit

 

History

History
205 lines (110 loc) · 4.83 KB

DanMatrixColumnsIterator.md

File metadata and controls

205 lines (110 loc) · 4.83 KB

danmatrix / Exports / DanMatrixColumnsIterator

Class: DanMatrixColumnsIterator<T>

The class DanMatrixColumnsIterator implements MatrixIterator interface and Iterable interface

Type parameters

Name
T

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

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

The public class constructor

Type parameters

Name
T

Parameters

Name Type Description
matrix DanMatrix<T> the DanMatrix object

Returns

DanMatrixColumnsIterator<T>

Defined in

src/iterators/danMatrixColumnsIterator.ts:16

Properties

_columnIndex

Private _columnIndex: number

Defined in

src/iterators/danMatrixColumnsIterator.ts:10


_matrix

Private _matrix: DanMatrix<T>

Defined in

src/iterators/danMatrixColumnsIterator.ts:8

Methods

[iterator]

[iterator](): Iterator<T[], any, undefined>

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<T[], any, undefined>

an iterator object.

Implementation of

Iterable.[iterator]

Defined in

src/iterators/danMatrixColumnsIterator.ts:75


_initFields

_initFields(): void

Init the class fields

Returns

void

Defined in

src/iterators/danMatrixColumnsIterator.ts:27


current

current(): undefined | T[]

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

Returns

undefined | T[]

Implementation of

MatrixIterator.current

Defined in

src/iterators/danMatrixColumnsIterator.ts:35


hasNext

hasNext(): boolean

Check if the iterator can return more columns

Returns

boolean

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

Implementation of

MatrixIterator.hasNext

Defined in

src/iterators/danMatrixColumnsIterator.ts:59


next

next(): undefined | T[]

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

Returns

undefined | T[]

Implementation of

MatrixIterator.next

Defined in

src/iterators/danMatrixColumnsIterator.ts:47


rewind

rewind(): void

Restart the iterator

Returns

void

Implementation of

MatrixIterator.rewind

Defined in

src/iterators/danMatrixColumnsIterator.ts:66