Package com.io7m.jtensors.core.parameterized.matrices

# Class PMatrix2x2F<A,B>

java.lang.Object
com.io7m.jtensors.core.parameterized.matrices.PMatrix2x2F<A,B>

Type Parameters:
  `A` - A phantom type parameter (possibly representing a source coordinate system)
  `B` - A phantom type parameter (possibly representing a target coordinate system)

All Implemented Interfaces:
  `MatrixComputationalType`, `PMatrix2x2FType<A,B>`, `PMatrixReadable2x2FType<A,B>`, `MatrixReadable2x2FType`, `MatrixReadableFType`

public final class PMatrix2x2F<A,B> extends Object implements PMatrix2x2FType<A,B>
The type of 2x2 `float`-typed matrices.

- ## Nested Class Summary

  Nested Classes
  Modifier and Type
  Class
  Description
  `static final class`
  `PMatrix2x2F.Builder<A,B>`
  Builds instances of type `PMatrix2x2F`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static <A, B> PMatrix2x2F.Builder<A,B>`
  `builder()`
  Creates a builder for `PMatrix2x2F`.
  `static <A, B> PMatrix2x2F<A,B>`
  `copyOf(PMatrix2x2FType<A,B> instance)`
  Creates an immutable copy of a `PMatrix2x2FType` value.
  `boolean`
  `equals(Object another)`
  This instance is equal to all instances of `PMatrix2x2F` that have equal attribute values.
  `int`
  `hashCode()`
  Computes a hash code from attributes: `r0c0`, `r0c1`, `r1c0`, `r1c1`.
  `static <A, B> PMatrix2x2F<A,B>`
  `of(float r0c0, float r0c1, float r1c0, float r1c1)`
  Construct a new immutable `PMatrix2x2F` instance.
  `float`
  `r0c0()`
  `float`
  `r0c1()`
  `float`
  `r1c0()`
  `float`
  `r1c1()`
  `String`
  `toString()`
  Prints the immutable value `PMatrix2x2F` with attribute values.
  `final PMatrix2x2F<A,B>`
  `withR0c0(float value)`
  Copy the current immutable object by setting a value for the `r0c0` attribute.
  `final PMatrix2x2F<A,B>`
  `withR0c1(float value)`
  Copy the current immutable object by setting a value for the `r0c1` attribute.
  `final PMatrix2x2F<A,B>`
  `withR1c0(float value)`
  Copy the current immutable object by setting a value for the `r1c0` attribute.
  `final PMatrix2x2F<A,B>`
  `withR1c1(float value)`
  Copy the current immutable object by setting a value for the `r1c1` attribute.

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

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

  ### Methods inherited from interface com.io7m.jtensors.core.unparameterized.matrices.MatrixReadable2x2FType

  `rowColumn`

- ## Method Details

  - ### r0c0

    public float r0c0()
    Specified by:
      `r0c0` in interface `MatrixReadable2x2FType`
    Specified by:
      `r0c0` in interface `PMatrix2x2FType<A,B>`
    Returns:
      The value at row 0 column 0

  - ### r0c1

    public float r0c1()
    Specified by:
      `r0c1` in interface `MatrixReadable2x2FType`
    Specified by:
      `r0c1` in interface `PMatrix2x2FType<A,B>`
    Returns:
      The value at row 0 column 1

  - ### r1c0

    public float r1c0()
    Specified by:
      `r1c0` in interface `MatrixReadable2x2FType`
    Specified by:
      `r1c0` in interface `PMatrix2x2FType<A,B>`
    Returns:
      The value at row 1 column 0

  - ### r1c1

    public float r1c1()
    Specified by:
      `r1c1` in interface `MatrixReadable2x2FType`
    Specified by:
      `r1c1` in interface `PMatrix2x2FType<A,B>`
    Returns:
      The value at row 1 column 1

  - ### withR0c0

    public final PMatrix2x2F<A,B> withR0c0(float value)
    Copy the current immutable object by setting a value for the `r0c0` attribute. A value strict bits equality used to prevent copying of the same value by returning `this`.
    Parameters:
      `value` - A new value for r0c0
    Returns:
      A modified copy of the `this` object

  - ### withR0c1

    public final PMatrix2x2F<A,B> withR0c1(float value)
    Copy the current immutable object by setting a value for the `r0c1` attribute. A value strict bits equality used to prevent copying of the same value by returning `this`.
    Parameters:
      `value` - A new value for r0c1
    Returns:
      A modified copy of the `this` object

  - ### withR1c0

    public final PMatrix2x2F<A,B> withR1c0(float value)
    Copy the current immutable object by setting a value for the `r1c0` attribute. A value strict bits equality used to prevent copying of the same value by returning `this`.
    Parameters:
      `value` - A new value for r1c0
    Returns:
      A modified copy of the `this` object

  - ### withR1c1

    public final PMatrix2x2F<A,B> withR1c1(float value)
    Copy the current immutable object by setting a value for the `r1c1` attribute. A value strict bits equality used to prevent copying of the same value by returning `this`.
    Parameters:
      `value` - A new value for r1c1
    Returns:
      A modified copy of the `this` object

  - ### equals

    public boolean equals(Object another)
    This instance is equal to all instances of `PMatrix2x2F` that have equal attribute values.
    Overrides:
      `equals` in class `Object`
    Returns:
      `true` if `this` is equal to `another` instance

  - ### hashCode

    public int hashCode()
    Computes a hash code from attributes: `r0c0`, `r0c1`, `r1c0`, `r1c1`.
    Overrides:
      `hashCode` in class `Object`
    Returns:
      hashCode value

  - ### toString

    public String toString()
    Prints the immutable value `PMatrix2x2F` with attribute values.
    Overrides:
      `toString` in class `Object`
    Returns:
      A string representation of the value

  - ### of

    public static <A, B> PMatrix2x2F<A,B> of(float r0c0, float r0c1, float r1c0, float r1c1)
    Construct a new immutable `PMatrix2x2F` instance.
    Type Parameters:
      `A` - generic parameter A
      `B` - generic parameter B
    Parameters:
      `r0c0` - The value for the `r0c0` attribute
      `r0c1` - The value for the `r0c1` attribute
      `r1c0` - The value for the `r1c0` attribute
      `r1c1` - The value for the `r1c1` attribute
    Returns:
      An immutable PMatrix2x2F instance

  - ### copyOf

    public static <A, B> PMatrix2x2F<A,B> copyOf(PMatrix2x2FType<A,B> instance)
    Creates an immutable copy of a `PMatrix2x2FType` value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    Type Parameters:
      `A` - generic parameter A
      `B` - generic parameter B
    Parameters:
      `instance` - The instance to copy
    Returns:
      A copied immutable PMatrix2x2F instance

  - ### builder

    public static <A, B> PMatrix2x2F.Builder<A,B> builder()
    Creates a builder for `PMatrix2x2F`.

         PMatrix2x2F.&lt;A, B&gt;builder()
            .setR0c0(float) // required r0c0
            .setR0c1(float) // required r0c1
            .setR1c0(float) // required r1c0
            .setR1c1(float) // required r1c1
            .build();

    Type Parameters:
      `A` - generic parameter A
      `B` - generic parameter B
    Returns:
      A new PMatrix2x2F builder