Class Matrix

classdesc: Works with any n x m dimensional array.

Hierarchy

Matrix
- Tensor

Index

Constructors

constructor

Properties

Accessors

data

Methods

Constructors

constructor

new Matrix(matrix2D: number[][]): Matrix
new Matrix(row: number, col: number, defaultFill?: undefined | number): Matrix

- Defined in matrix.ts:19
constructs

Creates a new 2 dimensional Matrix object.

Parameters
- matrix2D: number[][]
  
  A general 2 dimensional array which represents the data in the matrix object to be created
Returns Matrix
- Defined in matrix.ts:25
constructs

Creates a new 2 dimensional Matrix object with given rows and columns

Parameters
- row: number
  
  Number of rows the matrix should have.
- col: number
  
  Number of columns the matrix should have.
- Optional defaultFill: undefined | number
  
  Optional | The default value with which to fill all elements in the matrix.
Returns Matrix

Properties

col

col: number

elements

elements: number[][]

row

row: number

Accessors

data

get data(): dataAt

- Defined in matrix.ts:55
Returns dataAt

Methods

add

add(that: Matrix): Matrix

- Defined in matrix.ts:69
Adds two matrices algebraically.

throws

If the orders of the matrices do not match.

Parameters
- that: Matrix
  
  Matrix to add to this matrix.
Returns Matrix

The matrix sum of the two matrices.

cofactor

cofactor(i: number, j: number): number

- Defined in matrix.ts:136
Calculates the cofactor of an element in the matrix given by its row and column.

Parameters
- i: number
  
  Row index of element.
- j: number
  
  Column index of element,
Returns number

copy

copy(): Matrix

- Defined in matrix.ts:51
Returns Matrix

An exact copy of this matrix object.

inv

inv(): Matrix

- Defined in matrix.ts:142
Calculates the inverse of the given matrix.

throws

If Matrix.det(this) == 0

Returns Matrix

minor

minor(i: number, j: number): number

- Defined in matrix.ts:129
Calculates the minor of an element in the matrix given by its row and column.

Parameters
- i: number
  
  Row index of element.
- j: number
  
  Column index of element,
Returns number

mul

mul(that: Matrix): Matrix

- Defined in matrix.ts:90
Multiplies two matrices. The number of columns of this matrix must be equal to the number of rows of that matrix. The resulting matrix has the same number of rows as this matrix and the same number of columns as that matrix.

Parameters
- that: Matrix
  
  Matrix with which to multiply.
Returns Matrix

The matrix product of the two matrices.

scale

scale(k: number): Matrix

- Defined in matrix.ts:99
Scales this matrix by a given scale factor. Scaling implies multiplying each element of this matrix by some scale factor k

Parameters
- k: number
  
  The scale factor.
Returns Matrix

sub

sub(that: Matrix): Matrix

- Defined in matrix.ts:79
Subtracts one matrix from another algebraically.

throws

If the orders of the matrices do not match.

Parameters
- that: Matrix
  
  Matrix to subtract from this matrix.
Returns Matrix

The matrix difference of the two matrices.

Static add

add(A: Matrix, B: Matrix): Matrix

- Defined in matrix.ts:203
Performs matrix addition on given matrices A and B.

Parameters
- A: Matrix
- B: Matrix
Returns Matrix

Static adjoint

adjoint(A: Matrix): Matrix

- Defined in matrix.ts:169
Calculates the adjoint of some matrix A.

Parameters
- A: Matrix
Returns Matrix

Static comatrix

comatrix(A: Matrix): Matrix

- Defined in matrix.ts:161
Calculates the cofactors of each element in some matrix A and stores them in their corresponding indices in the form of another matrix.

Parameters
- A: Matrix
Returns Matrix

Static det

det(A: Matrix): number

- Defined in matrix.ts:187
Computes the determinant value of some matrix A.

Parameters
- A: Matrix
Returns number

Static mul

mul(A: Matrix, B: Matrix): Matrix

- Defined in matrix.ts:224
Performs matrix multiplication on given matrices A and B.

throws

If A.col != B.row

Parameters
- A: Matrix
- B: Matrix
Returns Matrix

Static sub

sub(A: Matrix, B: Matrix): Matrix

- Defined in matrix.ts:213
Performs matrix subtraction on given matrices A and B.

Parameters
- A: Matrix
- B: Matrix
Returns Matrix

Static transpose

transpose(A: Matrix): Matrix

- Defined in matrix.ts:175
Computes the transpose of some matrix A.

Parameters
- A: Matrix
Returns Matrix

Static unit

unit(dim: number): Matrix

- Defined in matrix.ts:152
Creates and returns a unit matrix with dim rows and columns.

Parameters
- dim: number
  
  Dimension of the desired matrix
Returns Matrix

Generated using TypeDoc