Class Matrix

A Matrix class that uses sparse matrix representation under the hood.

Hierarchy

Matrix

Index

Constructors

Properties

Accessors

Methods

add find get map multiply set to2d transpose validate empty from2d

Constructors

constructor

new Matrix(data: SparseMatrix): Matrix
Create a matrix by sparese matrix array
Parameters
- data: SparseMatrix
Returns Matrix
- Defined in src/matrix.ts:15

Properties

data

data: SparseMatrix

Accessors

col

get col(): number
Get the number of column

Returns number
- Defined in src/matrix.ts:26

row

get row(): number
Get the number of row

Returns number
- Defined in src/matrix.ts:21

size

get size(): number
Get the number of non-empty elements

Returns number
- Defined in src/matrix.ts:31

Methods

add

add(other: Matrix): Matrix
Create a new matrix, which is the result of the addition of this and an other matrix
Parameters
- other: Matrix
Returns Matrix
- Defined in src/matrix.ts:41

`Private` find

find(row: number, col: number): [boolean, number]
Parameters
- row: number
- col: number
Returns [boolean, number]
- Defined in src/matrix.ts:139

get

get(row: number, col: number): number
Get the element value of this matrix
Parameters
- row: number
- col: number
Returns number
- Defined in src/matrix.ts:86

map

map(func: ((value: number, row: number, col: number) => number)): Matrix
Apply a map function to each non-zero element of this matrix
Parameters
- func: ((value: number, row: number, col: number) => number)
  - - (value: number, row: number, col: number): number
    - Parameters
      
      value: number
      
      row: number
      
      col: number
      
      Returns number
Returns Matrix
- Defined in src/matrix.ts:51

multiply

multiply(other: Matrix): Matrix
Create a new matrix, which is the result of the multiplication of this and an other matrix
Parameters
- other: Matrix
Returns Matrix
- Defined in src/matrix.ts:46

set

set(row: number, col: number, value: number): Matrix
Set the element value of this matrix
Parameters
- row: number
- col: number
- value: number
Returns Matrix
- Defined in src/matrix.ts:61

to2d

to2d(): number[][]
Get this matrix in 2D array form

Returns number[][]
- Defined in src/matrix.ts:96

transpose

transpose(): Matrix
Create a new matrix, which is the transposed matrix of the original one

Returns Matrix
- Defined in src/matrix.ts:36

validate

validate(): Matrix
Validate the matrix

Returns Matrix
- Defined in src/matrix.ts:114

`Static` empty

empty(row: number, col: number): Matrix
Create an empty matrix with given shape
Parameters
- row: number
- col: number
Returns Matrix
- Defined in src/matrix.ts:120

`Static` from2d

from2d(data: number[][]): Matrix
Create a matrix from 2D array form
Parameters
- data: number[][]
Returns Matrix
- Defined in src/matrix.ts:125

Generated using TypeDoc