Class WrapperMatrix2D

Readonly columns

Readonly rows

Readonly size

[iterator]

• [iterator](): Generator<[row: number, column: number, value: number], void, void>

• iterator from left to right, from top to bottom yield [row, column, value]

  Returns Generator<[row: number, column: number, value: number], void, void>

abs

• abs(): WrapperMatrix2D

• Returns WrapperMatrix2D

acos

• acos(): WrapperMatrix2D

• Returns WrapperMatrix2D

acosh

• acosh(): WrapperMatrix2D

• Returns WrapperMatrix2D

add

• add(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

addColumnVector

• addColumnVector(vector): WrapperMatrix2D

• Adds the values of a vector to each column.

  Parameters

  • vector: ArrayLike<number> | AbstractMatrix

    Array or vector.

  Returns WrapperMatrix2D

addRowVector

• addRowVector(vector): WrapperMatrix2D

• Adds the values of a vector to each row.

  Parameters

  • vector: ArrayLike<number> | AbstractMatrix

    Array or vector.

  Returns WrapperMatrix2D

and

• and(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

apply

• apply(callback): WrapperMatrix2D

• Applies a callback for each element of the matrix. The function is called in the matrix (this) context.

  Parameters

  • callback: ((row, column) => void)

    Function that will be called for each element in the matrix.

    • • (row, column): void

      • Parameters

        • row: number

        • column: number

        Returns void

  Returns WrapperMatrix2D

asin

• asin(): WrapperMatrix2D

• Returns WrapperMatrix2D

asinh

• asinh(): WrapperMatrix2D

• Returns WrapperMatrix2D

atan

• atan(): WrapperMatrix2D

• Returns WrapperMatrix2D

atanh

• atanh(): WrapperMatrix2D

• Returns WrapperMatrix2D

cbrt

• cbrt(): WrapperMatrix2D

• Returns WrapperMatrix2D

ceil

• ceil(): WrapperMatrix2D

• Returns WrapperMatrix2D

center

• center(options?): WrapperMatrix2D

• Center the matrix in-place. By default, the mean value of the matrix is subtracted from every value.

  Parameters

  • Optional options: ICenterOptions

  Returns WrapperMatrix2D
• center(by, options?): WrapperMatrix2D

• Center the matrix in-place. By default, the mean values in the give dimension are subtracted from the values.

  Parameters

  • by: MatrixDimension

    center by 'row' or 'column'.

  • Optional options: ICenterByOptions

  Returns WrapperMatrix2D

clone

• clone(): WrapperMatrix2D

• Creates an exact and independent copy of the matrix.

  Returns WrapperMatrix2D

clz32

• clz32(): WrapperMatrix2D

• Returns WrapperMatrix2D

cos

• cos(): WrapperMatrix2D

• Returns WrapperMatrix2D

cosh

• cosh(): WrapperMatrix2D

• Returns WrapperMatrix2D

cumulativeSum

• cumulativeSum(): WrapperMatrix2D

• Computes the cumulative sum of the matrix elements (in place, row by row).

  Returns WrapperMatrix2D

diag

• diag(): number[]

• Returns an array containing the diagonal values of the matrix.

  Returns number[]

diagonal

• diagonal(): number[]

• Alias for AbstractMatrix.diag.

  Returns number[]

div

• div(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

divColumnVector

• divColumnVector(vector): WrapperMatrix2D

• Divides the values of each column by those of a vector.

  Parameters

  • vector: ArrayLike<number> | AbstractMatrix

    Array or vector.

  Returns WrapperMatrix2D

divRowVector

• divRowVector(vector): WrapperMatrix2D

• Divides the values of each row by those of a vector.

  Parameters

  • vector: ArrayLike<number> | AbstractMatrix

    Array or vector.

  Returns WrapperMatrix2D

divide

• divide(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

dot

• dot(vector): number

• Computes the dot (scalar) product between the matrix and another.

  Parameters

  • vector: AbstractMatrix

  Returns number

echelonForm

• echelonForm(): Matrix

• Returns the row echelon form of the matrix computed using gaussian elimination.

  Returns Matrix

entries

• entries(): Generator<[row: number, column: number, value: number], void, void>

• iterator from left to right, from top to bottom yield [row, column, value]

  Returns Generator<[row: number, column: number, value: number], void, void>

exp

• exp(): WrapperMatrix2D

• Returns WrapperMatrix2D

expm1

• expm1(): WrapperMatrix2D

• Returns WrapperMatrix2D

fill

• fill(value): WrapperMatrix2D

• Fills the matrix with a given value. All elements will be set to this value.

  Parameters

  • value: number

    New value.

  Returns WrapperMatrix2D

flipColumns

• flipColumns(): WrapperMatrix2D

• Returns WrapperMatrix2D

flipRows

• flipRows(): WrapperMatrix2D

• Returns WrapperMatrix2D

floor

• floor(): WrapperMatrix2D

• Returns WrapperMatrix2D

fround

• fround(): WrapperMatrix2D

• Returns WrapperMatrix2D

getColumn

• getColumn(index): number[]

• Returns a new array with the values from the given column index.

  Parameters

  • index: number

    Column index.

  Returns number[]

getColumnVector

• getColumnVector(index): Matrix

• Returns a new column vector with the values from the given column index.

  Parameters

  • index: number

    Column index.

  Returns Matrix

getRow

• getRow(index): number[]

• Returns a new array with the values from the given row index.

  Parameters

  • index: number

    Row index.

  Returns number[]

getRowVector

• getRowVector(index): Matrix

• Returns a new row vector with the values from the given row index.

  Parameters

  • index: number

    Row index.

  Returns Matrix

isColumnVector

• isColumnVector(): boolean

• Returns whether the matrix has one column.

  Returns boolean

isDistance

• isDistance(): boolean

• Returns whether the matrix is symmetric and diagonal values are equals to 0

  Returns boolean

isEchelonForm

• isEchelonForm(): boolean

• Returns whether the matrix is in row echelon form.

  Returns boolean

isEmpty

• isEmpty(): boolean

• Returns whether the number of rows or columns (or both) is zero.

  Returns boolean

isReducedEchelonForm

• isReducedEchelonForm(): boolean

• Returns whether the matrix is in reduced row echelon form.

  Returns boolean

isRowVector

• isRowVector(): boolean

• Returns whether the matrix has one row.

  Returns boolean

isSquare

• isSquare(): boolean

• Returns whether the matrix has the same number of rows and columns.

  Returns boolean

isSymmetric

• isSymmetric(): boolean

• Returns whether the matrix is square and has the same values on both sides of the diagonal.

  Returns boolean

isVector

• isVector(): boolean

• Returns whether the matrix has one row or one column.

  Returns boolean

kroneckerProduct

• kroneckerProduct(other): Matrix

• Returns the Kronecker product (also known as tensor product) between this and other.

  Parameters

  • other: MaybeMatrix

    Other matrix.

  Returns Matrix

  Link

  https://en.wikipedia.org/wiki/Kronecker_product

kroneckerSum

• kroneckerSum(other): Matrix

• Returns the Kronecker sum between this and other.

  Parameters

  • other: MaybeMatrix

    Other matrix.

  Returns Matrix

  Link

  https://en.wikipedia.org/wiki/Kronecker_product#Kronecker_sum

leftShift

• leftShift(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

log

• log(): WrapperMatrix2D

• Returns WrapperMatrix2D

log10

• log10(): WrapperMatrix2D

• Returns WrapperMatrix2D

log1p

• log1p(): WrapperMatrix2D

• Returns WrapperMatrix2D

log2

• log2(): WrapperMatrix2D

• Returns WrapperMatrix2D

max

• max(): number

• Returns the maximum value of the matrix.

  Returns number
• max(by): number[]

• Returns the maximum value by the given dimension.

  Parameters

  • by: MatrixDimension

    max by 'row' or 'column'.

  Returns number[]

maxColumn

• maxColumn(column): number

• Returns the maximum value of one column.

  Parameters

  • column: number

    Column index.

  Returns number

maxColumnIndex

• maxColumnIndex(column): [number, number]

• Returns the index of the maximum value of one column.

  Parameters

  • column: number

    Column index.

  Returns [number, number]

maxIndex

• maxIndex(): [number, number]

• Returns the index of the maximum value.

  Returns [number, number]

maxRow

• maxRow(row): number

• Returns the maximum value of one row.

  Parameters

  • row: number

    Row index.

  Returns number

maxRowIndex

• maxRowIndex(row): [number, number]

• Returns the index of the maximum value of one row.

  Parameters

  • row: number

    Row index.

  Returns [number, number]

mean

• mean(): number

• Returns the mean of all elements of the matrix.

  Returns number
• mean(by): number[]

• Returns the mean by the given dimension.

  Parameters

  • by: MatrixDimension

    mean by 'row' or 'column'.

  Returns number[]

min

• min(): number

• Returns the minimum value of the matrix.

  Returns number
• min(by): number[]

• Returns the minimum value by the given dimension.

  Parameters

  • by: MatrixDimension

    min by 'row' or 'column'.

  Returns number[]

minColumn

• minColumn(column): number

• Returns the minimum value of one column.

  Parameters

  • column: number

    Column index.

  Returns number

minColumnIndex

• minColumnIndex(column): [number, number]

• Returns the index of the minimum value of one column.

  Parameters

  • column: number

    Column index.

  Returns [number, number]

minIndex

• minIndex(): [number, number]

• Returns the index of the minimum value.

  Returns [number, number]

minRow

• minRow(row): number

• Returns the minimum value of one row.

  Parameters

  • row: number

    Row index.

  Returns number

minRowIndex

• minRowIndex(row): [number, number]

• Returns the index of the maximum value of one row.

  Parameters

  • row: number

    Row index.

  Returns [number, number]

mmul

• mmul(other): Matrix

• Returns the matrix product between this and other.

  Parameters

  • other: MaybeMatrix

    Other matrix.

  Returns Matrix

mmulStrassen

• mmulStrassen(y): Matrix

• Parameters

  • y: MaybeMatrix

  Returns Matrix

mod

• mod(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

modulus

• modulus(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

mpow

• mpow(scalar): Matrix

• Returns the square matrix raised to the given power

  Parameters

  • scalar: number

    the non-negative integer power to raise this matrix to

  Returns Matrix

mul

• mul(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

mulColumn

• mulColumn(index, value): WrapperMatrix2D

• Multiplies the values of a column with a scalar.

  Parameters

  • index: number

    Column index.

  • value: number

  Returns WrapperMatrix2D

mulColumnVector

• mulColumnVector(vector): WrapperMatrix2D

• Multiplies the values of a vector with each column.

  Parameters

  • vector: ArrayLike<number> | AbstractMatrix

    Array or vector.

  Returns WrapperMatrix2D

mulRow

• mulRow(index, value): WrapperMatrix2D

• Multiplies the values of a row with a scalar.

  Parameters

  • index: number

    Row index.

  • value: number

  Returns WrapperMatrix2D

mulRowVector

• mulRowVector(vector): WrapperMatrix2D

• Multiplies the values of a vector with each row.

  Parameters

  • vector: ArrayLike<number> | AbstractMatrix

    Array or vector.

  Returns WrapperMatrix2D

multiply

• multiply(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

neg

• neg(): WrapperMatrix2D

• Negates the matrix. All elements will be multiplied by -1.

  Returns WrapperMatrix2D

negate

• negate(): WrapperMatrix2D

• Alias for AbstractMatrix.neg.

  Returns WrapperMatrix2D

norm

• norm(type?): number

• Returns the norm of a matrix.

  Parameters

  • Optional type: "max" | "frobenius"

    Norm type. Default: 'frobenius'.

  Returns number

not

• not(): WrapperMatrix2D

• Returns WrapperMatrix2D

or

• or(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

pow

• pow(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

product

• product(): number

• Returns the product of all elements of the matrix.

  Returns number
• product(by): number[]

• Returns the product by the given dimension.

  Parameters

  • by: MatrixDimension

    product by 'row' or 'column'.

  Returns number[]

reducedEchelonForm

• reducedEchelonForm(): Matrix

• Returns the reduced row echelon form of the matrix computed using gaussian elimination.

  Returns Matrix

repeat

• repeat(options?): Matrix

• Creates a new matrix that is a repetition of the current matrix. New matrix has rows times the number of rows of the original matrix, and columns times the number of columns of the original matrix.

  Parameters

  • Optional options: IRepeatOptions

  Returns Matrix

  Example

  var matrix = new Matrix([[1, 2]]);
  matrix.repeat({ rows: 2 }); // [[1, 2], [1, 2]]
  Copy

rightShift

• rightShift(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

round

• round(): WrapperMatrix2D

• Returns WrapperMatrix2D

scale

• scale(options?): WrapperMatrix2D

• Scale the matrix in-place. By default, values are divided by their standard deviation.

  Parameters

  • Optional options: IScaleOptions

  Returns WrapperMatrix2D
• scale(by, options?): WrapperMatrix2D

• Scale the matrix in-place. By default, values are divided by the standard deviation in the given dimension.

  Parameters

  • by: MatrixDimension

    scale by 'row' or 'column'.

  • Optional options: IScaleByOptions

  Returns WrapperMatrix2D

scaleColumns

• scaleColumns(options?): Matrix

• Returns a new column-by-column scaled matrix.

  Parameters

  • Optional options: IScaleOptions

  Returns Matrix

  Example

  var matrix = new Matrix([[1, 2], [-1, 0]]);
  var scaledMatrix = matrix.scaleColumns(); // [[1, 1], [0, 0]]
  Copy

scaleRows

• scaleRows(options?): Matrix

• Returns a new row-by-row scaled matrix.

  Parameters

  • Optional options: IScaleOptions

  Returns Matrix

selection

• selection(rowIndices, columnIndices): Matrix

• Return a new matrix based on a selection of rows and columns. Order of the indices matters and the same index can be used more than once.

  Parameters

  • rowIndices: ArrayLike<number>

    The row indices to select.

  • columnIndices: ArrayLike<number>

    The column indices to select.

  Returns Matrix

setColumn

• setColumn(index, array): WrapperMatrix2D

• Sets a column at the given index.

  Parameters

  • index: number

    Column index.

  • array: ArrayLike<number> | AbstractMatrix

    Array or vector to set.

  Returns WrapperMatrix2D

setRow

• setRow(index, array): WrapperMatrix2D

• Sets a row at the given index.

  Parameters

  • index: number

    Row index.

  • array: ArrayLike<number> | AbstractMatrix

    Array or vector to set.

  Returns WrapperMatrix2D

setSubMatrix

• setSubMatrix(matrix, startRow, startColumn): WrapperMatrix2D

• Set a part of the matrix to the given sub-matrix.

  Parameters

  • matrix: MaybeMatrix

    The source matrix from which to extract values.

  • startRow: number

    The index of the first row to set.

  • startColumn: number

    The index of the first column to set.

  Returns WrapperMatrix2D

sign

• sign(): WrapperMatrix2D

• Returns WrapperMatrix2D

signPropagatingRightShift

• signPropagatingRightShift(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

sin

• sin(): WrapperMatrix2D

• Returns WrapperMatrix2D

sinh

• sinh(): WrapperMatrix2D

• Returns WrapperMatrix2D

sortColumns

• sortColumns(compareFunction?): WrapperMatrix2D

• Sorts the columns in-place.

  Parameters

  • Optional compareFunction: ((a, b) => number)

    • • (a, b): number

      • Parameters

        • a: number

        • b: number

        Returns number

  Returns WrapperMatrix2D

sortRows

• sortRows(compareFunction?): WrapperMatrix2D

• Sorts the rows in-place.

  Parameters

  • Optional compareFunction: ((a, b) => number)

    • • (a, b): number

      • Parameters

        • a: number

        • b: number

        Returns number

  Returns WrapperMatrix2D

sqrt

• sqrt(): WrapperMatrix2D

• Returns WrapperMatrix2D

standardDeviation

• standardDeviation(options?): number

• Returns the standard deviation of all elements of the matrix.

  Parameters

  • Optional options: IVarianceOptions

  Returns number
• standardDeviation(by, options?): number[]

• Returns the standard deviation by the given dimension.

  Parameters

  • by: MatrixDimension

    standard deviation by 'row' or 'column'.

  • Optional options: IVarianceByOptions

  Returns number[]

strassen2x2

• strassen2x2(other): Matrix

• Parameters

  • other: MaybeMatrix

  Returns Matrix

strassen3x3

• strassen3x3(other): Matrix

• Parameters

  • other: MaybeMatrix

  Returns Matrix

sub

• sub(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

subColumnVector

• subColumnVector(vector): WrapperMatrix2D

• Subtracts the values of a vector from each column.

  Parameters

  • vector: ArrayLike<number> | AbstractMatrix

    Array or vector.

  Returns WrapperMatrix2D

subMatrix

• subMatrix(startRow, endRow, startColumn, endColumn): Matrix

• Returns a subset of the matrix.

  Parameters

  • startRow: number

    First row index.

  • endRow: number

    Last row index.

  • startColumn: number

    First column index.

  • endColumn: number

    Last column index.

  Returns Matrix

subMatrixColumn

• subMatrixColumn(indices, startRow?, endRow?): Matrix

• Returns a subset of the matrix based on an array of column indices.

  Parameters

  • indices: ArrayLike<number>

    Array containing the column indices.

  • Optional startRow: number

    First row index. Default: 0.

  • Optional endRow: number

    Last row index. Default: this.rows - 1.

  Returns Matrix

subMatrixRow

• subMatrixRow(indices, startColumn?, endColumn?): Matrix

• Returns a subset of the matrix based on an array of row indices.

  Parameters

  • indices: ArrayLike<number>

    Array containing the row indices.

  • Optional startColumn: number

    First column index. Default: 0.

  • Optional endColumn: number

    Last column index. Default: this.columns - 1.

  Returns Matrix

subRowVector

• subRowVector(vector): WrapperMatrix2D

• Subtracts the values of a vector from each row.

  Parameters

  • vector: ArrayLike<number> | AbstractMatrix

    Array or vector.

  Returns WrapperMatrix2D

subtract

• subtract(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

sum

• sum(): number

• Returns the sum of all elements of the matrix.

  Returns number
• sum(by): number[]

• Returns the sum by the given dimension.

  Parameters

  • by: MatrixDimension

    sum by 'row' or 'column'.

  Returns number[]

swapColumns

• swapColumns(column1, column2): WrapperMatrix2D

• Swap two columns.

  Parameters

  • column1: number

    First column index.

  • column2: number

    Second column index.

  Returns WrapperMatrix2D

swapRows

• swapRows(row1, row2): WrapperMatrix2D

• Swap two rows.

  Parameters

  • row1: number

    First row index.

  • row2: number

    Second row index.

  Returns WrapperMatrix2D

tan

• tan(): WrapperMatrix2D

• Returns WrapperMatrix2D

tanh

• tanh(): WrapperMatrix2D

• Returns WrapperMatrix2D

tensorProduct

• tensorProduct(other): Matrix

• Alias for AbstractMatrix.kroneckerProduct.

  Parameters

  • other: MaybeMatrix

  Returns Matrix

to1DArray

• to1DArray(): number[]

• Returns a new 1D array filled row by row with the matrix values.

  Returns number[]

to2DArray

• to2DArray(): number[][]

• Returns a 2D array containing a copy of the matrix data.

  Returns number[][]

toJSON

• toJSON(): number[][]

• Returns number[][]

toString

• toString(options?): string

• Parameters

  • Optional options: IToStringOptions

  Returns string

trace

• trace(): number

• Returns the trace of the matrix (sum of the diagonal elements).

  Returns number

transpose

• transpose(): Matrix

• Transposes the matrix and returns a new one containing the result.

  Returns Matrix

trunc

• trunc(): WrapperMatrix2D

• Returns WrapperMatrix2D

values

• values(): Generator<number, void, void>

• iterator from left to right, from top to bottom yield value

  Returns Generator<number, void, void>

variance

• variance(options?): number

• Returns the variance of all elements of the matrix.

  Parameters

  • Optional options: IVarianceOptions

  Returns number
• variance(by, options?): number[]

• Returns the variance by the given dimension.

  Parameters

  • by: MatrixDimension

    variance by 'row' or 'column'.

  • Optional options: IVarianceByOptions

  Returns number[]

xor

• xor(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

zeroFillRightShift

• zeroFillRightShift(value): WrapperMatrix2D

• Parameters

  • value: ScalarOrMatrix

  Returns WrapperMatrix2D

Static abs

• abs(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static acos

• acos(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static acosh

• acosh(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static add

• add(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static and

• and(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static asin

• asin(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static asinh

• asinh(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static atan

• atan(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static atanh

• atanh(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static cbrt

• cbrt(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static ceil

• ceil(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static checkMatrix

• checkMatrix(value): Matrix

• Check that the provided value is a Matrix and tries to instantiate one if not.

  Parameters

  • value: any

    The value to check.

  Returns Matrix

Static clz32

• clz32(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static columnVector

• columnVector(newData): Matrix

• Creates a column vector, a matrix with only one column.

  Parameters

  • newData: ArrayLike<number>

    A 1D array containing data for the vector.

  Returns Matrix

  The new matrix.

Static copy

• copy<M>(from, to): M

• Type Parameters

  • M extends AbstractMatrix

  Parameters

  • from: AbstractMatrix

  • to: M

  Returns M

Static cos

• cos(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static cosh

• cosh(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static diag

• diag(data, rows?, columns?): Matrix

• Creates a diagonal matrix based on the given array.

  Parameters

  • data: ArrayLike<number>

    Array containing the data for the diagonal.

  • Optional rows: number

    Number of rows. Default: data.length.

  • Optional columns: number

    Number of columns. Default: rows.

  Returns Matrix

  • The new diagonal matrix.

Static diagonal

• diagonal(data, rows?, columns?): Matrix

• Alias for AbstractMatrix.diag.

  Parameters

  • data: ArrayLike<number>

  • Optional rows: number

  • Optional columns: number

  Returns Matrix

Static div

• div(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static divide

• divide(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static exp

• exp(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static expm1

• expm1(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static eye

• eye(rows, columns?, value?): Matrix

• Creates an identity matrix with the given dimension. Values of the diagonal will be 1 and others will be 0.

  Parameters

  • rows: number

    Number of rows.

  • Optional columns: number

    Number of columns. Default: rows.

  • Optional value: number

    Value to fill the diagonal with. Default: 1.

  Returns Matrix

  • The new identity matrix.

Static floor

• floor(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static from1DArray

• from1DArray(newRows, newColumns, newData): Matrix

• Constructs a matrix with the chosen dimensions from a 1D array.

  Parameters

  • newRows: number

    Number of rows.

  • newColumns: number

    Number of columns.

  • newData: ArrayLike<number>

    A 1D array containing data for the matrix.

  Returns Matrix

  The new matrix.

Static fround

• fround(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static identity

• identity(rows, columns?, value?): Matrix

• Alias for AbstractMatrix.eye.

  Parameters

  • rows: number

  • Optional columns: number

  • Optional value: number

  Returns Matrix

Static isMatrix

• isMatrix(value): value is AbstractMatrix

• Returns whether value is a Matrix.

  Parameters

  • value: any

    The value to check.

  Returns value is AbstractMatrix

Static leftShift

• leftShift(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static log

• log(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static log10

• log10(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static log1p

• log1p(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static log2

• log2(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static max

• max(matrix1, matrix2): Matrix

• Returns a matrix whose elements are the maximum between matrix1 and matrix2.

  Parameters

  • matrix1: MaybeMatrix

  • matrix2: MaybeMatrix

  Returns Matrix

Static min

• min(matrix1, matrix2): Matrix

• Returns a matrix whose elements are the minimum between matrix1 and matrix2.

  Parameters

  • matrix1: MaybeMatrix

  • matrix2: MaybeMatrix

  Returns Matrix

Static mod

• mod(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static modulus

• modulus(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static mul

• mul(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static multiply

• multiply(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static not

• not(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static ones

• ones<M>(rows, columns): M

• Creates a matrix with the given dimensions. Values will be set to one.

  Type Parameters

  • M extends AbstractMatrix = Matrix

  Parameters

  • rows: number

    Number of rows.

  • columns: number

    Number of columns.

  Returns M

  The new matrix.

Static or

• or(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static pow

• pow(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static rand

• rand(rows, columns, options?): Matrix

• Creates a matrix with the given dimensions. Values will be randomly set.

  Parameters

  • rows: number

    Number of rows.

  • columns: number

    Number of columns.

  • Optional options: IRandomOptions

    Options object.

  Returns Matrix

  The new matrix.

Static randInt

• randInt(rows, columns, options?): Matrix

• Creates a matrix with the given dimensions. Values will be random integers.

  Parameters

  • rows: number

    Number of rows.

  • columns: number

    Number of columns.

  • Optional options: IRandomIntOptions

  Returns Matrix

  • The new matrix.

Static random

• random(rows, columns, options?): Matrix

• Parameters

  • rows: number

  • columns: number

  • Optional options: IRandomOptions

  Returns Matrix

Static rightShift

• rightShift(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static round

• round(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static rowVector

• rowVector(newData): Matrix

• Creates a row vector, a matrix with only one row.

  Parameters

  • newData: ArrayLike<number>

    A 1D array containing data for the vector.

  Returns Matrix

  The new matrix.

Static sign

• sign(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static signPropagatingRightShift

• signPropagatingRightShift(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static sin

• sin(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static sinh

• sinh(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static sqrt

• sqrt(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static sub

• sub(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static subtract

• subtract(matrix, value): Matrix

• Parameters

  • matrix: MaybeMatrix

  • value: ScalarOrMatrix

  Returns Matrix

Static tan

• tan(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix

Static tanh

• tanh(value): Matrix

• Parameters

  • value: MaybeMatrix

  Returns Matrix