#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# MatrixUtil Class

Defined in: `matrix/js/MatrixUtil.js:1`
Module: matrix

Matrix utilities.

- Index
- Methods
- Properties

## Item Index

### Methods

- _round
- angle2rad
- compareTransformSequence
- decompose
- deg2rad
- getDeterminant
- getMinors
- getnxn
- getTransformArray
- getTransformFunctionArray
- inverse
- rad2deg
- scalarMultiply
- sign
- transpose
- vectorMatrixProduct

### Properties

- _rounder
- transformMethods

## Methods

### `_round`

() private

Defined in `matrix/js/MatrixUtil.js:17`

Rounds values

### `angle2rad`

(

- `val`

)

Defined in `matrix/js/MatrixUtil.js:51`

Converts an angle to a radian

#### Parameters:

- `val` Objecxt

  Value to be converted to radian.

#### Returns:

Number

### `compareTransformSequence`

(

- `list1`
- `list2`

)

Defined in `matrix/js/MatrixUtil.js:422`

Compares to arrays or transform functions to ensure both contain the same functions in the same order.

#### Parameters:

- `list1` Array

  Array to compare

- `list2` Array

  Array to compare

#### Returns:

Boolean

### `decompose`

(

- `3x3`

)

Defined in `matrix/js/MatrixUtil.js:303`

Breaks up a 2d transform matrix into a series of transform operations.

#### Parameters:

- `3x3` Array

  matrix array

#### Returns:

Array

### `deg2rad`

(

- `deg`

)

Defined in `matrix/js/MatrixUtil.js:39`

Converts a degree value to a radian.

#### Parameters:

- `deg` Number

  Degree value to be converted to radian.

#### Returns:

Number

### `getDeterminant`

(

- `matrix`

)

Defined in `matrix/js/MatrixUtil.js:90`

Returns the determinant of a given matrix.

/ \ | matrix[0][0] matrix[1][0] matrix[2][0] | | matrix[0][1] matrix[1][1] matrix[2][1] | | matrix[0][2] matrix[1][2] matrix[2][2] | | matrix[0][3] matrix[1][3] matrix[2][3] | \ /

#### Parameters:

- `matrix` Array

  An nxn matrix represented an array of vector (column) arrays. Each vector array has index for each row.

#### Returns:

Number

### `getMinors`

(

- `matrix`
- `columnIndex`
- `rowIndex`

)

Defined in `matrix/js/MatrixUtil.js:230`

Returns a matrix of minors based on a matrix, column index and row index.

#### Parameters:

- `matrix` Array

  The matrix from which to extract the matrix of minors.

- `columnIndex` Number

  A zero-based index representing the specified column to exclude.

- `rowIndex` Number

  A zero-based index represeenting the specified row to exclude.

#### Returns:

Array

### `getnxn`

()

Defined in `matrix/js/MatrixUtil.js:68`

Converts a transform object to an array of column vectors.

/ \ | matrix[0][0] matrix[1][0] matrix[2][0] | | matrix[0][1] matrix[1][1] matrix[2][1] | | matrix[0][2] matrix[1][2] matrix[2][2] | \ /

#### Returns:

Array

### `getTransformArray`

(

- `val`

)

Defined in `matrix/js/MatrixUtil.js:351`

Parses a transform string and returns an array of transform arrays.

#### Parameters:

- `val` String

  A transform string

#### Returns:

Array

### `getTransformFunctionArray`

()

Defined in `matrix/js/MatrixUtil.js:390`

Returns an array of transform arrays representing transform functions and arguments.

#### Returns:

Array

### `inverse`

(

- `Array`

)

Defined in `matrix/js/MatrixUtil.js:130`

Returns the inverse of a matrix

#### Parameters:

- `Array` Object

  matrix An array representing an nxn matrix

#### Returns:

Array / \ | matrix[0][0] matrix[1][0] matrix[2][0] | | matrix[0][1] matrix[1][1] matrix[2][1] | | matrix[0][2] matrix[1][2] matrix[2][2] | | matrix[0][3] matrix[1][3] matrix[2][3] | \ /

### `rad2deg`

(

- `rad`

)

Defined in `matrix/js/MatrixUtil.js:27`

Converts a radian value to a degree.

#### Parameters:

- `rad` Number

  Radian value to be converted.

#### Returns:

Number

### `scalarMultiply`

(

- `matrix`
- `multiplier`

)

Defined in `matrix/js/MatrixUtil.js:183`

Multiplies a matrix by a numeric value.

#### Parameters:

- `matrix` Array

  The matrix to be altered.

- `multiplier` Number

  The number to multiply against the matrix.

#### Returns:

Array

### `sign`

(

- `val`

)

Defined in `matrix/js/MatrixUtil.js:264`

Returns the sign of value

#### Parameters:

- `val` Number

  value to be interpreted

#### Returns:

Number

### `transpose`

(

- `matrix`

)

Defined in `matrix/js/MatrixUtil.js:206`

Returns the transpose for an nxn matrix.

#### Parameters:

- `matrix` Object

  An nxn matrix represented by an array of vector arrays.

#### Returns:

Array

### `vectorMatrixProduct`

(

- `vector`
- `matrix`

)

Defined in `matrix/js/MatrixUtil.js:276`

Multiplies a vector and a matrix

#### Parameters:

- `vector` Array

  Array representing a column vector

- `matrix` Array

  Array representing an nxn matrix

#### Returns:

Array

## Properties

### `_rounder`

Unknown private

Defined in `matrix/js/MatrixUtil.js:9`

Used as value for the _rounding method.

### `transformMethods`

Object

Defined in `matrix/js/MatrixUtil.js:451`

Mapping of possible transform method names.