com.io7m.jtensors

## Class MatrixI2x2F

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

- All Implemented Interfaces:
    MatrixReadable2x2FType, MatrixReadableFType

      @EqualityStructural
       @Immutable
      public final class MatrixI2x2F
      extends Object
      implements MatrixReadable2x2FType

  An immutable 2x2 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` | `getR1C0F()`
    `float` | `getR1C1F()`
    `<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`.
    `float` | `getRowColumnF(int row, int col)`
    `int` | `hashCode()`
    `static MatrixI2x2F` | `identity()`
    `<M extends MatrixWritable2x2FType> void` | `makeMatrix2x2F(M m)` Write the current matrix into the given mutable matrix.
    `static MatrixI2x2F` | `newFromColumns(VectorReadable2FType column_0, VectorReadable2FType column_1)` Construct a new immutable 2x2 matrix from the given columns.
    `static MatrixI2x2F` | `newFromReadable(MatrixReadable2x2FType m)` Construct a new immutable 2x2 matrix from the given readable 2x2 matrix.
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Method Detail

    - #### identity

          public static MatrixI2x2F identity()

      Returns:
        The identity matrix

    - #### newFromColumns

          public static MatrixI2x2F newFromColumns(VectorReadable2FType column_0,
                                                   VectorReadable2FType column_1)

      Construct a new immutable 2x2 matrix from the given columns.
      Parameters:
        `column_0` - The first column
        `column_1` - The second column
      Returns:
        A new 2x2 matrix

    - #### newFromReadable

          public static MatrixI2x2F newFromReadable(MatrixReadable2x2FType m)

      Construct a new immutable 2x2 matrix from the given readable 2x2 matrix.
      Parameters:
        `m` - The original matrix
      Returns:
        A new 2x2 matrix

    - #### equals

          public boolean equals(@Nullable
                                Object obj)

      Overrides:
        `equals` in class `Object`

    - #### 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

    - #### 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`

    - #### makeMatrix2x2F

          public <M extends MatrixWritable2x2FType> void makeMatrix2x2F(M m)

      Write the current matrix into the given mutable matrix.
      Type Parameters:
        `M` - The precise type of mutable matrix
      Parameters:
        `m` - The mutable matrix

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright © 2017 <code@io7m.com> http://io7m.com