geometry-processing-js

Class: DenseMatrix

LinearAlgebra. DenseMatrix

new DenseMatrix()

This class represents a real m by n real matrix where every entry, including
zero-valued entries, is stored explicitly. Do not create a DenseMatrix
from its constructor, instead use static factory methods such as zeros,
identity, ones, constant and random.

Example
let A = DenseMatrix.zeros(20, 5);
let B = DenseMatrix.identity(10, 10);
let C = DenseMatrix.ones(100, 1);
let D = DenseMatrix.constant(4.6, 5, 5);
let E = DenseMatrix.random(5, 20);

Methods

<static> zeros(m, n)

Initializes a m by n matrix of zeros.

Parameters:
Name Type Description
m number

The number of rows in this dense matrix.
n number

The number of columns in this dense matrix.
Returns:
Type
module:LinearAlgebra.DenseMatrix

<static> identity(m, n)

Initializes a m by n identity matrix.

Parameters:
Name Type Description
m number

The number of rows in this dense matrix.
n number

The number of columns in this dense matrix.
Returns:
Type
module:LinearAlgebra.DenseMatrix

<static> ones(m, n)

Initializes a m by n matrix of ones.

Parameters:
Name Type Description
m number

The number of rows in this dense matrix.
n number

The number of columns in this dense matrix.
Returns:
Type
module:LinearAlgebra.DenseMatrix

<static> constant(x, m, n)

Initializes a m by n constant matrix.

Parameters:
Name Type Description
x number

The constant value stored in every entry of this dense matrix.
m number

The number of rows in this dense matrix.
n number

The number of columns in this dense matrix.
Returns:
Type
module:LinearAlgebra.DenseMatrix

<static> random(m, n)

Initializes a m by n random matrix.

Parameters:
Name Type Description
m number

The number of rows in this dense matrix.
n number

The number of columns in this dense matrix.
Returns:
Type
module:LinearAlgebra.DenseMatrix

transpose()

Returns the transpose of this dense matrix.

Returns:
Type
module:LinearAlgebra.DenseMatrix

nRows()

Returns the number of rows in this dense matrix.

Returns:
Type
number

nCols()

Returns the number of columns in this dense matrix.

Returns:
Type
number

norm(n)

Computes the lInfinity, l1 or l2 norm of this dense matrix.

Parameters:
Name Type Description
n number

Computes the lInfinity norm if n = 0, l1 norm if n = 1
and l2 norm if n = 2.
Returns:
Type
number

rank()

Returns the rank of this dense matrix.

Returns:
Type
number

sum()

Sums all the entries in this dense matrix.

Returns:
Type
number

subMatrix(r0, r1, c0, c1)

Extracts a sub-matrix in the range [r0, r1) x [c0, c1), i.e., a matrix
of size (r1 - r0) x (c1 - c0) starting at indices (r0, c0).

Parameters:
Name Type Description
r0 number

The start row index.
r1 number

The end row index (not included).
c0 number

The start column index.
c1 number

The end column index (not included).
Returns:
Type
module:LinearAlgebra.DenseMatrix

incrementBy(B)

A += B

Parameters:
Name Type Description
B module:LinearAlgebra.DenseMatrix

The dense matrix added to this dense matrix.

decrementBy(B)

A -= B

Parameters:
Name Type Description
B module:LinearAlgebra.DenseMatrix

The dense matrix subtracted from this dense matrix.

scaleBy(s)

A *= s

Parameters:
Name Type Description
s number

The number this dense matrix is scaled by.

plus(B)

Returns A + B

Parameters:
Name Type Description
B module:LinearAlgebra.DenseMatrix

The dense matrix added to this dense matrix.
Returns:
Type
module:LinearAlgebra.DenseMatrix

minus(B)

Returns A - B

Parameters:
Name Type Description
B module:LinearAlgebra.DenseMatrix

The dense matrix subtracted from this dense matrix.
Returns:
Type
module:LinearAlgebra.DenseMatrix

timesReal(s)

Returns A * s

Parameters:
Name Type Description
s number

The number this dense matrix is multiplied by.
Returns:
Type
module:LinearAlgebra.DenseMatrix

timesDense(B)

Returns A * B

Parameters:
Name Type Description
B module:LinearAlgebra.DenseMatrix

The dense matrix this dense matrix is multiplied by.
Returns:
Type
module:LinearAlgebra.DenseMatrix

negated()

Returns -A

Returns:
Type
module:LinearAlgebra.DenseMatrix

get(i, j)

Returns A(i, j)

Parameters:
Name Type Description
i number

The ith row of this dense matrix.
j number

The jth column of this dense matrix.
Returns:
Type
number

set(x, i, j)

A(i, j) = x

Parameters:
Name Type Description
x number

The real value the (i, j)th entry of this dense matrix is set to.
i number

The ith row of this dense matrix.
j number

The jth column of this dense matrix.

hcat(B)

Concatenates two dense matrices horizontally.

Parameters:
Name Type Description
B module:LinearAlgebra.DenseMatrix

The dense matrix that is concatenated horizontally
with this dense matrix.
Returns:
Type
module:LinearAlgebra.DenseMatrix

vcat(B)

Concatenates two dense matrices vertically.

Parameters:
Name Type Description
B module:LinearAlgebra.DenseMatrix

The dense matrix that is concatenated vertically
with this dense matrix.
Returns:
Type
module:LinearAlgebra.DenseMatrix