Matrices4x4D (com.io7m.jtensors.documentation 8.0.0-beta0004 API)

java.lang.Object
- com.io7m.jtensors.core.unparameterized.matrices.Matrices4x4D

```
public final class Matrices4x4D
extends Object
```
Functions over Matrix4x4D values.

See "Mathematics for 3D Game Programming and Computer Graphics" 2nd Ed for the derivations of most of the code in this class (ISBN: 1-58450-277-0).

Since:

8.0.0

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Matrix4x4D`	`add(Matrix4x4D m0, Matrix4x4D m1)` Add the matrices `m0` and `m1`.
`static Vector4D`	`column0(Matrix4x4D m)`
`static Vector4D`	`column1(Matrix4x4D m)`
`static Vector4D`	`column2(Matrix4x4D m)`
`static Vector4D`	`column3(Matrix4x4D m)`
`static double`	`determinant(Matrix4x4D m)` Calculate the determinant of the matrix `m`.
`static Matrix4x4D`	`identity()` The identity matrix.
`static Optional<Matrix4x4D>`	`invert(Matrix4x4D m)` Calculate the inverse of the matrix `m`.
`static Matrix4x4D`	`multiply(Matrix4x4D m0, Matrix4x4D m1)` Multiply the matrices `m0` and `m1`.
`static Vector4D`	`multiplyVectorPost(Matrix4x4D m, Vector4D v)` Multiply the vector `v` by the matrix `m`.
`static Matrix4x4D`	`ofAxisAngle(double axis_x, double axis_y, double axis_z, double angle)` Construct a matrix that will rotate by `angle` radians around the axis `(x, y, z)`.
`static Matrix4x4D`	`ofColumns(Vector4D c0, Vector4D c1, Vector4D c2, Vector4D c3)` Construct a matrix from the column vectors `(c0, c1, c2, c3)`.
`static Matrix4x4D`	`ofRows(Vector4D r0, Vector4D r1, Vector4D r2, Vector4D r3)` Construct a matrix from the row vectors `(r0, r1, r2, r3)`.
`static Matrix4x4D`	`ofScale(double x, double y, double z)` Construct a matrix that will scale by `(x, y, z)`.
`static Matrix4x4D`	`ofTranslation(double x, double y, double z)` Construct a matrix that will translate by `(x, y, z)`.
`static Vector4D`	`row0(Matrix4x4D m)`
`static Vector4D`	`row1(Matrix4x4D m)`
`static Vector4D`	`row2(Matrix4x4D m)`
`static Vector4D`	`row3(Matrix4x4D m)`
`static Matrix4x4D`	`scale(Matrix4x4D m, double r)` Scale the matrix `m` by `r`.
`static Matrix4x4D`	`subtract(Matrix4x4D m0, Matrix4x4D m1)` Subtract the matrices `m0` and `m1`.
`static double`	`trace(Matrix4x4D m)` Return the trace of the matrix `m`.
`static Matrix4x4D`	`transpose(Matrix4x4D m)` Calculate the transpose of the matrix `m`.
`static Matrix4x4D`	`withColumn(Matrix4x4D m, int column, double r0, double r1, double r2, double r3)` Set the column `column` of `m` to `(r0, r1, r2, r3)`.
`static Matrix4x4D`	`withRow(Matrix4x4D m, int row, double c0, double c1, double c2, double c3)` Set the row `row` of `m` to `(c0, c1, c2, c3)`.
`static Matrix4x4D`	`zero()` The zero matrix.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - add
```
public static Matrix4x4D add(Matrix4x4D m0,
                             Matrix4x4D m1)
```
    Add the matrices m0 and m1.
    
    Parameters:
    
    m0 - The left matrix
    
    m1 - The right matrix
    
    Returns:
    
    m0 + m1
  - determinant
```
public static double determinant(Matrix4x4D m)
```
    Calculate the determinant of the matrix m.
    
    Parameters:
    
    m - The matrix
    
    Returns:
    
    The determinant of m
  - invert
```
public static Optional<Matrix4x4D> invert(Matrix4x4D m)
```
    Calculate the inverse of the matrix m.
    
    Parameters:
    
    m - The matrix
    
    Returns:
    
    The inverse of m, or nothing if no inverse exists
  - multiply
```
public static Matrix4x4D multiply(Matrix4x4D m0,
                                  Matrix4x4D m1)
```
    Multiply the matrices m0 and m1.
    
    Parameters:
    
    m0 - The left matrix
    
    m1 - The right matrix
    
    Returns:
    
    m0 * m1
  - multiplyVectorPost
```
public static Vector4D multiplyVectorPost(Matrix4x4D m,
                                          Vector4D v)
```
    Multiply the vector v by the matrix m.
    
    This is post multiplication.
    
    Parameters:
    
    m - The matrix
    
    v - The vector
    
    Returns:
    
    m * v
  - ofColumns
```
public static Matrix4x4D ofColumns(Vector4D c0,
                                   Vector4D c1,
                                   Vector4D c2,
                                   Vector4D c3)
```
    Construct a matrix from the column vectors (c0, c1, c2, c3).
    
    Parameters:
    
    c0 - The column 0
    
    c1 - The column 1
    
    c2 - The column 2
    
    c3 - The column 3
    
    Returns:
    
    A constructed matrix
  - ofRows
```
public static Matrix4x4D ofRows(Vector4D r0,
                                Vector4D r1,
                                Vector4D r2,
                                Vector4D r3)
```
    Construct a matrix from the row vectors (r0, r1, r2, r3).
    
    Parameters:
    
    r0 - The row 0
    
    r1 - The row 1
    
    r2 - The row 2
    
    r3 - The row 3
    
    Returns:
    
    A constructed matrix
  - ofScale
```
public static Matrix4x4D ofScale(double x,
                                 double y,
                                 double z)
```
    Construct a matrix that will scale by (x, y, z).
    
    Parameters:
    
    x - The X scaling value
    
    y - The Y scaling value
    
    z - The Z scaling value
    
    Returns:
    
    A constructed matrix
  - ofTranslation
```
public static Matrix4x4D ofTranslation(double x,
                                       double y,
                                       double z)
```
    Construct a matrix that will translate by (x, y, z).
    
    Parameters:
    
    x - The X scaling value
    
    y - The Y scaling value
    
    z - The Z scaling value
    
    Returns:
    
    A constructed matrix
  - ofAxisAngle
```
public static Matrix4x4D ofAxisAngle(double axis_x,
                                     double axis_y,
                                     double axis_z,
                                     double angle)
```
    Construct a matrix that will rotate by angle radians around the axis (x, y, z).
    
    Parameters:
    
    angle - The angle in radians
    
    axis_x - The X axis value
    
    axis_y - The Y axis value
    
    axis_z - The Z axis value
    
    Returns:
    
    A constructed matrix
  - row0
```
public static Vector4D row0(Matrix4x4D m)
```
    Parameters:
    
    m - The matrix
    
    Returns:
    
    Row 0 of the matrix
  - row1
```
public static Vector4D row1(Matrix4x4D m)
```
    Parameters:
    
    m - The matrix
    
    Returns:
    
    Row 1 of the matrix
  - row2
```
public static Vector4D row2(Matrix4x4D m)
```
    Parameters:
    
    m - The matrix
    
    Returns:
    
    Row 2 of the matrix
  - row3
```
public static Vector4D row3(Matrix4x4D m)
```
    Parameters:
    
    m - The matrix
    
    Returns:
    
    Row 3 of the matrix
  - column0
```
public static Vector4D column0(Matrix4x4D m)
```
    Parameters:
    
    m - The matrix
    
    Returns:
    
    Column 0 of the matrix
  - column1
```
public static Vector4D column1(Matrix4x4D m)
```
    Parameters:
    
    m - The matrix
    
    Returns:
    
    Column 1 of the matrix
  - column2
```
public static Vector4D column2(Matrix4x4D m)
```
    Parameters:
    
    m - The matrix
    
    Returns:
    
    Column 2 of the matrix
  - column3
```
public static Vector4D column3(Matrix4x4D m)
```
    Parameters:
    
    m - The matrix
    
    Returns:
    
    Column 3 of the matrix
  - scale
```
public static Matrix4x4D scale(Matrix4x4D m,
                               double r)
```
    Scale the matrix m by r.
    
    Parameters:
    
    m - The matrix
    
    r - The scale factor
    
    Returns:
    
    m * r
  - subtract
```
public static Matrix4x4D subtract(Matrix4x4D m0,
                                  Matrix4x4D m1)
```
    Subtract the matrices m0 and m1.
    
    Parameters:
    
    m0 - The left matrix
    
    m1 - The right matrix
    
    Returns:
    
    m0 - m1
  - trace
```
public static double trace(Matrix4x4D m)
```
    Return the trace of the matrix m. The trace is defined as the sum of the diagonal elements of the matrix.
    
    Parameters:
    
    m - The matrix
    
    Returns:
    
    The trace of the matrix
  - transpose
```
public static Matrix4x4D transpose(Matrix4x4D m)
```
    Calculate the transpose of the matrix m.
    
    Parameters:
    
    m - The matrix
    
    Returns:
    
    The transpose of m
  - withColumn
```
public static Matrix4x4D withColumn(Matrix4x4D m,
                                    int column,
                                    double r0,
                                    double r1,
                                    double r2,
                                    double r3)
```
    Set the column column of m to (r0, r1, r2, r3).
    
    Parameters:
    
    m - The matrix
    
    column - The column index in the range [0, 3] * @param r0 The value of row 0 in the column
    
    r1 - The value of row 1 in the column
    
    r2 - The value of row 2 in the column
    
    r3 - The value of row 3 in the column
    
    Returns:
    
    A matrix with the given row
  - withRow
```
public static Matrix4x4D withRow(Matrix4x4D m,
                                 int row,
                                 double c0,
                                 double c1,
                                 double c2,
                                 double c3)
```
    Set the row row of m to (c0, c1, c2, c3).
    
    Parameters:
    
    m - The matrix
    
    row - The row index in the range [0, 3]
    
    c0 - The value of column 0 in the row
    
    c1 - The value of column 1 in the row
    
    c2 - The value of column 2 in the row
    
    c3 - The value of column 3 in the row
    
    Returns:
    
    A matrix with the given row
  - zero
```
public static Matrix4x4D zero()
```
    The zero matrix.
    
    Returns:
    
    A matrix with all zero components
  - identity
```
public static Matrix4x4D identity()
```
    The identity matrix.
    
    Returns:
    
    A matrix with all diagonal components set to 1 and all other components set to 0.

Class Matrices4x4D

Method Summary

Methods inherited from class java.lang.Object

Method Detail

add

determinant

invert

multiply

multiplyVectorPost

ofColumns

ofRows

ofScale

ofTranslation

ofAxisAngle

row0

row1

row2

row3

column0

column1

column2

column3

scale

subtract

trace

transpose

withColumn

withRow

zero

identity