mecks


Minimum Linear Algebra Library

Usage

npm install mecks

mecks was built immutable on purpose and relies on the vecks vector library.

Contributing

While developing make sure you use gulp watch to ease the process of testing your contribution.

Documentation

*

Matrix2

Members:

+ nullMatrixData
+ identityMatrixData

*

$3

A 2x2 matrix

$3

Construct the matrix using a linearized array

$3

Access an element of the matrix.

Parameters

i: number, row index

j: number, column index

$3

Get all elements of the matrix.

Returns: Array.<number>, linearized data of the matrix

$3

Calculate the determinant of the matrix.

Returns: float

$3

Invert the Matrix.

Returns: Matrix2

$3

Multiply a given vector with this matrix.

Parameters

v: , Multiply a given vector with this matrix.

Returns: Vec2

$3

Add a given righthandside Matrix2 to this Matrix.

Parameters

rhs: , Add a given righthandside Matrix2 to this Matrix.

Returns: Matrix2

$3

Subtract a given righthandside Matrix2 to this Matrix.

Parameters

rhs: , Subtract a given righthandside Matrix2 to this Matrix.

Returns: Matrix2

$3

Multiply the Matrix by a given righthandside Matrix2.

Parameters

rhs: , Multiply the Matrix by a given righthandside Matrix2.

Returns: Matrix2

$3

Add a Scalar value to the Matrix.

Parameters

s: , Add a Scalar value to the Matrix.

Returns: Matrix2

$3

Subtract a Scalar value from the Matrix.

Parameters

s: , Subtract a Scalar value from the Matrix.

Returns: Matrix2

$3

Multiply the Matrix by a Scalar Value.

Parameters

s: , Multiply the Matrix by a Scalar Value.

Returns: Matrix2

$3

Divide the Matrix by a Scalar Value.

Parameters

s: , Divide the Matrix by a Scalar Value.

Returns: Matrix2

$3

Returns a new Identity Matrix.

Returns: Matrix2

$3

Returns a new Null Matrix.

Returns: Matrix2

*

Matrix3

Members:

+ nullMatrixData
+ identityMatrixData

*

$3

A 3x3 matrix

$3

Construct the matrix using a linearized array

$3

Access an element of the matrix.

Parameters

i: number, row index

j: number, column index

$3

Get all elements of the matrix.

Returns: Array.<number>, linearized data of the matrix

$3

Calculate the determinant of the matrix.

Returns: float

$3

Invert the Matrix.

Returns: Matrix3

$3

Add a given righthandside Matrix4 to this Matrix.

Parameters

rhs: , Add a given righthandside Matrix4 to this Matrix.

Returns: Matrix3

$3

Subtract a given righthandside Matrix4 to this Matrix.

Parameters

rhs: , Subtract a given righthandside Matrix4 to this Matrix.

Returns: Matrix3

$3

Multiply the Matrix by a given righthandside Matrix.

Parameters

rhs: , Multiply the Matrix by a given righthandside Matrix.

Returns: Matrix3

$3

Multiply a given vector

Parameters

rhs: , Multiply a given vector

Returns: Vec3

$3

Add a Scalar value to the Matrix.

Parameters

s: , Add a Scalar value to the Matrix.

Returns: Matrix4

$3

Subtract a Scalar value from the Matrix.

Parameters

s: , Subtract a Scalar value from the Matrix.

Returns: Matrix4

$3

Multiply the Matrix by a Scalar Value.

Parameters

s: , Multiply the Matrix by a Scalar Value.

Returns: Matrix4

$3

Divide the Matrix by a Scalar Value.

Parameters

s: , Divide the Matrix by a Scalar Value.

Returns: Matrix4

$3

Returns a new Identity Matrix.

Returns: Matrix3

$3

Returns a new Null Matrix.

Returns: Matrix3

*

Matrix4

Members:

+ nullMatrixData
+ identityMatrixData

*

$3

A 4x4 matrix

$3

Access an element of the matrix.

Parameters

i: number, row index

j: number, column index

$3

Get all elements of the matrix.

Returns: Array.<number>, linearized data of the matrix

$3

Calculate the determinant of the matrix.

Returns: float

$3

Invert the Matrix.

Returns: Matrix2

$3

Multiply a given vector with this matrix.

Parameters

rhs: , Multiply a given vector with this matrix.

Returns: Vec3

$3

Add a given righthandside Matrix4 to this Matrix.

Parameters

rhs: , Add a given righthandside Matrix4 to this Matrix.

Returns: Matrix4

$3

Subtract a given righthandside Matrix4 to this Matrix.

Parameters

rhs: , Subtract a given righthandside Matrix4 to this Matrix.

Returns: Matrix4

$3

Multiply the Matrix by a given righthandside Matrix4.

Parameters

rhs: , Multiply the Matrix by a given righthandside Matrix4.

Returns: Matrix4

$3

Add a Scalar value to the Matrix.

Parameters

s: , Add a Scalar value to the Matrix.

Returns: Matrix4

$3

Subtract a Scalar value from the Matrix.

Parameters

s: , Subtract a Scalar value from the Matrix.

Returns: Matrix4

$3

Multiply the Matrix by a Scalar Value.

Parameters

s: , Multiply the Matrix by a Scalar Value.

Returns: Matrix4

$3

Divide the Matrix by a Scalar Value.

Parameters

s: , Divide the Matrix by a Scalar Value.

Returns: Matrix4

$3

Returns a new Identity Matrix.

Returns: Matrix4

$3

Returns a new Null Matrix.

Returns: Matrix4

*

Plane

*

$3

A Plane representation

$3

Project a point onto the plane.

*