Class SparseMatrix

Index

Constructors

Properties

columns elements klass rows tensorProduct threshold identity

Accessors

cardinality size

Methods

_init abs acos acosh add addM addS and andM andS asin asinh atan atanh bandWidth cbrt ceil clone clz32 cos cosh div divide divideM divideS divM divS exp expm1 floor forEachNonZero fround get getNonZeros isBanded isEmpty isSquare isSymmetric kroneckerProduct leftShift leftShiftM leftShiftS log log10 log1p log2 mmul mod modM modS modulus modulusM modulusS mul mulM mulS multiply multiplyM multiplyS not or orM orS rightShift rightShiftM rightShiftS round set setThreshold sign signPropagatingRightShift signPropagatingRightShiftM signPropagatingRightShiftS sin sinh sqrt sub subM subS subtract subtractM subtractS tan tanh to2DArray transpose trunc xor xorM xorS zeroFillRightShift zeroFillRightShiftM zeroFillRightShiftS abs acos acosh add and asin asinh atan atanh cbrt ceil clz32 cos cosh div divide exp expm1 eye floor fround leftShift log log10 log1p log2 mod modulus mul multiply not or rightShift round sign signPropagatingRightShift sin sinh sqrt sub subtract tan tanh trunc xor zeroFillRightShift

Constructors

constructor

new SparseMatrix(rows: any, columns: any, options?: {}): SparseMatrix
Parameters
- rows: any
- columns: any
- options: {} = {}
Returns SparseMatrix
- Defined in index.js:6

Properties

columns

columns: any

elements

elements: any

klass

klass: string

rows

rows: any

tensorProduct

tensorProduct: (other: SparseMatrix) => SparseMatrix

Type declaration

- (other: SparseMatrix): SparseMatrix
- Parameters
  - other: SparseMatrix
  Returns SparseMatrix

threshold

threshold: any

`Static`identity

identity: (rows?: number, columns?: number) => SparseMatrix

Accessors

cardinality

get cardinality(): number
Returns number
- Defined in index.js:120

size

get size(): number
Returns number
- Defined in index.js:127

Methods

_init

_init(rows: any, columns: any, elements: any, threshold: any): void
Parameters
- rows: any
- columns: any
- elements: any
- threshold: any
Returns void
- Defined in index.js:39

abs

abs(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:936

acos

acos(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:952

acosh

acosh(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:968

add

add(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:295

addM

addM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:313

addS

addS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:304

and

and(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:646

andM

andM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:664

andS

andS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:655

asin

asin(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:984

asinh

asinh(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1000

atan

atan(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1016

atanh

atanh(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1032

bandWidth

bandWidth(): number
Search for the wither band in the main diagonals

Returns number
- Defined in index.js:95

cbrt

cbrt(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1048

ceil

ceil(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1064

clone

clone(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:55

clz32

clz32(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1080

cos

cos(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1096

cosh

cosh(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1112

div

div(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:490

divide

divide(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:529

divideM

divideM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:547

divideS

divideS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:538

divM

divM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:508

divS

divS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:499

exp

exp(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1128

expm1

expm1(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1144

floor

floor(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1160

forEachNonZero

forEachNonZero(callback: ForEachNonZeroCallback): SparseMatrix
Calls callback for each value in the matrix that is not zero. The callback can return:
- false to stop the iteration immediately
- the same value to keep it unchanged
- 0 to remove the value
- something else to change the value
Parameters
- callback: ForEachNonZeroCallback
Returns SparseMatrix
- Defined in index.js:217

fround

fround(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1176

get

get(row: number, column: number): number
Parameters
- row: number
- column: number
Returns number
- Defined in index.js:136

getNonZeros

getNonZeros(): { columns: number[]; rows: number[]; values: number[] }
Returns { columns: number[]; rows: number[]; values: number[] }
- Defined in index.js:237

isBanded

isBanded(width: number): boolean
Test if a matrix is consider banded using a threshold
Parameters
- width: number
Returns boolean
- Defined in index.js:112

isEmpty

isEmpty(): boolean
Returns boolean
- Defined in index.js:285

isSquare

isSquare(): boolean
Returns boolean
- Defined in index.js:73

isSymmetric

isSymmetric(): boolean
Returns boolean
- Defined in index.js:77

kroneckerProduct

kroneckerProduct(other: SparseMatrix): SparseMatrix
Parameters
- other: SparseMatrix
Returns SparseMatrix
- Defined in index.js:188

leftShift

leftShift(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:763

leftShiftM

leftShiftM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:781

leftShiftS

leftShiftS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:772

log

log(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1192

log10

log10(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1224

log1p

log1p(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1208

log2

log2(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1240

mmul

mmul(other: SparseMatrix): SparseMatrix
Parameters
- other: SparseMatrix
Returns SparseMatrix
- Defined in index.js:160

mod

mod(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:568

modM

modM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:586

modS

modS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:577

modulus

modulus(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:607

modulusM

modulusM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:625

modulusS

modulusS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:616

mul

mul(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:412

mulM

mulM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:430

mulS

mulS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:421

multiply

multiply(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:451

multiplyM

multiplyM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:469

multiplyS

multiplyS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:460

not

not(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:920

or

or(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:685

orM

orM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:703

orS

orS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:694

rightShift

rightShift(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:843

rightShiftM

rightShiftM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:861

rightShiftS

rightShiftS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:852

round

round(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1256

set

set(row: number, column: number, value: number): SparseMatrix
Parameters
- row: number
- column: number
- value: number
Returns SparseMatrix
- Defined in index.js:146

setThreshold

setThreshold(newThreshold: number): SparseMatrix
Parameters
- newThreshold: number
Returns SparseMatrix
- Defined in index.js:260

sign

sign(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1272

signPropagatingRightShift

signPropagatingRightShift(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:802

signPropagatingRightShiftM

signPropagatingRightShiftM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:822

signPropagatingRightShiftS

signPropagatingRightShiftS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:813

sin

sin(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1288

sinh

sinh(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1304

sqrt

sqrt(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1320

sub

sub(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:334

subM

subM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:352

subS

subS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:343

subtract

subtract(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:373

subtractM

subtractM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:391

subtractS

subtractS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:382

tan

tan(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1336

tanh

tanh(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1352

to2DArray

to2DArray(): number[][]
Returns number[][]
- Defined in index.js:62

transpose

transpose(): SparseMatrix
Returns SparseMatrix
- New transposed sparse matrix
- Defined in index.js:271

trunc

trunc(): SparseMatrix
Returns SparseMatrix
- Defined in index.js:1368

xor

xor(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:724

xorM

xorM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:742

xorS

xorS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:733

zeroFillRightShift

zeroFillRightShift(value: number | SparseMatrix): SparseMatrix
Parameters
- value: number | SparseMatrix
Returns SparseMatrix
- Defined in index.js:882

zeroFillRightShiftM

zeroFillRightShiftM(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:900

zeroFillRightShiftS

zeroFillRightShiftS(value: number): SparseMatrix
Parameters
- value: number
Returns SparseMatrix
- Defined in index.js:891

`Static`abs

abs(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:945

`Static`acos

acos(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:961

`Static`acosh

acosh(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:977

`Static`add

add(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:326

`Static`and

and(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:677

`Static`asin

asin(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:993

`Static`asinh

asinh(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1009

`Static`atan

atan(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1025

`Static`atanh

atanh(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1041

`Static`cbrt

cbrt(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1057

`Static`ceil

ceil(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1073

`Static`clz32

clz32(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1089

`Static`cos

cos(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1105

`Static`cosh

cosh(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1121

`Static`div

div(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:521

`Static`divide

divide(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:560

`Static`exp

exp(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1137

`Static`expm1

expm1(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1153

`Static`eye

eye(rows?: number, columns?: number): SparseMatrix
Parameters
- rows: number = 1
- columns: number = rows
Returns SparseMatrix
- Defined in index.js:46

`Static`floor

floor(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1169

`Static`fround

fround(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1185

`Static`leftShift

leftShift(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:794

`Static`log

log(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1201

`Static`log10

log10(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1233

`Static`log1p

log1p(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1217

`Static`log2

log2(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1249

`Static`mod

mod(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:599

`Static`modulus

modulus(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:638

`Static`mul

mul(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:443

`Static`multiply

multiply(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:482

`Static`not

not(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:929

`Static`or

or(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:716

`Static`rightShift

rightShift(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:874

`Static`round

round(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1265

`Static`sign

sign(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1281

`Static`signPropagatingRightShift

signPropagatingRightShift(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:835

`Static`sin

sin(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1297

`Static`sinh

sinh(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1313

`Static`sqrt

sqrt(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1329

`Static`sub

sub(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:365

`Static`subtract

subtract(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:404

`Static`tan

tan(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1345

`Static`tanh

tanh(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1361

`Static`trunc

trunc(matrix: SparseMatrix): SparseMatrix
Parameters
- matrix: SparseMatrix
Returns SparseMatrix
- Defined in index.js:1377

`Static`xor

xor(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:755

`Static`zeroFillRightShift

zeroFillRightShift(matrix: SparseMatrix, value: number): SparseMatrix
Parameters
- matrix: SparseMatrix
- value: number
Returns SparseMatrix
- Defined in index.js:913