Interface SquareMatrix

A matrix with the same number of rows and columns.

See

interface SquareMatrix {
    height: number;
    width: number;
    get determinant(): number;
    get frob(): number;
    add(matrix: Matrix4Like): MatrixLike;
    adjoint(): MatrixLike;
    clone(): MatrixLike;
    copy(matrix: Matrix4Like): this;
    equals(matrix: Matrix4Like): boolean;
    exactEquals(matrix: Matrix4Like): boolean;
    identity(): this;
    invert(): MatrixLike;
    multiply(matrix: Matrix4Like): MatrixLike;
    multiplyScalar(scalar: number): MatrixLike;
    multiplyScalarAndAdd(matrix: Matrix4Like, scalar: number): MatrixLike;
    subtract(matrix: Matrix4Like): MatrixLike;
    transpose(): MatrixLike;
    [key: number]: number;
}

Hierarchy (View Summary, Expand)

Matrix
- SquareMatrix

Implemented by

Indexable

[key: number]: number

Index

Properties

Accessors

determinant frob

Methods

add adjoint clone copy equals exactEquals identity invert multiply multiplyScalar multiplyScalarAndAdd subtract transpose

Properties

height

height: number

The number of rows in this matrix.

width

width: number

The number of columns in this matrix.

Accessors

determinant

get determinant(): number
Get the determinant of this matrix.

Returns number
See
Determinant
- Defined in src/linalg/SquareMatrix.ts:12

frob

get frob(): number
Get the Frobenius norm of this matrix.

Returns number
See
Matrix norm
Inherited from Matrix.frob
- Defined in src/linalg/Matrix.ts:21

Methods

add

add(matrix: Matrix4Like): MatrixLike
Add two matrices of the same size.
Parameters
- matrix: Matrix4Like
  The other matrix.
Returns MatrixLike
The sum of the matrices.

See
Matrix addition
Inherited from Matrix.add
- Defined in src/linalg/Matrix.ts:29

adjoint

adjoint(): MatrixLike
Calculate the adjugate of this matrix.

Returns MatrixLike
The adjugate of this matrix.

See
Adjugate matrix
- Defined in src/linalg/SquareMatrix.ts:19

clone

clone(): MatrixLike
Create a copy of this matrix.

Returns MatrixLike
A copy of this matrix.
Inherited from Matrix.clone
- Defined in src/linalg/Matrix.ts:35

copy

copy(matrix: Matrix4Like): this
Copy the values of another matrix into this one.
Parameters
- matrix: Matrix4Like
  The matrix to copy.
Returns this
This matrix.
Inherited from Matrix.copy
- Defined in src/linalg/Matrix.ts:42

equals

equals(matrix: Matrix4Like): boolean
Determine whether or not this matrix is roughly equivalent to another.
Parameters
- matrix: Matrix4Like
  The other matrix.
Returns boolean
Whether the matrices are equivalent.
Inherited from Matrix.equals
- Defined in src/linalg/Matrix.ts:49

exactEquals

exactEquals(matrix: Matrix4Like): boolean
Determine whether or not this matrix is exactly equivalent to another.
Parameters
- matrix: Matrix4Like
  The other matrix.
Returns boolean
Whether the matrices are equivalent.
Inherited from Matrix.exactEquals
- Defined in src/linalg/Matrix.ts:56

identity

identity(): this
Reset this matrix to identity.

Returns this
This matrix.

See
Identity matrix
- Defined in src/linalg/SquareMatrix.ts:26

invert

invert(): MatrixLike
Invert this matrix.

Returns MatrixLike
The inverted matrix.

See
Invertible matrix
- Defined in src/linalg/SquareMatrix.ts:33

multiply

multiply(matrix: Matrix4Like): MatrixLike
Multiply this matrix by another.
Parameters
- matrix: Matrix4Like
  The other matrix.
Returns MatrixLike
The product of the matrices.

See
Matrix multiplication
Inherited from Matrix.multiply
- Defined in src/linalg/Matrix.ts:64

multiplyScalar

multiplyScalar(scalar: number): MatrixLike
Multiply this matrix by a scalar value.
Parameters
- scalar: number
  The scalar value.
Returns MatrixLike
The product of the matrix and the scalar value.

See
Matrix multiplication
Inherited from Matrix.multiplyScalar
- Defined in src/linalg/Matrix.ts:72

multiplyScalarAndAdd

multiplyScalarAndAdd(matrix: Matrix4Like, scalar: number): MatrixLike
Add this matrix to another after multiplying the other by a scalar.
Parameters
- matrix: Matrix4Like
  The other matrix.
- scalar: number
  The scalar.
Returns MatrixLike
The sum.
See
- Matrix addition
- Matrix multiplication
Inherited from Matrix.multiplyScalarAndAdd
- Defined in src/linalg/Matrix.ts:82

subtract

subtract(matrix: Matrix4Like): MatrixLike
Subtract another matrix from this one.
Parameters
- matrix: Matrix4Like
  The other matrix.
Returns MatrixLike
The difference between the matrices.

See
Matrix addition
Inherited from Matrix.subtract
- Defined in src/linalg/Matrix.ts:90

transpose

transpose(): MatrixLike
Transpose this matrix.

Returns MatrixLike
The transpose of this matrix.

See
Transpose
Inherited from Matrix.transpose
- Defined in src/linalg/Matrix.ts:97