Class Matrix

An NxM matrix.

Hierarchy

Matrix

Index

Constructors

Properties

#values cols rows

Accessors

Methods

add get mul set setAll sub toString

Constructors

constructor

new Matrix(rows: number, cols: number): Matrix
Parameters
- rows: number
- cols: number
Returns Matrix
- Defined in lib/math/Matrix.ts:13

Properties

`Private` #values

#values: number[][]

cols

cols: number

The number of columns in the Matrix.

rows

rows: number

The number of rows in the Matrix.

Accessors

string

get string(): string
Converts the Matrix to a string representation. Same as toString().

Returns string
- Defined in lib/math/Matrix.ts:94

values

get values(): number[][]
Valies in the Matrix in the form values[row][col].

Returns number[][]
- Defined in lib/math/Matrix.ts:33
set values(vals: number[][]): void
Parameters
- vals: number[][]
Returns void
- Defined in lib/math/Matrix.ts:37

Methods

add

add(m: Matrix): null | Matrix
Adds the Matrix to another Matrix. Returns null if the matrices are not the same size.
Parameters
- m: Matrix
Returns null | Matrix
- Defined in lib/math/Matrix.ts:69

get

get(row: number, col: number): null | number
Gets a value in the Matrix
Parameters
- row: number
- col: number
Returns null | number
- Defined in lib/math/Matrix.ts:28

mul

mul(m: Matrix): null | Matrix
Multiplies the Matrix with another Matrix. Returns null if the matrices cannot be multiplied.

Matrices cannot be multiplied if the number of columns in the Matrix do not equal the number of rows in the Matrix being multiplied with.
Parameters
- m: Matrix
Returns null | Matrix
- Defined in lib/math/Matrix.ts:53

set

set(row: number, col: number, val: number): Matrix
Sets a value in the Matrix.
Parameters
- row: number
- col: number
- val: number
Returns Matrix
- Defined in lib/math/Matrix.ts:21

setAll

setAll(vals: number[][]): Matrix
Sets all the values in the Matrix.
Parameters
- vals: number[][]
Returns Matrix
- Defined in lib/math/Matrix.ts:44

sub

sub(m: Matrix): null | Matrix
Adds another Matrix from the Matrix. Returns null if the matrices are not the same size.
Parameters
- m: Matrix
Returns null | Matrix
- Defined in lib/math/Matrix.ts:79

toString

toString(): string
Converts the Matrix to a string representation. Same as the string property.

Returns string
- Defined in lib/math/Matrix.ts:89

Generated using TypeDoc