Matrix | numflow-functions

Hierarchy

Matrix
- Fill
- Diag
- Eye
- Vector
- Rand

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Matrix(values: MatrixParams, width?: undefined | number, height?: undefined | number): Matrix

- Defined in linear-algebra/Matrix.ts:8
Create a new Matrix to perform calculations with

Parameters
- values: MatrixParams
  
  The values from which the matrix should be constructed
- Optional width: undefined | number
  
  The width of the matrix to be constructed
- Optional height: undefined | number
  
  The height of the matrix to be constructed
Returns Matrix

Properties

height

height: number

Protected values

values: number[]

width

width: number

Methods

*

*(a: Matrix | number): Matrix

- Defined in linear-algebra/Matrix.ts:179
Multiply the matrix by a number or by another matrix

Parameters
- a: Matrix | number
  
  The value or the matrix with which the multiplication should take place
Returns Matrix

+

+(a: Matrix | number): Matrix

- Defined in linear-algebra/Matrix.ts:129
Add a number or a matrix to the current matrix

Parameters
- a: Matrix | number
  
  The value or the matrix to be added to this matrix
Returns Matrix

-

-(a: Matrix | number): Matrix

- Defined in linear-algebra/Matrix.ts:154
Subtract a number or a matrix from the current matrix

Parameters
- a: Matrix | number
  
  The value or the matrix to be subtracted from this matrix
Returns Matrix

/

/(a: number): Matrix

- Defined in linear-algebra/Matrix.ts:204
Parameters
- a: number
Returns Matrix

^

^(a: number): Matrix

- Defined in linear-algebra/Matrix.ts:218
Do the matrix to the power of a number

Parameters
- a: number
  
  The power which should be applied on the matrix
Returns Matrix

dot

dot(a: Matrix): number

- Defined in linear-algebra/Matrix.ts:108
Parameters
- a: Matrix
Returns number

getValues

getValues(): number[]

- Defined in linear-algebra/Matrix.ts:272
Return the values of this matrix as a 1D array

Returns number[]

toString

toString(): string

Converts matrix to a String. See example below:

┌                                ┐
│ -1,00 -1,92 -1,80 -0,92  0,25  │
│  0,05  0,99  0,25 -0,50 -0,19  │
│  0,98 -1,94 -1,35  0,22 -0,88  │
│ -0,85 -1,63  0,07 -0,39 -0,24  │
│  0,45 -0,33 -1,14  0,07 -0,61  │
└                                ┘

Returns string

Static Private basicMultiplication

basicMultiplication(a: Matrix, b: Matrix): Matrix

- Defined in linear-algebra/Matrix.ts:229
Parameters
- a: Matrix
- b: Matrix
Returns Matrix

Static Private stringTo2DArray

stringTo2DArray(input: string): number[][]

- Defined in linear-algebra/Matrix.ts:78
todo

Make the from string also work when there are both newlines and ; present

Parameters
- input: string
Returns number[][]

Static Private toMatrixDataFrom2DArray

toMatrixDataFrom2DArray(input: number[][]): { height: number; values: number[]; width: number }

- Defined in linear-algebra/Matrix.ts:58
Parameters
- input: number[][]
Returns { height: number; values: number[]; width: number }
- height: number
- values: number[]
- width: number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

values: MatrixParams

Optional width: undefined | number

Optional height: undefined | number

Returns Matrix

Properties

height

Protected values

width

Methods

*

Parameters

a: Matrix | number

Returns Matrix

+

Parameters

a: Matrix | number

Returns Matrix

-

Parameters

a: Matrix | number

Returns Matrix

/

Parameters

a: number

Returns Matrix

^

Parameters

a: number

Returns Matrix

dot

Parameters

a: Matrix

Returns number

getValues

Returns number[]

toString

Returns string

Static Private basicMultiplication

Parameters

a: Matrix

b: Matrix

Returns Matrix

Static Private stringTo2DArray

Parameters

input: string

Returns number[][]

Static Private toMatrixDataFrom2DArray

Parameters

input: number[][]

Returns { height: number; values: number[]; width: number }

height: number

values: number[]

width: number