Class Matrix

Hierarchy

Matrix

Constructors

constructor

new Matrix(rows, cols): Matrix
Parameters
- rows: number
- cols: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:35

Properties

`Protected` immutable

immutable: boolean = false

`Protected` matrix

matrix: number[][]

Accessors

cols

get cols(): number
Returns number
- Defined in packages/matrix/src/lib/Matrix.ts:48

rows

get rows(): number
Returns number
- Defined in packages/matrix/src/lib/Matrix.ts:44

Methods

[iterator]

[iterator](): Generator<number, any, unknown>
Returns Generator<number, any, unknown>
- Defined in packages/matrix/src/lib/Matrix.ts:157

addBy

addBy(n): Matrix
Parameters
- n: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:213

addColBy

addColBy(col, n): Matrix
Parameters
- col: number
- n: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:253

addRowBy

addRowBy(row, n): Matrix
Parameters
- row: number
- n: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:233

appendCol

appendCol(col?): Matrix
Parameters
- Optional col: number[]
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:198

appendRow

appendRow(row?): Matrix
Parameters
- Optional row: number[]
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:185

clone

clone(): Matrix
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:99

deepEquals

deepEquals(other): boolean
Parameters
- other: number[][] | Matrix
Returns boolean
- Defined in packages/matrix/src/lib/Matrix.ts:65

divideBy

divideBy(n): Matrix
Parameters
- n: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:228

divideColBy

divideColBy(col, n): Matrix
Parameters
- col: number
- n: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:268

divideRowBy

divideRowBy(row, n): Matrix
Parameters
- row: number
- n: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:248

dotProduct

dotProduct(other): Matrix
Performs dot product of the matrix with another given matrix.
Parameters
- other: Matrix
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:344

every

every(f): boolean
Parameters
- f: ((value, row, col) => boolean)
  - - (value, row, col): boolean
    - Parameters
      
      value: number
      
      row: number
      
      col: number
      
      Returns boolean
Returns boolean
- Defined in packages/matrix/src/lib/Matrix.ts:304

forEach

forEach(f): Matrix
Parameters
- f: ((value, row, col) => boolean | void)
  - - (value, row, col): boolean | void
    - Parameters
      
      value: number
      
      row: number
      
      col: number
      
      Returns boolean | void
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:109

forEachInCol

forEachInCol(col, f): Matrix
Parameters
- col: number
- f: ((value, row) => boolean | void)
  - - (value, row): boolean | void
    - Parameters
      
      value: number
      
      row: number
      
      Returns boolean | void
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:129

forEachInDiagonal

forEachInDiagonal(f): Matrix
Parameters
- f: ((value, row, col) => boolean | void)
  - - (value, row, col): boolean | void
    - Parameters
      
      value: number
      
      row: number
      
      col: number
      
      Returns boolean | void
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:138

forEachInRow

forEachInRow(row, f): Matrix
Parameters
- row: number
- f: ((value, col) => boolean | void)
  - - (value, col): boolean | void
    - Parameters
      
      value: number
      
      col: number
      
      Returns boolean | void
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:120

get

get(row, col): number
Parameters
- row: number
- col: number
Returns number
- Defined in packages/matrix/src/lib/Matrix.ts:83

getImmutable

getImmutable(): boolean
Returns boolean
- Defined in packages/matrix/src/lib/Matrix.ts:56

has

has(row, col): boolean
Parameters
- row: number
- col: number
Returns boolean
- Defined in packages/matrix/src/lib/Matrix.ts:87

hasDimensions

hasDimensions(rows, cols): boolean
Parameters
- rows: number
- cols: number
Returns boolean
- Defined in packages/matrix/src/lib/Matrix.ts:315

isSameInstanceAs

isSameInstanceAs(other): boolean
Parameters
- other: Matrix
Returns boolean
- Defined in packages/matrix/src/lib/Matrix.ts:52

isScalarMatrix

isScalarMatrix(): boolean
Returns whether the matrix is a square matrix that has identical values on its diagonal.

Returns boolean
- Defined in packages/matrix/src/lib/Matrix.ts:326

isSquareMatrix

isSquareMatrix(): boolean
Returns boolean
- Defined in packages/matrix/src/lib/Matrix.ts:319

isZeroMatrix

isZeroMatrix(): boolean
Returns boolean
- Defined in packages/matrix/src/lib/Matrix.ts:337

map

map(f): Matrix
Parameters
- f: ((value, row, col) => number)
  - - (value, row, col): number
    - Parameters
      
      value: number
      
      row: number
      
      col: number
      
      Returns number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:147

mapCol

mapCol(col, f): Matrix
Parameters
- col: number
- f: ((value, row) => number)
  - - (value, row): number
    - Parameters
      
      value: number
      
      row: number
      
      Returns number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:177

mapRow

mapRow(row, f): Matrix
Parameters
- row: number
- f: ((value, col) => number)
  - - (value, col): number
    - Parameters
      
      value: number
      
      col: number
      
      Returns number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:169

multiplyBy

multiplyBy(n): Matrix
Parameters
- n: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:223

multiplyColBy

multiplyColBy(col, n): Matrix
Parameters
- col: number
- n: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:263

multiplyRowBy

multiplyRowBy(row, n): Matrix
Parameters
- row: number
- n: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:243

set

set(row, col, value): Matrix
Parameters
- row: number
- col: number
- value: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:77

setImmutable

setImmutable(immutable): Matrix
Parameters
- immutable: boolean
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:60

some

some(f): boolean
Parameters
- f: ((value, row, col) => boolean)
  - - (value, row, col): boolean
    - Parameters
      
      value: number
      
      row: number
      
      col: number
      
      Returns boolean
Returns boolean
- Defined in packages/matrix/src/lib/Matrix.ts:293

subtractBy

subtractBy(n): Matrix
Parameters
- n: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:218

subtractColBy

subtractColBy(col, n): Matrix
Parameters
- col: number
- n: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:258

subtractRowBy

subtractRowBy(row, n): Matrix
Parameters
- row: number
- n: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:238

swapCols

swapCols(col1, col2): Matrix
Parameters
- col1: number
- col2: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:282

swapRows

swapRows(row1, row2): Matrix
Parameters
- row1: number
- row2: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:273

toArray

toArray(): number[][]
Returns number[][]
- Defined in packages/matrix/src/lib/Matrix.ts:91

values

values(): Generator<number, any, unknown>
Returns Generator<number, any, unknown>
- Defined in packages/matrix/src/lib/Matrix.ts:165

`Static` fromArray

fromArray(array): Matrix
Parameters
- array: number[][]
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:5

`Static` fromIterable

fromIterable(iterable): Matrix
Parameters
- iterable: Iterable<Iterable<number>>
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:19

`Static` identity

identity(size): Matrix
Parameters
- size: number
Returns Matrix
- Defined in packages/matrix/src/lib/Matrix.ts:27

Generated using TypeDoc