Class Matrix<T>

Matrix class

Type Parameters

T extends unknown = number
Element type

Index

Constructors

constructor

new Matrix<T extends unknown = number>(
 rows: number,
 cols: number,
 values?: T | T[] | T[][],
): Matrix<T>
Type Parameters
- T extends unknown = number
Parameters
- rows: number
 Number of rows
- cols: number
 Number of columns
- Optionalvalues: T | T[] | T[][]
 Initial values
Returns Matrix<T>
- Defined in lib/util/matrix.d.ts:268
new Matrix<T extends unknown = number>(
size: [number, number],
values?: T | T[] | T[][],
): Matrix<T>
Type Parameters
- T extends unknown = number
Parameters
- size: [number, number]
 Sizes for each dimension
- Optionalvalues: T | T[] | T[][]
 Initial values
Returns Matrix<T>
- Defined in lib/util/matrix.d.ts:274

Accessors

cols

get cols(): number
Number of columns of the matrix.

Returns number
- Defined in lib/util/matrix.d.ts:303

dimension

get dimension(): number
Dimension of the matrix.

Returns number
- Defined in lib/util/matrix.d.ts:283

length

get length(): number
Number of all elements in the matrix.

Returns number
- Defined in lib/util/matrix.d.ts:293

rows

get rows(): number
Number of rows of the matrix.

Returns number
- Defined in lib/util/matrix.d.ts:298

sizes

get sizes(): number[]
Sizes of the matrix.

Returns number[]
- Defined in lib/util/matrix.d.ts:288

t

get t(): Matrix<T>
Transpose matrix.

Returns Matrix<T>
- Defined in lib/util/matrix.d.ts:313

value

get value(): T[]
Elements in the matrix.

Returns T[]
- Defined in lib/util/matrix.d.ts:308

Methods

[iterator]

"[iterator]"(): Generator<any, void, unknown>
Iterate over the elements.

Returns Generator<any, void, unknown>
Yields
- Defined in lib/util/matrix.d.ts:1581

abs

abs(): void
Set all elements to their absolute values.

Returns void
- Defined in lib/util/matrix.d.ts:995

add

add(o: number | Tensor<number> | Matrix<number>): void
Add a value or matrix.
Parameters
- o: number | Tensor<number> | Matrix<number>
 Value to add
Returns void
- Defined in lib/util/matrix.d.ts:1051

addAt

addAt(r: number, c: number, v: number): number
Add a value to the position.
Parameters
- r: number
  Index of the row to add the value to
- c: number
  Index of the column to add the value to
- v: number
  Value to add
Returns number
Old value
- Defined in lib/util/matrix.d.ts:1059

adjoint

adjoint(): Matrix<T>
Returns adjoint matrix.

Returns Matrix<T>
Adjoint matrix
- Defined in lib/util/matrix.d.ts:447

and

and(o: number | Tensor<number> | Matrix<unknown>): void
Take a logical AND with a value or matrix.
Parameters
- o: number | Tensor<number> | Matrix<unknown>
 Value to take a logical AND
Returns void
- Defined in lib/util/matrix.d.ts:1155

andAt

andAt(r: number, c: number, v: number): T
Take logical AND with a value to the position.
Parameters
- r: number
  Index of the row to take a logical AND with
- c: number
  Index of the column to take a logical AND with
- v: number
  Value to take a logical AND
Returns T
Old value
- Defined in lib/util/matrix.d.ts:1163

argmax

argmax(axis: number): Matrix<number>
Returns maximum indexes along the axis.
Parameters
- axis: number
 Axis to be reduced
Returns Matrix<number>
Argmax values
- Defined in lib/util/matrix.d.ts:704

argmin

argmin(axis: number): Matrix<number>
Returns minimum indexes along the axis.
Parameters
- axis: number
 Axis to be reduced
Returns Matrix<number>
Argmin values
- Defined in lib/util/matrix.d.ts:710

at

at(r: number, c: number): T
Returns a value at the position.
Parameters
- r: number
  Row index
- c: number
  Column index
Returns T
Value at the position
- Defined in lib/util/matrix.d.ts:349
at(index: [number, number]): T
Returns a value at the position.
Parameters
- index: [number, number]
  Index values
Returns T
Value at the position
- Defined in lib/util/matrix.d.ts:356

balancing

balancing(): [number[], Matrix<number>, number[]]
Returns a doubly stochastic matrix.

Returns [number[], Matrix<number>, number[]]
Doubly stochastic matrix
- Defined in lib/util/matrix.d.ts:1426

balancingSinkhornKnopp

balancingSinkhornKnopp(): [number[], Matrix<number>, number[]]
Returns a doubly stochastic matrix by Sinkhorn-Knopp algorithm.

Returns [number[], Matrix<number>, number[]]
Doubly stochastic matrix
- Defined in lib/util/matrix.d.ts:1431

bidiag

bidiag(): Matrix<number>
Returns a bidiagonal matrix.

Returns Matrix<number>
Bidiagonal matrix
- Defined in lib/util/matrix.d.ts:1371

bidiagHouseholder

bidiagHouseholder(return_uv?: false): Matrix<number>
Returns a bidiagonal matrix by Householder method.
Parameters
- Optionalreturn_uv: false
 Returns orthogonal matrixes
Returns Matrix<number>
Bidiagonal matrix, or Bidiagonal matrix and orthogonal matrixes
- Defined in lib/util/matrix.d.ts:1378
bidiagHouseholder(
return_uv: true,
): [Matrix<number>, Matrix<number>, Matrix<number>]
Returns a bidiagonal matrix by Householder method.
Parameters
- return_uv: true
 Returns orthogonal matrixes
Returns [Matrix<number>, Matrix<number>, Matrix<number>]
Bidiagonal matrix, or Bidiagonal matrix and orthogonal matrixes
- Defined in lib/util/matrix.d.ts:1385

bitand

bitand(o: number | Tensor<number> | Matrix<number>): void
Take a bitwise AND with a value or matrix.
Parameters
- o: number | Tensor<number> | Matrix<number>
 Value to take a bitwise AND
Returns void
- Defined in lib/util/matrix.d.ts:1181

bitandAt

bitandAt(r: number, c: number, v: number): T
Take bitwise AND with a value to the position.
Parameters
- r: number
  Index of the row to take a bitwise AND with
- c: number
  Index of the column to take a bitwise AND with
- v: number
  Value to take a bitwise AND
Returns T
Old value
- Defined in lib/util/matrix.d.ts:1189

bitnot

bitnot(): void
Set all elements to their bitwise NOT values.

Returns void
- Defined in lib/util/matrix.d.ts:991

bitor

bitor(o: number | Tensor<number> | Matrix<number>): void
Take a bitwise OR with a value or matrix.
Parameters
- o: number | Tensor<number> | Matrix<number>
 Value to take a bitwise OR
Returns void
- Defined in lib/util/matrix.d.ts:1194

bitorAt

bitorAt(r: number, c: number, v: number): T
Take bitwise OR with a value to the position.
Parameters
- r: number
  Index of the row to take a bitwise OR with
- c: number
  Index of the column to take a bitwise OR with
- v: number
  Value to take a bitwise OR
Returns T
Old value
- Defined in lib/util/matrix.d.ts:1202

bitxor

bitxor(o: number | Tensor<number> | Matrix<number>): void
Take a bitwise XOR with a value or matrix.
Parameters
- o: number | Tensor<number> | Matrix<number>
 Value to take a bitwise XOR
Returns void
- Defined in lib/util/matrix.d.ts:1207

bitxorAt

bitxorAt(r: number, c: number, v: number): T
Take bitwise XOR with a value to the position.
Parameters
- r: number
  Index of the row to take a bitwise XOR with
- c: number
  Index of the column to take a bitwise XOR with
- v: number
  Value to take a bitwise XOR
Returns T
Old value
- Defined in lib/util/matrix.d.ts:1215

block

block(
 rows_from?: number,
 cols_from?: number,
 rows_to?: number,
 cols_to?: number,
): Matrix<T>
Returns the sub-matrix corresponding to position.
Parameters
- Optionalrows_from: number
 Start row index
- Optionalcols_from: number
 Start column index
- Optionalrows_to: number
 End row index(exclusive)
- Optionalcols_to: number
 End column index(exclusive)
Returns Matrix<T>
Sub matrix
- Defined in lib/util/matrix.d.ts:402

broadcastOperate

broadcastOperate(
o: Tensor<number> | U | Matrix,
fn: (arg0: T, arg1: U) => T,
): void
Apply function for all elements with broadcasting.
Type Parameters
- U
Parameters
- o: Tensor<number> | U | Matrix
 Applied value
- fn: (arg0: T, arg1: U) => T
 Applied function
Returns void
- Defined in lib/util/matrix.d.ts:1029

ceil

ceil(): void
Set all elements to their ceil values.

Returns void
- Defined in lib/util/matrix.d.ts:1007

cholesky

cholesky(): Matrix<number>
Returns a cholesky decomposition.

Returns Matrix<number>
Cholesky decomposition matrix
- Defined in lib/util/matrix.d.ts:1482

choleskyBanachiewicz

choleskyBanachiewicz(): Matrix<number>
Returns a cholesky decomposition by Banachiewicz algorithm.

Returns Matrix<number>
Cholesky decomposition matrix
- Defined in lib/util/matrix.d.ts:1492

choleskyCrout

choleskyCrout(): Matrix<number>
Returns a cholesky decomposition by Crout algorithm.

Returns Matrix<number>
Cholesky decomposition matrix
- Defined in lib/util/matrix.d.ts:1497

choleskyGaussian

choleskyGaussian(): Matrix<number>
Returns a cholesky decomposition by Gaussian algorithm.

Returns Matrix<number>
Cholesky decomposition matrix
- Defined in lib/util/matrix.d.ts:1487

col

col(c: number | number[] | boolean[]): Matrix<T>
Returns a col matrix at c.
Parameters
- c: number | number[] | boolean[]
 Indexes of columns, or an array of boolean values where the column to be selected is true.
Returns Matrix<T>
Column selected matrix
- Defined in lib/util/matrix.d.ts:385

concat

concat(m: Matrix<T>, axis?: number): void
Concatenate this and m.
Parameters
- m: Matrix<T>
 Concatenate matrix
- Optionalaxis: number
 Axis to be concatenated
Returns void
- Defined in lib/util/matrix.d.ts:527

convolute

convolute(kernel: number[][], normalize?: boolean): void
Convoluted by a kernel.
Parameters
- kernel: number[][]
  Kernel matrix
- Optionalnormalize: boolean
  Normalize kernel or not
Returns void
- Defined in lib/util/matrix.d.ts:1239

copy

copy(dst?: Matrix<T>): Matrix<T>
Returns a copy of this matrix.
Parameters
- Optionaldst: Matrix<T>
 Destination matrix
Returns Matrix<T>
Copied matrix
- Defined in lib/util/matrix.d.ts:334

cov

cov(ddof?: number): Matrix<number>
Returns a covariance matrix.
Parameters
- Optionalddof: number
 Delta Degrees of Freedom
Returns Matrix<number>
Covariance matrix
- Defined in lib/util/matrix.d.ts:1321

det

det(): number
Returns a determinant.

Returns number
Determinant value
- Defined in lib/util/matrix.d.ts:974

diag

diag(): T[]
Returns diagonal elements.

Returns T[]
Diagonal values
- Defined in lib/util/matrix.d.ts:914

div

div(o: number | Tensor<number> | Matrix<number>): void
Divides by a value element-wise.
Parameters
- o: number | Tensor<number> | Matrix<number>
 Value to divide
Returns void
- Defined in lib/util/matrix.d.ts:1103

divAt

divAt(r: number, c: number, v: number): number
Divides the value at the position by a value.
Parameters
- r: number
  Index of the row to divide the value by
- c: number
  Index of the column to divide the value by
- v: number
  Value to divide
Returns number
Old value
- Defined in lib/util/matrix.d.ts:1116

dot

dot(o: Matrix<number>): Matrix<number>
Returns a matrix product value.
Parameters
- o: Matrix<number>
 Right matrix
Returns Matrix<number>
Producted matrix
- Defined in lib/util/matrix.d.ts:1221

eigen

eigen(): [number[], Matrix<number>]
Returns eigenvalues and eigenvectors.

Returns [number[], Matrix<number>]
Eigenvalues and eigenvectors. Eigenvectors correspond to each column of the matrix.
- Defined in lib/util/matrix.d.ts:1523

eigenInverseIteration

eigenInverseIteration(
ev?: number,
maxIteration?: number,
): [number, Matrix<number>]
Returns the nearest eigenvalue and its eigenvector to the specified value.
Parameters
- Optionalev: number
 Target value
- OptionalmaxIteration: number
 Maximum iteration
Returns [number, Matrix<number>]
Eigenvalue and eigenvector
- Defined in lib/util/matrix.d.ts:1576

eigenJacobi

eigenJacobi(maxIteration?: number): [number[], Matrix<number>]
Returns eigenvalues and eigenvectors.
Parameters
- OptionalmaxIteration: number
 Maximum iteration
Returns [number[], Matrix<number>]
Eigenvalues and eigenvectors. Eigenvectors correspond to each column of the matrix.
- Defined in lib/util/matrix.d.ts:1556

eigenPowerIteration

eigenPowerIteration(maxIteration?: number): [number, Matrix<number>]
Returns the maximum eigenvalue and its eigenvector.
Parameters
- OptionalmaxIteration: number
 Maximum iteration
Returns [number, Matrix<number>]
Maximum eigenvalue and its eigenvector
- Defined in lib/util/matrix.d.ts:1562

eigenSimultaneousIteration

eigenSimultaneousIteration(
k: number,
maxIteration?: number,
): [number[], Matrix<number>]
Returns the k highest eigenvalues and its eigenvectors.
Parameters
- k: number
 Number of calculated eigenvalues
- OptionalmaxIteration: number
 Maximum iteration
Returns [number[], Matrix<number>]
The k highest eigenvalues and its eigenvectors. Eigenvectors correspond to each column of the matrix.
- Defined in lib/util/matrix.d.ts:1569

eigenValues

eigenValues(): number[]
Returns eigenvalues.

Returns number[]
Eigenvalues
- Defined in lib/util/matrix.d.ts:1528

eigenValuesBiSection

eigenValuesBiSection(): number[]
Returns eigenvalues by Bi-section.

Returns number[]
Eigenvalues
- Defined in lib/util/matrix.d.ts:1538

eigenValuesLR

eigenValuesLR(maxIteration?: number): number[]
Returns eigenvalues by LU decomposition.
Parameters
- OptionalmaxIteration: number
  Maximum iteration
Returns number[]
Eigenvalues
- Defined in lib/util/matrix.d.ts:1544

eigenValuesQR

eigenValuesQR(maxIteration?: number): number[]
Returns eigenvalues by QR decomposition.
Parameters
- OptionalmaxIteration: number
  Maximum iteration
Returns number[]
Eigenvalues
- Defined in lib/util/matrix.d.ts:1550

eigenVectors

eigenVectors(): Matrix<number>
Returns eigenvectors.

Returns Matrix<number>
Eigenvectors. Eigenvectors correspond to each column of the matrix.
- Defined in lib/util/matrix.d.ts:1533

equals

equals(other: any, tol?: number): boolean
Returns this matrix is equals to the others.
Parameters
- other: any
  Check tensor
- Optionaltol: number
  Tolerance to be recognized as the same
Returns boolean
true if equal
- Defined in lib/util/matrix.d.ts:341

every

every(cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => boolean): boolean
Determines whether all the members of a matrix satisfy the specified test.
Parameters
- cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => boolean
 Check function
Returns boolean
Reduced value or matrix
- Defined in lib/util/matrix.d.ts:576
every(
cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => boolean,
axis: 0 | 1,
): Matrix<boolean>
Determines whether all the members of a matrix satisfy the specified test.
Parameters
- cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => boolean
 Check function
- axis: 0 | 1
 Axis to be reduced
Returns Matrix<boolean>
Reduced value or matrix
- Defined in lib/util/matrix.d.ts:584
every(
cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => boolean,
axis: number,
): boolean | Matrix<boolean>
Determines whether all the members of a matrix satisfy the specified test.
Parameters
- cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => boolean
 Check function
- axis: number
 Axis to be reduced
Returns boolean | Matrix<boolean>
Reduced value or matrix
- Defined in lib/util/matrix.d.ts:592

exp

exp(): Matrix<number>
Returns a exponential matrix

Returns Matrix<number>
Exponential matrix
- Defined in lib/util/matrix.d.ts:1310

fill

fill(value: T): void
Fill in all the elements with the value.
Parameters
- value: T
  Filled value
Returns void
- Defined in lib/util/matrix.d.ts:427

flip

flip(axis?: number): void
Flip values along the axis.
Parameters
- Optionalaxis: number
  Axis to be flipped
Returns void
- Defined in lib/util/matrix.d.ts:452

floor

floor(): void
Set all elements to their floored values.

Returns void
- Defined in lib/util/matrix.d.ts:1003

forEach

forEach(cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => any): void
Iterate over all the elements.
Parameters
- cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => any
 Callback function
Returns void
- Defined in lib/util/matrix.d.ts:437

gram

gram(): Matrix<number>
Returns a gram matrix.

Returns Matrix<number>
Gram matrix
- Defined in lib/util/matrix.d.ts:1326

hessenberg

hessenberg(): Matrix<number>
Returns a hessenberg matrix.

Returns Matrix<number>
Hessenberg matrix
- Defined in lib/util/matrix.d.ts:1415

hessenbergArnoldi

hessenbergArnoldi(k?: number): Matrix<number>
Returns a hessenberg matrix.
Parameters
- Optionalk: number
 Number of iterations
Returns Matrix<number>
Hessenberg matrix
- Defined in lib/util/matrix.d.ts:1421

idiv

idiv(o: number | Tensor<number> | Matrix<number>): void
Divides a value by this matrix element-wise.
Parameters
- o: number | Tensor<number> | Matrix<number>
 Value to be divided
Returns void
- Defined in lib/util/matrix.d.ts:1108

idivAt

idivAt(r: number, c: number, v: number): number
Divides a value by the value at the position.
Parameters
- r: number
  Index of the row whose value is to be divided
- c: number
  Index of the column whose value is to be divided
- v: number
  Value to be divided
Returns number
Old value
- Defined in lib/util/matrix.d.ts:1124

imod

imod(o: number | Tensor<number> | Matrix<number>): void
Take a remainder divided a value by this matrix element-wise.
Parameters
- o: number | Tensor<number> | Matrix<number>
 Value to be divided
Returns void
- Defined in lib/util/matrix.d.ts:1134

imodAt

imodAt(r: number, c: number, v: number): number
Take a remainder divided a value by the value at the position.
Parameters
- r: number
  Index of the row whose value is to be divided
- c: number
  Index of the column whose value is to be divided
- v: number
  Value to be divided
Returns number
Old value
- Defined in lib/util/matrix.d.ts:1150

inv

inv(): Matrix<number>
Returns a inverse matrix.

Returns Matrix<number>
Inversed matrix
- Defined in lib/util/matrix.d.ts:1249

invLowerTriangular

invLowerTriangular(): Matrix<number>
Returns a inverse matrix for lower triangular matrix.

Returns Matrix<number>
Inversed matrix
- Defined in lib/util/matrix.d.ts:1254

invLU

invLU(): Matrix<number>
Returns a inverse matrix by LU decompositioin.

Returns Matrix<number>
Inversed matrix
- Defined in lib/util/matrix.d.ts:1269

invRowReduction

invRowReduction(): Matrix<number>
Returns a inverse matrix by row reduction.

Returns Matrix<number>
Inversed matrix
- Defined in lib/util/matrix.d.ts:1264

invUpperTriangular

invUpperTriangular(): Matrix<number>
Returns a inverse matrix for upper triangular matrix.

Returns Matrix<number>
Inversed matrix
- Defined in lib/util/matrix.d.ts:1259

isAlternating

isAlternating(tol?: number): boolean
Returns if this is alternating matrix or not.
Parameters
- Optionaltol: number
  Tolerance within which sign-reversed values are recognized as the same
Returns boolean
true if this is alternating matrix
- Defined in lib/util/matrix.d.ts:873

isDiag

isDiag(tol?: number): boolean
Returns if this is diagonal matrix or not.
Parameters
- Optionaltol: number
  Tolerance to be recognized as 0
Returns boolean
true if this is diagonal matrix
- Defined in lib/util/matrix.d.ts:825

isHermitian

isHermitian(tol?: number): boolean
Returns if this is hermitian matrix or not.
Parameters
- Optionaltol: number
  Tolerance to be recognized as the same
Returns boolean
true if this is hermitian matrix
- Defined in lib/util/matrix.d.ts:867

isIdentity

isIdentity(tol?: number): boolean
Returns if this is identity matrix or not.
Parameters
- Optionaltol: number
  Tolerance to be recognized as 0 or 1
Returns boolean
true if this is identity matrix
- Defined in lib/util/matrix.d.ts:831

isLowerTriangular

isLowerTriangular(tol?: number): boolean
Returns if this is lower triangular matrix or not.
Parameters
- Optionaltol: number
  Tolerance to be recognized as 0
Returns boolean
true if this is lower triangular matrix
- Defined in lib/util/matrix.d.ts:849

isNilpotent

isNilpotent(tol?: number): boolean
Returns if this is nilpotent matrix or not.
Parameters
- Optionaltol: number
  Tolerance to be recognized as 0
Returns boolean
true if this is nilpotent matrix
- Defined in lib/util/matrix.d.ts:909

isNormal

isNormal(tol?: number): boolean
Returns if this is normal matrix or not.
Parameters
- Optionaltol: number
  Tolerance to be recognized as the same
Returns boolean
true if this is normal matrix
- Defined in lib/util/matrix.d.ts:891

isOrthogonal

isOrthogonal(tol?: number): boolean
Returns if this is orthogonal matrix or not.
Parameters
- Optionaltol: number
  Tolerance to be recognized as 0 or 1
Returns boolean
true if this is orthogonal matrix
- Defined in lib/util/matrix.d.ts:897

isRegular

isRegular(tol?: number): boolean
Returns if this is regular matrix or not.
Parameters
- Optionaltol: number
  Tolerance to recognize the determinant as 0
Returns boolean
true if this is regular matrix
- Defined in lib/util/matrix.d.ts:885

isSkewHermitian

isSkewHermitian(tol?: number): boolean
Returns if this is skew-hermitian matrix or not.
Parameters
- Optionaltol: number
  Tolerance within which sign-reversed values are recognized as the same
Returns boolean
true if this is skew-hermitian matrix
- Defined in lib/util/matrix.d.ts:879

isSquare

isSquare(): boolean
Returns if this is square matrix or not.

Returns boolean
true if this is square matrix
- Defined in lib/util/matrix.d.ts:819

isSymmetric

isSymmetric(tol?: number): boolean
Returns if this is symmetric matrix or not.
Parameters
- Optionaltol: number
  Tolerance to be recognized as the same
Returns boolean
true if this is symmetric matrix
- Defined in lib/util/matrix.d.ts:861

isTriangular

isTriangular(tol?: number): boolean
Returns if this is triangular matrix or not.
Parameters
- Optionaltol: number
  Tolerance to be recognized as 0
Returns boolean
true if this is triangular matrix
- Defined in lib/util/matrix.d.ts:843

isub

isub(o: number | Tensor<number> | Matrix<number>): void
Subtract this matrix from a value or matrix.
Parameters
- o: number | Tensor<number> | Matrix<number>
 Value to be subtracted
Returns void
- Defined in lib/util/matrix.d.ts:1069

isubAt

isubAt(r: number, c: number, v: number): number
Subtract the value at the position from a value.
Parameters
- r: number
  Index of the row whose value is to be subtracted
- c: number
  Index of the column whose value is to be subtracted
- v: number
  Value to be subtracted
Returns number
Old value
- Defined in lib/util/matrix.d.ts:1085

isUnitary

isUnitary(tol?: number): boolean
Returns if this is unitary matrix or not.
Parameters
- Optionaltol: number
  Tolerance to be recognized as 0 or 1
Returns boolean
true if this is unitary matrix
- Defined in lib/util/matrix.d.ts:903

isUpperTriangular

isUpperTriangular(tol?: number): boolean
Returns if this is upper triangular matrix or not.
Parameters
- Optionaltol: number
  Tolerance to be recognized as 0
Returns boolean
true if this is upper triangular matrix
- Defined in lib/util/matrix.d.ts:855

isZero

isZero(tol?: number): boolean
Returns if this is zero matrix or not.
Parameters
- Optionaltol: number
  Tolerance to be recognized as 0
Returns boolean
true if this is zero matrix
- Defined in lib/util/matrix.d.ts:837

kron

kron(mat: Matrix<number>): Matrix<number>
Returns kronecker producted value.
Parameters
- mat: Matrix<number>
 Right matrix
Returns Matrix<number>
Kronecker producted matrix
- Defined in lib/util/matrix.d.ts:1233

leftShift

leftShift(n: number): void
Set all elements to their left shift values.
Parameters
- n: number
  Shift amount
Returns void
- Defined in lib/util/matrix.d.ts:1012

log

log(): Matrix<number>
Returns a logarithm matrix

Returns Matrix<number>
Logarithm matrix
- Defined in lib/util/matrix.d.ts:1315

lu

lu(): [Matrix<number>, Matrix<number>]
Returns a LU decomposition.

Returns [Matrix<number>, Matrix<number>]
Lower triangular matrix and upper triangular matrix
- Defined in lib/util/matrix.d.ts:1436

map

map(cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => T): void
Iterate over all the elements and replace the value.
Parameters
- cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => T
 Mapping function
Returns void
- Defined in lib/util/matrix.d.ts:432

max

max(): number
Returns maximum value of all element.

Returns number
Maximum value
- Defined in lib/util/matrix.d.ts:621
max(axis: 0 | 1): Matrix<number>
Returns maximum values along the axis.
Parameters
- axis: 0 | 1
 Axis to be reduced
Returns Matrix<number>
Maximum values
- Defined in lib/util/matrix.d.ts:628
max(axis: number): number | Matrix<number>
Returns maximum values along the axis.
Parameters
- axis: number
 Axis to be reduced. If negative, returns the maximum value of the all element.
Returns number | Matrix<number>
Maximum values
- Defined in lib/util/matrix.d.ts:635

mean

mean(): number
Returns mean of all element.

Returns number
Mean value
- Defined in lib/util/matrix.d.ts:736
mean(axis: 0 | 1): Matrix<number>
Returns means along the axis.
Parameters
- axis: 0 | 1
 Axis to be reduced
Returns Matrix<number>
Mean values
- Defined in lib/util/matrix.d.ts:743
mean(axis: number): number | Matrix<number>
Returns means along the axis.
Parameters
- axis: number
 Axis to be reduced. If negative, returns a mean value of the all element.
Returns number | Matrix<number>
Mean values
- Defined in lib/util/matrix.d.ts:750

median

median(): number
Returns median of all element.

Returns number
Median value
- Defined in lib/util/matrix.d.ts:661
median(axis: 0 | 1): Matrix<number>
Returns medians along the axis.
Parameters
- axis: 0 | 1
 Axis to be reduced
Returns Matrix<number>
Median values
- Defined in lib/util/matrix.d.ts:668
median(axis: number): number | Matrix<number>
Returns medians along the axis.
Parameters
- axis: number
 Axis to be reduced. If negative, returns a median of the all element.
Returns number | Matrix<number>
Median values
- Defined in lib/util/matrix.d.ts:675

min

min(): number
Returns minimum value of all element.

Returns number
Minimum value
- Defined in lib/util/matrix.d.ts:641
min(axis: 0 | 1): Matrix<number>
Returns minimum values along the axis.
Parameters
- axis: 0 | 1
 Axis to be reduced
Returns Matrix<number>
Minimum values
- Defined in lib/util/matrix.d.ts:648
min(axis: number): number | Matrix<number>
Returns minimum values along the axis.
Parameters
- axis: number
 Axis to be reduced. If negative, returns the minimum value of the all element.
Returns number | Matrix<number>
Minimum values
- Defined in lib/util/matrix.d.ts:655

mod

mod(o: number | Tensor<number> | Matrix<number>): void
Take a remainder divided by a value element-wise.
Parameters
- o: number | Tensor<number> | Matrix<number>
 Value to divide
Returns void
- Defined in lib/util/matrix.d.ts:1129

modAt

modAt(r: number, c: number, v: number): number
Take a remainder divided the value at the position by a value.
Parameters
- r: number
  Index of the row to divide the value by
- c: number
  Index of the column to divide the value by
- v: number
  Value to divide
Returns number
Old value
- Defined in lib/util/matrix.d.ts:1142

modifiedCholesky

modifiedCholesky(): [Matrix<number>, number[]]
Returns a modified cholosky decomposition.

Returns [Matrix<number>, number[]]
Cholesky decomposition matrix and diagonal matrix
- Defined in lib/util/matrix.d.ts:1502

mult

mult(o: number | Tensor<number> | Matrix<number>): void
Multiplies by a value element-wise.
Parameters
- o: number | Tensor<number> | Matrix<number>
 Value to multiply
Returns void
- Defined in lib/util/matrix.d.ts:1090

multAt

multAt(r: number, c: number, v: number): number
Multiplies a value to the position.
Parameters
- r: number
  Index of the row to multiply the value by
- c: number
  Index of the column to multiply the value by
- v: number
  Value to multiply
Returns number
Old value
- Defined in lib/util/matrix.d.ts:1098

negative

negative(): void
Multiply all elements by -1 in-place.

Returns void
- Defined in lib/util/matrix.d.ts:983

norm

norm(p?: number): number
Returns a p-norm.
Parameters
- Optionalp: number
  p-norm
Returns number
Entry-wise norm
- Defined in lib/util/matrix.d.ts:925

normEntrywise

normEntrywise(p?: number): number
Returns a entry-wise norm
Parameters
- Optionalp: number
  p-norm
Returns number
Entry-wise norm
- Defined in lib/util/matrix.d.ts:942

normFrobenius

normFrobenius(): number
Returns frobenius norm.

Returns number
Frobenius norm
- Defined in lib/util/matrix.d.ts:947

normInduced

normInduced(p?: number): number
Returns induced norm.
Parameters
- Optionalp: number
  p-norm
Returns number
Induced norm
- Defined in lib/util/matrix.d.ts:931

normMax

normMax(): number
Returns max norm.

Returns number
Max norm
- Defined in lib/util/matrix.d.ts:952

normNuclear

normNuclear(): number
Returns nuclear norm.

Returns number
Nuclear norm
- Defined in lib/util/matrix.d.ts:963

normSchatten

normSchatten(p?: number): number
Returns schatten norm.
Parameters
- Optionalp: number
  p-norm
Returns number
Schatten norm
- Defined in lib/util/matrix.d.ts:958

normSpectral

normSpectral(): number
Returns spectral norm.

Returns number
Spectral norm
- Defined in lib/util/matrix.d.ts:936

not

not(): void
Set all elements to their logical NOT values.

Returns void
- Defined in lib/util/matrix.d.ts:987

operateAt

operateAt(r: number, c: number, fn?: (arg0: T) => T): T
Apply function to the position.
Parameters
- r: number
  Index of the row to apply function to
- c: number
  Index of the column to apply function to
- Optionalfn: (arg0: T) => T
  Applied function
Returns T
Old value
- Defined in lib/util/matrix.d.ts:1038
operateAt(index: [number, number], fn: (arg0: T) => T): T
Apply function to the position.
Parameters
- index: [number, number]
  Index to apply function to
- fn: (arg0: T) => T
  Applied function
Returns T
Old value
- Defined in lib/util/matrix.d.ts:1046

or

or(o: number | Tensor<number> | Matrix<unknown>): void
Take a logical OR with a value or matrix.
Parameters
- o: number | Tensor<number> | Matrix<unknown>
 Value to take a logical OR
Returns void
- Defined in lib/util/matrix.d.ts:1168

orAt

orAt(r: number, c: number, v: number): T
Take logical OR with a value to the position.
Parameters
- r: number
  Index of the row to take a logical OR with
- c: number
  Index of the column to take a logical OR with
- v: number
  Value to take a logical OR
Returns T
Old value
- Defined in lib/util/matrix.d.ts:1176

power

power(p: number): Matrix<number>
Returns a power of this matrix.
Parameters
- p: number
 Power exponent value
Returns Matrix<number>
Powered matrix
- Defined in lib/util/matrix.d.ts:1305

prod

prod(): number
Returns producted value of all element.

Returns number
Producted value
- Defined in lib/util/matrix.d.ts:756
prod(axis: 0 | 1): Matrix<number>
Returns producted values along the axis.
Parameters
- axis: 0 | 1
 Axis to be reduced
Returns Matrix<number>
Producted values
- Defined in lib/util/matrix.d.ts:763
prod(axis: number): number | Matrix<number>
Returns producted values along the axis.
Parameters
- axis: number
 Axis to be reduced. If negative, returns a producted value of the all element.
Returns number | Matrix<number>
Producted values
- Defined in lib/util/matrix.d.ts:770

pseudoInv

pseudoInv(): Matrix<number>
Returns a pseudo inverse matrix.

Returns Matrix<number>
pseudo inverse matrix
- Defined in lib/util/matrix.d.ts:1274

pseudoInvBenIsraelCohen

pseudoInvBenIsraelCohen(): Matrix<number>
Returns a Moore–Penrose inverse matrix by Ben-Israel and Cohen iterative method.

Returns Matrix<number>
Moore–Penrose inverse matrix
- Defined in lib/util/matrix.d.ts:1294

pseudoInvNaive

pseudoInvNaive(): Matrix<number>
Returns a pseudo inverse matrix.

Returns Matrix<number>
pseudo inverse matrix
- Defined in lib/util/matrix.d.ts:1279

pseudoInvQR

pseudoInvQR(): Matrix<number>
Returns a Moore–Penrose inverse matrix by QR decomposition.

Returns Matrix<number>
Moore–Penrose inverse matrix
- Defined in lib/util/matrix.d.ts:1284

pseudoInvSVD

pseudoInvSVD(): Matrix<number>
Returns a Moore–Penrose inverse matrix by SVD decomposition.

Returns Matrix<number>
Moore–Penrose inverse matrix
- Defined in lib/util/matrix.d.ts:1289

qr

qr(): [Matrix<number>, Matrix<number>]
Returns a QR decomposition.

Returns [Matrix<number>, Matrix<number>]
Orthogonal matrix and upper triangular matrix
- Defined in lib/util/matrix.d.ts:1441

qrGramSchmidt

qrGramSchmidt(): [Matrix<number>, Matrix<number>]
Returns a QR decomposition by Gram-Schmidt method.

Returns [Matrix<number>, Matrix<number>]
Orthogonal matrix and upper triangular matrix
- Defined in lib/util/matrix.d.ts:1446

qrHouseholder

qrHouseholder(): [Matrix<number>, Matrix<number>]
Returns a QR decomposition by Householder method.

Returns [Matrix<number>, Matrix<number>]
Orthogonal matrix and upper triangular matrix
- Defined in lib/util/matrix.d.ts:1451

quantile

quantile(q: number): number
Returns quantile value of all element.
Parameters
- q: number
  Partition rate
Returns number
Quantile value
- Defined in lib/util/matrix.d.ts:682
quantile(q: number, axis: 0 | 1): Matrix<number>
Returns quantile values along the axis.
Parameters
- q: number
 Partition rate
- axis: 0 | 1
 Axis to be reduced
Returns Matrix<number>
Quantile values
- Defined in lib/util/matrix.d.ts:690
quantile(q: number, axis: number): number | Matrix<number>
Returns quantile values along the axis.
Parameters
- q: number
 Partition rate
- axis: number
 Axis to be reduced. If negative, returns the quantile value of the all element.
Returns number | Matrix<number>
Quantile values
- Defined in lib/util/matrix.d.ts:698

rank

rank(tol?: number): number
Returns a rank of this matrix.
Parameters
- Optionaltol: number
  Tolerance to be recognized as the same
Returns number
Rank of this matrix
- Defined in lib/util/matrix.d.ts:969

rankFactorization

rankFactorization(): [Matrix<number>, Matrix<number>]
Returns rank factorization.

Returns [Matrix<number>, Matrix<number>]
Rank factorization matrix
- Defined in lib/util/matrix.d.ts:1518

reduce

reduce(
cb: (arg0: T, arg1: T, arg2: number[], arg3: Matrix<T>) => T,
init?: null,
): T
Returns a matrix reduced along all element with the callback function.
Parameters
- cb: (arg0: T, arg1: T, arg2: number[], arg3: Matrix<T>) => T
 Reducing function
- Optionalinit: null
 Initial value
Returns T
Reduced value
- Defined in lib/util/matrix.d.ts:535
reduce(
cb: (arg0: U, arg1: T, arg2: number[], arg3: Matrix<T>) => U,
init: U,
): U
Returns a matrix reduced along all element with the callback function.
Type Parameters
- U
Parameters
- cb: (arg0: U, arg1: T, arg2: number[], arg3: Matrix<T>) => U
 Reducing function
- init: U
 Initial value
Returns U
Reduced value
- Defined in lib/util/matrix.d.ts:544
reduce<A extends number | number[], F extends boolean>(
 cb: (arg0: T, arg1: T, arg2: number[], arg3: Matrix<T>) => T,
 init: null,
 axis: A,
 keepdims?: F,
): Matrix<T> | (A extends 0 | 1 ? never : F extends true ? never : T)
Returns a matrix reduced along the axis with the callback function.
Type Parameters
- A extends number | number[]
- F extends boolean
Parameters
- cb: (arg0: T, arg1: T, arg2: number[], arg3: Matrix<T>) => T
 Reducing function
- init: null
 Initial value
- axis: A
 Axis to be reduced
- Optionalkeepdims: F
 Keep dimensions or not. If null, negative axis retuns number and other axis returns Matrix.
Returns Matrix<T> | (A extends 0 | 1 ? never : F extends true ? never : T)
Reduced matrix
- Defined in lib/util/matrix.d.ts:556
reduce<U, A extends number | number[], F extends boolean>(
 cb: (arg0: U, arg1: T, arg2: number[], arg3: Matrix<T>) => U,
 init: U,
 axis: A,
 keepdims?: F,
): Matrix | (A extends 0 | 1 ? never : F extends true ? never : U)
Returns a matrix reduced along the axis with the callback function.
Type Parameters
- U
- A extends number | number[]
- F extends boolean
Parameters
- cb: (arg0: U, arg1: T, arg2: number[], arg3: Matrix<T>) => U
 Reducing function
- init: U
 Initial value
- axis: A
 Axis to be reduced
- Optionalkeepdims: F
 Keep dimensions or not. If null, negative axis retuns number and other axis returns Matrix.
Returns Matrix | (A extends 0 | 1 ? never : F extends true ? never : U)
Reduced matrix
- Defined in lib/util/matrix.d.ts:569

reducedRowEchelonForm

reducedRowEchelonForm(tol?: number): void
Calculate reduced row echelon form in-place.
Parameters
- Optionaltol: number
  Tolerance to be recognized as 0
Returns void
- Defined in lib/util/matrix.d.ts:1244

remove

remove(idx: number | number[], axis?: number): void
Remove specified indexes.
Parameters
- idx: number | number[]
  Remove index
- Optionalaxis: number
  Axis to be removed
Returns void
- Defined in lib/util/matrix.d.ts:408

removeIf

removeIf(cond: (arg0: Matrix<T>) => boolean, axis?: number): void
Remove specified indexes.
Parameters
- cond: (arg0: Matrix<T>) => boolean
 Remove condition function. Remove if it returns true
- Optionalaxis: number
 Axis to be removed
Returns void
- Defined in lib/util/matrix.d.ts:414

repeat

repeat(n: number, axis?: number): void
Repeat the elements n times along the axis this.
Parameters
- n: number
  Repeated count
- Optionalaxis: number
  Axis to be repeated
Returns void
No return
- Defined in lib/util/matrix.d.ts:514
repeat(n: number[]): void
Repeat the elements n times along the axis this.
Parameters
- n: number[]
  Repeated counts for each axis
Returns void
No return
- Defined in lib/util/matrix.d.ts:521

reshape

reshape(rows: number, cols: number): any
Reshape this.
Parameters
- rows: number
  New row size
- cols: number
  New column size
Returns any
- Defined in lib/util/matrix.d.ts:500
reshape(sizes: [number, number]): any
Reshape this.
Parameters
- sizes: [number, number]
  New sizes for each dimension
Returns any
- Defined in lib/util/matrix.d.ts:506

resize

resize(rows: number, cols: number, init?: T): any
Resize this matrix.
Parameters
- rows: number
  New row size
- cols: number
  New column size
- Optionalinit: T
  Value of the extended region
Returns any
- Defined in lib/util/matrix.d.ts:486
resize(size: [number, number], init?: T): any
Resize this matrix.
Parameters
- size: [number, number]
  New sizes for each dimension
- Optionalinit: T
  Value of the extended region
Returns any
- Defined in lib/util/matrix.d.ts:493

round

round(): void
Set all elements to their rounded values.

Returns void
- Defined in lib/util/matrix.d.ts:999

row

row(r: number | number[] | boolean[]): Matrix<T>
Returns a row matrix at r.
Parameters
- r: number | number[] | boolean[]
 Indexes of rows, or an array of boolean values where the row to be selected is true.
Returns Matrix<T>
Row selected matrix
- Defined in lib/util/matrix.d.ts:379

sample

sample(n: number, axis?: number, duplicate?: boolean): [Matrix<T>, number[]]
Returns a matrix that sampled along the axis.
Parameters
- n: number
 Sampled size
- Optionalaxis: number
 Axis to be sampled
- Optionalduplicate: boolean
 Allow duplicate index or not
Returns [Matrix<T>, number[]]
Sampled matrix and its original indexes
- Defined in lib/util/matrix.d.ts:422

schur

schur(): [Matrix<number>, Matrix<number>]
Returns schur decomposition.

Returns [Matrix<number>, Matrix<number>]
Schur decomposition matrix
- Defined in lib/util/matrix.d.ts:1507

schurQR

schurQR(shift?: "no" | "single"): [Matrix<number>, Matrix<number>]
Returns schur decomposition by QR decomposition.
Parameters
- Optionalshift: "no" | "single"
 Shifting type
Returns [Matrix<number>, Matrix<number>]
Schur decomposition matrix
- Defined in lib/util/matrix.d.ts:1513

set

set(r: number, c: number, value: Matrix<T> | T): T
Set a value at the position.
Parameters
- r: number
 Row index
- c: number
 Column index
- value: Matrix<T> | T
 The value to be set
Returns T
Old value
- Defined in lib/util/matrix.d.ts:365
set(r: [number, number], value: Matrix<T> | T): T
Set a value at the position.
Parameters
- r: [number, number]
 Index values
- value: Matrix<T> | T
 The value to be set
Returns T
Old value
- Defined in lib/util/matrix.d.ts:373

shuffle

shuffle(axis?: number): number[]
Shuffle values along the axis.
Parameters
- Optionalaxis: number
  Axis to be shuffled
Returns number[]
Original index.
- Defined in lib/util/matrix.d.ts:471

signedRightShift

signedRightShift(n: number): void
Set all elements to their right shift values.
Parameters
- n: number
  Shift amount
Returns void
- Defined in lib/util/matrix.d.ts:1017

singularValuePowerIteration

singularValuePowerIteration(maxIteration?: number): number
Returns the maximum singular value.
Parameters
- OptionalmaxIteration: number
  Maximum iteration
Returns number
Maximum singular value
- Defined in lib/util/matrix.d.ts:1462

singularValues

singularValues(): number[]
Returns singular values.

Returns number[]
Singular values
- Defined in lib/util/matrix.d.ts:1456

slice

slice(from: number, to: number, axis?: number): Matrix<T>
Returns sliced matrix.
Parameters
- from: number
 Start index
- to: number
 End index
- Optionalaxis: number
 Axis to be sliced
Returns Matrix<T>
Sliced matrix
- Defined in lib/util/matrix.d.ts:393

solve

solve(b: Matrix<number>): Matrix<number>
Returns a solved value A of a equation XA=B.
Parameters
- b: Matrix<number>
 Dependent variable values
Returns Matrix<number>
Solved matrix
- Defined in lib/util/matrix.d.ts:1332

solveGaussSeidel

solveGaussSeidel(b: Matrix<number>, maxIteration?: number): Matrix<number>
Returns a solved value with Gauss-Seidel method.
Parameters
- b: Matrix<number>
 Dependent variable values
- OptionalmaxIteration: number
 Maximum iteration
Returns Matrix<number>
Solved matrix
- Defined in lib/util/matrix.d.ts:1358

solveJacobi

solveJacobi(b: Matrix<number>, maxIteration?: number): Matrix<number>
Returns a solved value with Jacobi method.
Parameters
- b: Matrix<number>
 Dependent variable values
- OptionalmaxIteration: number
 Maximum iteration
Returns Matrix<number>
Solved matrix
- Defined in lib/util/matrix.d.ts:1351

solveLowerTriangular

solveLowerTriangular(b: Matrix<number>): Matrix<number>
Returns a solved value for lower triangular matrix.
Parameters
- b: Matrix<number>
 Dependent variable values
Returns Matrix<number>
Solved matrix
- Defined in lib/util/matrix.d.ts:1338

solveSOR

solveSOR(
 b: Matrix<number>,
 w: Matrix<number>,
 maxIteration?: number,
): Matrix<number>
Returns a solved value with Successive Over-Relaxation method.
Parameters
- b: Matrix<number>
 Dependent variable values
- w: Matrix<number>
 Relaxation factor
- OptionalmaxIteration: number
 Maximum iteration
Returns Matrix<number>
Solved matrix
- Defined in lib/util/matrix.d.ts:1366

solveUpperTriangular

solveUpperTriangular(b: Matrix<number>): Matrix<number>
Returns a solved value for upper triangular matrix.
Parameters
- b: Matrix<number>
 Dependent variable values
Returns Matrix<number>
Solved matrix
- Defined in lib/util/matrix.d.ts:1344

some

some(cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => boolean): boolean
Determines whether the specified callback function returns true for any element of a matrix.
Parameters
- cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => boolean
 Check function
Returns boolean
Reduced value or matrix
- Defined in lib/util/matrix.d.ts:599
some(
cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => boolean,
axis: 0 | 1,
): Matrix<boolean>
Determines whether the specified callback function returns true for any element of a matrix.
Parameters
- cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => boolean
 Check function
- axis: 0 | 1
 Axis to be reduced
Returns Matrix<boolean>
Reduced value or matrix
- Defined in lib/util/matrix.d.ts:607
some(
cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => boolean,
axis: number,
): boolean | Matrix<boolean>
Determines whether the specified callback function returns true for any element of a matrix.
Parameters
- cb: (arg0: T, arg1: number[], arg2: Matrix<T>) => boolean
 Check function
- axis: number
 Axis to be reduced
Returns boolean | Matrix<boolean>
Reduced value or matrix
- Defined in lib/util/matrix.d.ts:615

sort

sort(axis?: number): number[]
Sort values along the axis.
Parameters
- Optionalaxis: number
  Axis to be sorted
Returns number[]
Original index.
- Defined in lib/util/matrix.d.ts:465

spectralRadius

spectralRadius(): number
Returns a spectral radius.

Returns number
Spectral radius
- Defined in lib/util/matrix.d.ts:979

sqrt

sqrt(): Matrix<number>
Returns a square root of this matrix.

Returns Matrix<number>
Squared matrix
- Defined in lib/util/matrix.d.ts:1299

std

std(): number
Returns standard deviation of all element.

Returns number
Standard deviation value
- Defined in lib/util/matrix.d.ts:798
std(axis: 0 | 1, ddof?: number): Matrix<number>
Returns standard deviations along the axis.
Parameters
- axis: 0 | 1
 Axis to be reduced
- Optionalddof: number
 Delta Degrees of Freedom
Returns Matrix<number>
Standard deviation values
- Defined in lib/util/matrix.d.ts:806
std(axis: number, ddof?: number): number | Matrix<number>
Returns standard deviations along the axis.
Parameters
- axis: number
 Axis to be reduced. If negative, returns a standard deviation of the all element.
- Optionalddof: number
 Delta Degrees of Freedom
Returns number | Matrix<number>
Standard deviation values
- Defined in lib/util/matrix.d.ts:814

sub

sub(o: number | Tensor<number> | Matrix<number>): void
Subtract a value or matrix.
Parameters
- o: number | Tensor<number> | Matrix<number>
 Value to subtract
Returns void
- Defined in lib/util/matrix.d.ts:1064

subAt

subAt(r: number, c: number, v: number): number
Subtract a value from the value at the position.
Parameters
- r: number
  Index of the row to subtract the value to
- c: number
  Index of the column to subtract the value to
- v: number
  Value to subtract
Returns number
Old value
- Defined in lib/util/matrix.d.ts:1077

sum

sum(): number
Returns summation value of all element.

Returns number
Summation value
- Defined in lib/util/matrix.d.ts:716
sum(axis: 0 | 1): Matrix<number>
Returns summation values along the axis.
Parameters
- axis: 0 | 1
 Axis to be reduced
Returns Matrix<number>
Summation values
- Defined in lib/util/matrix.d.ts:723
sum(axis: number): number | Matrix<number>
Returns summation values along the axis.
Parameters
- axis: number
 Axis to be reduced. If negative, returns a summation value of the all element.
Returns number | Matrix<number>
Summation values
- Defined in lib/util/matrix.d.ts:730

svd

svd(): [Matrix<number>, number[], Matrix<number>]
Returns a singular value decomposition.

Returns [Matrix<number>, number[], Matrix<number>]
Unitary matrix and singular values
- Defined in lib/util/matrix.d.ts:1467

svdEigen

svdEigen(): [Matrix<number>, number[], Matrix<number>]
Returns a singular value decomposition by eigen decomposition.

Returns [Matrix<number>, number[], Matrix<number>]
Unitary matrix and singular values
- Defined in lib/util/matrix.d.ts:1472

svdGolubKahan

svdGolubKahan(): [Matrix<number>, number[], Matrix<number>]
Returns a singular value decomposition by Golub-Kahan method.

Returns [Matrix<number>, number[], Matrix<number>]
Unitary matrix and singular values
- Defined in lib/util/matrix.d.ts:1477

swap

swap(a: number, b: number, axis?: number): void
Swap the index a and b along the axis.
Parameters
- a: number
  First index
- b: number
  Second index
- Optionalaxis: number
  Axis to be swapped
Returns void
- Defined in lib/util/matrix.d.ts:459

tDot

tDot(o: Matrix<number>): Matrix<number>
Returns a matrix product of the transposed matrix of this and input.
Parameters
- o: Matrix<number>
 Right matrix
Returns Matrix<number>
Producted matrix
- Defined in lib/util/matrix.d.ts:1227

toArray

toArray(): T[][]
Returns a nested array represented this matrix.

Returns T[][]
Nested array
- Defined in lib/util/matrix.d.ts:318

toScaler

toScaler(): T
Returns the only element.

Returns T
The only element
- Defined in lib/util/matrix.d.ts:323

toString

toString(): string
Returns a string represented this matrix.

Returns string
String represented this matrix
- Defined in lib/util/matrix.d.ts:328

trace

trace(): number
Returns a trace.

Returns number
Trace value
- Defined in lib/util/matrix.d.ts:919

transpose

transpose(): Matrix<T>
Returns transpose matrix.

Returns Matrix<T>
Transposed matrix
- Defined in lib/util/matrix.d.ts:442

tridiag

tridiag(): Matrix<number>
Returns a tridiagonal matrix.

Returns Matrix<number>
Tridiagonal matrix
- Defined in lib/util/matrix.d.ts:1390

tridiagHouseholder

tridiagHouseholder(return_u?: false): Matrix<number>
Returns a tridiagonal matrix.
Parameters
- Optionalreturn_u: false
 Returns orthogonal matrix
Returns Matrix<number>
Tridiagonal matrix, or Tridiagonal matrix and orthogonal matrix
- Defined in lib/util/matrix.d.ts:1397
tridiagHouseholder(return_u: true): [Matrix<number>, Matrix<number>]
Returns a tridiagonal matrix.
Parameters
- return_u: true
 Returns orthogonal matrix
Returns [Matrix<number>, Matrix<number>]
Tridiagonal matrix, or Tridiagonal matrix and orthogonal matrix
- Defined in lib/util/matrix.d.ts:1404

tridiagLanczos

tridiagLanczos(k?: number): Matrix<number>
Returns a tridiagonal matrix.
Parameters
- Optionalk: number
 Number of iterations
Returns Matrix<number>
Tridiagonal matrix
- Defined in lib/util/matrix.d.ts:1410

unique

unique(axis?: number, tol?: number): number[]
Make it unique in the specified axis.
Parameters
- Optionalaxis: number
  Axis to be uniqued
- Optionaltol: number
  Tolerance to be recognized as the same
Returns number[]
Selected indexes
- Defined in lib/util/matrix.d.ts:478

unsignedRightShift

unsignedRightShift(n: number): void
Set all elements to their unsigned right shift values.
Parameters
- n: number
  Shift amount
Returns void
- Defined in lib/util/matrix.d.ts:1022

variance

variance(): number
Returns variance of all element.

Returns number
Variance value
- Defined in lib/util/matrix.d.ts:776
variance(axis: 0 | 1, ddof?: number): Matrix<number>
Returns variances along the axis.
Parameters
- axis: 0 | 1
 Axis to be reduced.
- Optionalddof: number
 Delta Degrees of Freedom
Returns Matrix<number>
Variance values
- Defined in lib/util/matrix.d.ts:784
variance(axis: number, ddof?: number): number | Matrix<number>
Returns variances along the axis.
Parameters
- axis: number
 Axis to be reduced. If negative, returns a variance of the all element.
- Optionalddof: number
 Delta Degrees of Freedom
Returns number | Matrix<number>
Variance values
- Defined in lib/util/matrix.d.ts:792

`Static`add

add(a: number | Matrix<number>, b: number | Matrix<number>): Matrix<number>
Returns a matrix that add two values.
Parameters
- a: number | Matrix<number>
 Left value
- b: number | Matrix<number>
 Right value
Returns Matrix<number>
Added matrix
- Defined in lib/util/matrix.d.ts:198

`Static`and

and(a: number | Matrix<unknown>, b: number | Matrix<unknown>): Matrix<number>
Returns a matrix that takes logical AND two values.
Parameters
- a: number | Matrix<unknown>
 Left value
- b: number | Matrix<unknown>
 Right value
Returns Matrix<number>
Logical AND matrix
- Defined in lib/util/matrix.d.ts:233

`Static`bitand

bitand(a: number | Matrix<number>, b: number | Matrix<number>): Matrix<number>
Returns a matrix that takes bitwise AND two values.
Parameters
- a: number | Matrix<number>
 Left value
- b: number | Matrix<number>
 Right value
Returns Matrix<number>
Bitwise AND matrix
- Defined in lib/util/matrix.d.ts:247

`Static`bitor

bitor(a: number | Matrix<number>, b: number | Matrix<number>): Matrix<number>
Returns a matrix that takes bitwise OR two values.
Parameters
- a: number | Matrix<number>
 Left value
- b: number | Matrix<number>
 Right value
Returns Matrix<number>
Bitwise OR matrix
- Defined in lib/util/matrix.d.ts:254

`Static`bitxor

bitxor(a: number | Matrix<number>, b: number | Matrix<number>): Matrix<number>
Returns a matrix that takes bitwise XOR two values.
Parameters
- a: number | Matrix<number>
 Left value
- b: number | Matrix<number>
 Right value
Returns Matrix<number>
Bitwise XOR matrix
- Defined in lib/util/matrix.d.ts:261

`Static`concat

concat<T_1, U>(a: Matrix<T_1>, b: Matrix, axis?: number): Matrix<T_1 | U>
Returns a matrix concatenated this and m.
Type Parameters
- T_1
- U
Parameters
- a: Matrix<T_1>
 Original matrix
- b: Matrix
 Concatenate matrix
- Optionalaxis: number
 Axis to be concatenated
Returns Matrix<T_1 | U>
Concatenated matrix
- Defined in lib/util/matrix.d.ts:191

`Static`diag

diag<T_1>(d: (T_1 | Matrix<T_1>)[]): Matrix<T_1>
Returns a diagonal matrix.
Type Parameters
- T_1
Parameters
- d: (T_1 | Matrix<T_1>)[]
 Diagonal values
Returns Matrix<T_1>
Diagonal matrix
- Defined in lib/util/matrix.d.ts:127

`Static`div

div(a: number | Matrix<number>, b: number | Matrix<number>): Matrix<number>
Returns a matrix that divides by two values element-wise.
Parameters
- a: number | Matrix<number>
 Left value
- b: number | Matrix<number>
 Right value
Returns Matrix<number>
Divided matrix
- Defined in lib/util/matrix.d.ts:219

`Static`eye

eye(rows: number, cols: number, init?: number): Matrix<number>
Returns a identity matrix.
Parameters
- rows: number
 Number of rows
- cols: number
 Number of columns
- Optionalinit: number
 Diagonal values
Returns Matrix<number>
Identity matrix
- Defined in lib/util/matrix.d.ts:55
eye(size: [number, number], init?: number): Matrix<number>
Returns a identity matrix.
Parameters
- size: [number, number]
 Sizes for each dimension
- Optionalinit: number
 Diagonal values
Returns Matrix<number>
Identity matrix
- Defined in lib/util/matrix.d.ts:63

`Static`fromArray

fromArray<T_1>(arr: T_1 | Matrix<T_1> | T_1[] | T_1[][]): Matrix<T_1>
Returns a matrix from some value.
Type Parameters
- T_1
Parameters
- arr: T_1 | Matrix<T_1> | T_1[] | T_1[][]
 Original values
Returns Matrix<T_1>
Matrix from some value
- Defined in lib/util/matrix.d.ts:134

`Static`map

map<T_1, U>(
mat: Matrix<T_1>,
cb: (arg0: T_1, arg1: number[], arg2: Matrix<T_1>) => U,
): Matrix
Returns a matrix that replace all the elements.
Type Parameters
- T_1
- U
Parameters
- mat: Matrix<T_1>
 Original matrix
- cb: (arg0: T_1, arg1: number[], arg2: Matrix<T_1>) => U
 Mapping function
Returns Matrix
Mapped matrix
- Defined in lib/util/matrix.d.ts:142

`Static`mod

mod(a: number | Matrix<number>, b: number | Matrix<number>): Matrix<number>
Returns a matrix that takes a remainder divided by two values element-wise.
Parameters
- a: number | Matrix<number>
 Left value
- b: number | Matrix<number>
 Right value
Returns Matrix<number>
Remainder matrix
- Defined in lib/util/matrix.d.ts:226

`Static`mult

mult(a: number | Matrix<number>, b: number | Matrix<number>): Matrix<number>
Returns a matrix that multiplies by two values element-wise.
Parameters
- a: number | Matrix<number>
 Left value
- b: number | Matrix<number>
 Right value
Returns Matrix<number>
Multiplied matrix
- Defined in lib/util/matrix.d.ts:212

`Static`ones

ones(rows: number, cols: number): Matrix<number>
Returns a matrix filled with 1.
Parameters
- rows: number
 Number of rows
- cols: number
 Number of columns
Returns Matrix<number>
Matrix filled with 1
- Defined in lib/util/matrix.d.ts:39
ones(size: [number, number]): Matrix<number>
Returns a matrix filled with 1.
Parameters
- size: [number, number]
 Sizes for each dimension
Returns Matrix<number>
Matrix filled with 1
- Defined in lib/util/matrix.d.ts:46

`Static`or

or(a: number | Matrix<unknown>, b: number | Matrix<unknown>): Matrix<number>
Returns a matrix that takes logical OR two values.
Parameters
- a: number | Matrix<unknown>
 Left value
- b: number | Matrix<unknown>
 Right value
Returns Matrix<number>
Logical OR matrix
- Defined in lib/util/matrix.d.ts:240

`Static`randint

randint(rows: number, cols: number, min?: number, max?: number): Matrix<number>
Returns a matrix initialized uniform random integer values.
Parameters
- rows: number
 Number of rows
- cols: number
 Number of columns
- Optionalmin: number
 Minimum value of the Matrix (include)
- Optionalmax: number
 Maximum value of the Matrix (include)
Returns Matrix<number>
Matrix initialized uniform random values
- Defined in lib/util/matrix.d.ts:92
randint(size: [number, number], min?: number, max?: number): Matrix<number>
Returns a matrix initialized uniform random integer values.
Parameters
- size: [number, number]
 Sizes for each dimension
- Optionalmin: number
 Minimum value of the Matrix (include)
- Optionalmax: number
 Maximum value of the Matrix (include)
Returns Matrix<number>
Matrix initialized uniform random values
- Defined in lib/util/matrix.d.ts:101

`Static`randn

randn(
 rows: number,
 cols: number,
 myu?: number | number[],
 sigma?: number | number[][],
): Matrix<number>
Returns a matrix initialized normal random values.
Parameters
- rows: number
 Number of rows
- cols: number
 Number of columns
- Optionalmyu: number | number[]
 Mean value(s) of each columns
- Optionalsigma: number | number[][]
 Variance value or covariance matrix of each columns
Returns Matrix<number>
Matrix initialized normal random values
- Defined in lib/util/matrix.d.ts:111
randn(
 rows: [number, number],
 myu?: number | number[],
 sigma?: number | number[][],
): Matrix<number>
Returns a matrix initialized normal random values.
Parameters
- rows: [number, number]
 Sizes for each dimension
- Optionalmyu: number | number[]
 Mean value(s) of each columns
- Optionalsigma: number | number[][]
 Variance value or covariance matrix of each columns
Returns Matrix<number>
Matrix initialized normal random values
- Defined in lib/util/matrix.d.ts:120

`Static`random

random(rows: number, cols: number, min?: number, max?: number): Matrix<number>
Returns a matrix initialized uniform random values.
Parameters
- rows: number
 Number of rows
- cols: number
 Number of columns
- Optionalmin: number
 Minimum value of the Matrix (include)
- Optionalmax: number
 Maximum value of the Matrix (exclude)
Returns Matrix<number>
Matrix initialized uniform random values
- Defined in lib/util/matrix.d.ts:73
random(size: [number, number], min?: number, max?: number): Matrix<number>
Returns a matrix initialized uniform random values.
Parameters
- size: [number, number]
 Sizes for each dimension
- Optionalmin: number
 Minimum value of the Matrix (include)
- Optionalmax: number
 Maximum value of the Matrix (exclude)
Returns Matrix<number>
Matrix initialized uniform random values
- Defined in lib/util/matrix.d.ts:82

`Static`repeat

repeat<T_1>(mat: Matrix<T_1>, n: number, axis?: number): Matrix<T_1>
Returns a matrix that repeat the elements n times along the axis.
Type Parameters
- T_1
Parameters
- mat: Matrix<T_1>
 Original matrix
- n: number
 Repeated count
- Optionalaxis: number
 Axis to be repeated
Returns Matrix<T_1>
Repeated matrix
- Defined in lib/util/matrix.d.ts:173
repeat<T_1>(mat: Matrix<T_1>, n: number[]): Matrix<T_1>
Returns a matrix that repeat the elements n times along the axis.
Type Parameters
- T_1
Parameters
- mat: Matrix<T_1>
 Original matrix
- n: number[]
 Repeated counts for each axis
Returns Matrix<T_1>
Repeated matrix
- Defined in lib/util/matrix.d.ts:182

`Static`resize

resize<T_1>(
 mat: Matrix<T_1>,
 rows: number,
 cols: number,
 init?: T_1,
): Matrix<T_1>
Return resized matrix.
Type Parameters
- T_1
Parameters
- mat: Matrix<T_1>
 Original matrix
- rows: number
 New row size
- cols: number
 New column size
- Optionalinit: T_1
 Value of the extended region
Returns Matrix<T_1>
Resized matrix
- Defined in lib/util/matrix.d.ts:153
resize<T_1>(mat: Matrix<T_1>, rows: [number, number], init?: T_1): Matrix<T_1>
Return resized matrix.
Type Parameters
- T_1
Parameters
- mat: Matrix<T_1>
 Original matrix
- rows: [number, number]
 New sizes for each dimension
- Optionalinit: T_1
 Value of the extended region
Returns Matrix<T_1>
Resized matrix
- Defined in lib/util/matrix.d.ts:163

`Static`sub

sub(a: number | Matrix<number>, b: number | Matrix<number>): Matrix<number>
Returns a matrix that subtract two values.
Parameters
- a: number | Matrix<number>
 Left value
- b: number | Matrix<number>
 Right value
Returns Matrix<number>
Subtracted matrix
- Defined in lib/util/matrix.d.ts:205

`Static`zeros

zeros(rows: number, cols: number): Matrix<number>
Returns a matrix filled with 0.
Parameters
- rows: number
 Number of rows
- cols: number
 Number of columns
Returns Matrix<number>
Matrix filled with 0
- Defined in lib/util/matrix.d.ts:24
zeros(size: [number, number]): Matrix<number>
Returns a matrix filled with 0.
Parameters
- size: [number, number]
 Sizes for each dimension
Returns Matrix<number>
Matrix filled with 0
- Defined in lib/util/matrix.d.ts:31

Class Matrix<T>

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Matrix<T>

Type Parameters

Parameters

Returns Matrix<T>

Accessors

cols

Returns number

dimension

Returns number

length

Returns number

rows

Returns number

sizes

Returns number[]

t

Returns Matrix<T>

value

Returns T[]

Methods

[iterator]

Returns Generator<any, void, unknown>

Yields

abs

Returns void

add

Parameters

Returns void

addAt

Parameters

Returns number

adjoint

Returns Matrix<T>

and

Parameters

Returns void

andAt

Parameters

Returns T

argmax

Parameters

Returns Matrix<number>

argmin

Parameters

Returns Matrix<number>

at

Parameters

Returns T

Parameters

Returns T

balancing

Returns [number[], Matrix<number>, number[]]

balancingSinkhornKnopp

Returns [number[], Matrix<number>, number[]]

bidiag

Returns Matrix<number>

bidiagHouseholder

Parameters

Returns Matrix<number>

Parameters

Returns [Matrix<number>, Matrix<number>, Matrix<number>]

bitand

Parameters

Returns void

bitandAt

Parameters

Returns T

bitnot

Returns void

bitor