Class Matrix

constructor

• new Matrix(
      values: number[],
      options?: { numCols: number; numRows: number },
  ): Matrix

  Parameters

  • values: number[]
  • Optionaloptions: { numCols: number; numRows: number }

  Returns Matrix

numCols

numRows

values

add

• add(otherMatrix: Matrix): Matrix

  add two matrices

  Parameters

  • otherMatrix: Matrix

    matrix to add

  Returns Matrix

  result matrix

colAt

• colAt(column: number): number[]

  get column at a given index

  Parameters

  • column: number

    index of column starting from 0

  Returns number[]

  column as an array of numbers

determinant

• determinant(): number

  calculate determinant, implemented for mat2, mat3, mat4

  Returns number

div

• div(param: number | Matrix): Matrix

  Parameters

  • param: number | Matrix

  Returns Matrix

equals

• equals(otherMatrix: Matrix): boolean

  check for equality

  Parameters

  • otherMatrix: Matrix

    matrix to compare

  Returns boolean

  true or false

inverse

• inverse(): Matrix

  calculate M^-1 for mat2, mat3, mat4

  Returns Matrix

isFinite

• isFinite(): boolean

  Checks if the matrix contains NaN or Infinity values

  Returns boolean

  true if all values are finite (neither NaN nor Infinity)

isNaN

• isNaN(): boolean

  Checks if the matrix contains NaN values

  Returns boolean

  true if one of the values is NaN

mul

• mul(param: number | Vector | Matrix): Vector | Matrix

  matrix multiplication

  Parameters

  • param: number | Vector | Matrix

    can be a matrix, a number or a vector

  Returns Vector | Matrix

  a vector in case of matrix vector multiplication, else a matrix

  Throws

  dimension Mismatch if dimensions doesn't match

roughlyEquals

• roughlyEquals(otherMatrix: Matrix, delta?: number): boolean

  check for rough equality (because in JS, .1+.2 !== .3)

  Parameters

  • otherMatrix: Matrix

    matrix to compare

  • delta: number = 1e-14

    tolerance, by default 1e-14

  Returns boolean

  true or false

rowAt

• rowAt(row: number): number[]

  get row at a given index

  Parameters

  • row: number

    index of row starting from 0

  Returns number[]

  row as an array of numbers

sub

• sub(otherMatrix: Matrix): Matrix

  subtract another matrix

  Parameters

  • otherMatrix: Matrix

    matrix to subtract

  Returns Matrix

  result matrix

toArray

• toArray(): number[]

  convert to array

  Returns number[]

toString

• toString(): string

  convert matrix to string

  Returns string

  a string containing matROWSxCOLS(comma-separated-values)

transpose

• transpose(): Matrix

  returns transposed matrix

  Returns Matrix

valueAt

• valueAt(row: number, column: number): number

  get value at a given position

  Parameters

  • row: number

    row index starting from 0

  • column: number

    column index starting from 0

  Returns number

StaticfromVector

• fromVector(value: Vector): Matrix

  Converts a vector with dimension n into a matrix with 1 col and n rows useful for matrix multiplication

  Parameters

  • value: Vector

    the input vector

  Returns Matrix

StaticfromVectors

• fromVectors(vectors: Vector[]): Matrix

  Converts a bunch of vectors into a matrix

  Parameters

  • vectors: Vector[]

  Returns Matrix

Staticidentity

• identity(dimension: number): Matrix

  create identity matrix

  Parameters

  • dimension: number

    dimension of the matrix

  Returns Matrix