MatrixI4x4F (io7m-jtensors-documentation 7.0.0 API)

java.lang.Object
- com.io7m.jtensors.MatrixI4x4F

All Implemented Interfaces:

MatrixReadable2x2FType, MatrixReadable3x3FType, MatrixReadable4x4FType, MatrixReadableFType
```
@EqualityStructural
 @Immutable
public final class MatrixI4x4F
extends Object
implements MatrixReadable4x4FType
```
An immutable 4x4 matrix type.

Since:

7.0.0

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`float`	`getR0C0F()`
`float`	`getR0C1F()`
`float`	`getR0C2F()`
`float`	`getR0C3F()`
`float`	`getR1C0F()`
`float`	`getR1C1F()`
`float`	`getR1C2F()`
`float`	`getR1C3F()`
`float`	`getR2C0F()`
`float`	`getR2C1F()`
`float`	`getR2C2F()`
`float`	`getR2C3F()`
`float`	`getR3C0F()`
`float`	`getR3C1F()`
`float`	`getR3C2F()`
`float`	`getR3C3F()`
`<V extends VectorWritable2FType> void`	`getRow2F(int row, V out)` Retrieve row `row`, saving the result to `out`.
`<V extends VectorWritable2FType> void`	`getRow2FUnsafe(int row, V out)` Retrieve row `row`, saving the result to `out`.
`<V extends VectorWritable3FType> void`	`getRow3F(int row, V out)` Retrieve row `row`, saving the result to `out`.
`<V extends VectorWritable3FType> void`	`getRow3FUnsafe(int row, V out)` Retrieve row `row`, saving the result to `out`.
`<V extends VectorWritable4FType> void`	`getRow4F(int row, V out)` Retrieve row `row`, saving the result to `out`.
`<V extends VectorWritable4FType> void`	`getRow4FUnsafe(int row, V out)` Retrieve row `row`, saving the result to `out`.
`float`	`getRowColumnF(int row, int col)`
`int`	`hashCode()`
`static MatrixI4x4F`	`identity()`
`void`	`makeMatrixM4x4F(MatrixWritable4x4FType m)` Write the current matrix into the given mutable matrix.
`static MatrixI4x4F`	`newFromColumns(VectorReadable4FType column_0, VectorReadable4FType column_1, VectorReadable4FType column_2, VectorReadable4FType column_3)` Construct a new immutable 4x4 matrix from the given columns.
`static MatrixI4x4F`	`newFromReadable(MatrixReadable4x4FType m)` Construct a new immutable 4x4 matrix from the given readable 4x4 matrix.
`String`	`toString()`

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

- Method Detail
  - identity
```
public static MatrixI4x4F identity()
```
    Returns:
    
    The identity matrix
  - newFromColumns
```
public static MatrixI4x4F newFromColumns(VectorReadable4FType column_0,
                                         VectorReadable4FType column_1,
                                         VectorReadable4FType column_2,
                                         VectorReadable4FType column_3)
```
    Construct a new immutable 4x4 matrix from the given columns.
    
    Parameters:
    
    column_0 - The first column
    
    column_1 - The second column
    
    column_2 - The third column
    
    column_3 - The fourth column
    
    Returns:
    
    A new 4x4 matrix
  - newFromReadable
```
public static MatrixI4x4F newFromReadable(MatrixReadable4x4FType m)
```
    Construct a new immutable 4x4 matrix from the given readable 4x4 matrix.
    
    Parameters:
    
    m - The original matrix
    
    Returns:
    
    A new 4x4 matrix
  - equals
```
public boolean equals(@Nullable
                      Object obj)
```
    Overrides:
    
    equals in class Object
  - getRow4F
```
public <V extends VectorWritable4FType> void getRow4F(int row,
                                                      V out)
```
    Description copied from interface: MatrixReadable4x4FType
    
    Retrieve row row, saving the result to out.
    
    Specified by:
    
    getRow4F in interface MatrixReadable4x4FType
    
    Type Parameters:
    
    V - The precise type of writable vector.
    
    Parameters:
    
    row - The index of the row, starting at 0.
    
    out - The output vector.
  - getRow4FUnsafe
```
public <V extends VectorWritable4FType> void getRow4FUnsafe(int row,
                                                            V out)
```
    Description copied from interface: MatrixReadable4x4FType
    
    Retrieve row row, saving the result to out. No bounds checking is performed for row, and out-of-bounds values result in undefined behaviour.
    
    Specified by:
    
    getRow4FUnsafe in interface MatrixReadable4x4FType
    
    Type Parameters:
    
    V - The precise type of writable vector.
    
    Parameters:
    
    row - The index of the row, starting at 0.
    
    out - The output vector.
  - getR0C3F
```
public float getR0C3F()
```
    Specified by:
    
    getR0C3F in interface MatrixReadable4x4FType
    
    Returns:
    
    The value at row 0, column 3
  - getR1C3F
```
public float getR1C3F()
```
    Specified by:
    
    getR1C3F in interface MatrixReadable4x4FType
    
    Returns:
    
    The value at row 1, column 3
  - getR2C3F
```
public float getR2C3F()
```
    Specified by:
    
    getR2C3F in interface MatrixReadable4x4FType
    
    Returns:
    
    The value at row 2, column 3
  - getR3C0F
```
public float getR3C0F()
```
    Specified by:
    
    getR3C0F in interface MatrixReadable4x4FType
    
    Returns:
    
    The value at row 3, column 0
  - getR3C1F
```
public float getR3C1F()
```
    Specified by:
    
    getR3C1F in interface MatrixReadable4x4FType
    
    Returns:
    
    The value at row 3, column 1
  - getR3C2F
```
public float getR3C2F()
```
    Specified by:
    
    getR3C2F in interface MatrixReadable4x4FType
    
    Returns:
    
    The value at row 3, column 2
  - getR3C3F
```
public float getR3C3F()
```
    Specified by:
    
    getR3C3F in interface MatrixReadable4x4FType
    
    Returns:
    
    The value at row 3, column 3
  - getRowColumnF
```
public float getRowColumnF(int row,
                           int col)
```
    Specified by:
    
    getRowColumnF in interface MatrixReadableFType
    
    Parameters:
    
    row - The row
    
    col - The column
    
    Returns:
    
    The value at the given row and column
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - makeMatrixM4x4F
```
public void makeMatrixM4x4F(MatrixWritable4x4FType m)
```
    Write the current matrix into the given mutable matrix.
    
    Parameters:
    
    m - The mutable matrix
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getRow3F
```
public <V extends VectorWritable3FType> void getRow3F(int row,
                                                      V out)
```
    Description copied from interface: MatrixReadable3x3FType
    
    Retrieve row row, saving the result to out.
    
    Specified by:
    
    getRow3F in interface MatrixReadable3x3FType
    
    Type Parameters:
    
    V - The precise type of writable vector.
    
    Parameters:
    
    row - The index of the row, starting at 0.
    
    out - The output vector.
  - getRow3FUnsafe
```
public <V extends VectorWritable3FType> void getRow3FUnsafe(int row,
                                                            V out)
```
    Description copied from interface: MatrixReadable3x3FType
    
    Retrieve row row, saving the result to out. No bounds checking is performed for row, and out-of-bounds values result in undefined behaviour.
    
    Specified by:
    
    getRow3FUnsafe in interface MatrixReadable3x3FType
    
    Type Parameters:
    
    V - The precise type of writable vector.
    
    Parameters:
    
    row - The index of the row, starting at 0.
    
    out - The output vector.
  - getR0C2F
```
public float getR0C2F()
```
    Specified by:
    
    getR0C2F in interface MatrixReadable3x3FType
    
    Returns:
    
    The value at row 0, column 2
  - getR1C2F
```
public float getR1C2F()
```
    Specified by:
    
    getR1C2F in interface MatrixReadable3x3FType
    
    Returns:
    
    The value at row 1, column 2
  - getR2C0F
```
public float getR2C0F()
```
    Specified by:
    
    getR2C0F in interface MatrixReadable3x3FType
    
    Returns:
    
    The value at row 2, column 0
  - getR2C1F
```
public float getR2C1F()
```
    Specified by:
    
    getR2C1F in interface MatrixReadable3x3FType
    
    Returns:
    
    The value at row 2, column 1
  - getR2C2F
```
public float getR2C2F()
```
    Specified by:
    
    getR2C2F in interface MatrixReadable3x3FType
    
    Returns:
    
    The value at row 2, column 2
  - getRow2F
```
public <V extends VectorWritable2FType> void getRow2F(int row,
                                                      V out)
```
    Description copied from interface: MatrixReadable2x2FType
    
    Retrieve row row, saving the result to out.
    
    Specified by:
    
    getRow2F in interface MatrixReadable2x2FType
    
    Type Parameters:
    
    V - The precise type of writable vector.
    
    Parameters:
    
    row - The index of the row, starting at 0.
    
    out - The output vector.
  - getRow2FUnsafe
```
public <V extends VectorWritable2FType> void getRow2FUnsafe(int row,
                                                            V out)
```
    Description copied from interface: MatrixReadable2x2FType
    
    Retrieve row row, saving the result to out. No bounds checking is performed for row, and out-of-bounds values result in undefined behaviour.
    
    Specified by:
    
    getRow2FUnsafe in interface MatrixReadable2x2FType
    
    Type Parameters:
    
    V - The precise type of writable vector.
    
    Parameters:
    
    row - The index of the row, starting at 0.
    
    out - The output vector.
  - getR0C0F
```
public float getR0C0F()
```
    Specified by:
    
    getR0C0F in interface MatrixReadable2x2FType
    
    Returns:
    
    The value at row 0, column 0
  - getR1C0F
```
public float getR1C0F()
```
    Specified by:
    
    getR1C0F in interface MatrixReadable2x2FType
    
    Returns:
    
    The value at row 1, column 0
  - getR0C1F
```
public float getR0C1F()
```
    Specified by:
    
    getR0C1F in interface MatrixReadable2x2FType
    
    Returns:
    
    The value at row 0, column 1
  - getR1C1F
```
public float getR1C1F()
```
    Specified by:
    
    getR1C1F in interface MatrixReadable2x2FType
    
    Returns:
    
    The value at row 1, column 1

Class MatrixI4x4F

Method Summary

Methods inherited from class java.lang.Object

Method Detail

identity

newFromColumns

newFromReadable

equals

getRow4F

getRow4FUnsafe

getR0C3F

getR1C3F

getR2C3F

getR3C0F

getR3C1F

getR3C2F

getR3C3F

getRowColumnF

hashCode

makeMatrixM4x4F

toString

getRow3F

getRow3FUnsafe

getR0C2F

getR1C2F

getR2C0F

getR2C1F

getR2C2F

getRow2F

getRow2FUnsafe

getR0C0F

getR1C0F

getR0C1F

getR1C1F