Package com.io7m.jtensors.core.unparameterized.matrices

Class Matrices3x3D

java.lang.Object
com.io7m.jtensors.core.unparameterized.matrices.Matrices3x3D
public final class Matrices3x3D
extends java.lang.Object

Functions over Matrix3x3D 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 Details

    • add

      public static Matrix3x3D add​(Matrix3x3D m0, Matrix3x3D m1)
      Add the matrices m0 and m1.
      Parameters:
      m0 - The left matrix
      m1 - The right matrix
      Returns:
      m0 + m1

    • determinant

      public static double determinant​(Matrix3x3D m)
      Calculate the determinant of the matrix m.
      Parameters:
      m - The matrix
      Returns:
      The determinant of m

    • invert

      public static java.util.Optional<Matrix3x3D> invert​(Matrix3x3D 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 Matrix3x3D multiply​(Matrix3x3D m0, Matrix3x3D m1)
      Multiply the matrices m0 and m1.
      Parameters:
      m0 - The left matrix
      m1 - The right matrix
      Returns:
      m0 * m1

    • multiplyVectorPost

      public static Vector3D multiplyVectorPost​(Matrix3x3D m, Vector3D 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 Matrix3x3D ofColumns​(Vector3D c0, Vector3D c1, Vector3D c2)
      Construct a matrix from the column vectors (c0, c1, c2).
      Parameters:
      c0 - The column 0
      c1 - The column 1
      c2 - The column 2
      Returns:
      A constructed matrix

    • ofRows

      public static Matrix3x3D ofRows​(Vector3D r0, Vector3D r1, Vector3D r2)
      Construct a matrix from the row vectors (r0, r1, r2).
      Parameters:
      r0 - The row 0
      r1 - The row 1
      r2 - The row 2
      Returns:
      A constructed matrix

    • ofScale

      public static Matrix3x3D 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

    • ofAxisAngle

      public static Matrix3x3D 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 Vector3D row0​(Matrix3x3D m)
      Parameters:
      m - The matrix
      Returns:
      Row 0 of the matrix

    • row1

      public static Vector3D row1​(Matrix3x3D m)
      Parameters:
      m - The matrix
      Returns:
      Row 1 of the matrix

    • row2

      public static Vector3D row2​(Matrix3x3D m)
      Parameters:
      m - The matrix
      Returns:
      Row 2 of the matrix

    • column0

      public static Vector3D column0​(Matrix3x3D m)
      Parameters:
      m - The matrix
      Returns:
      Column 0 of the matrix

    • column1

      public static Vector3D column1​(Matrix3x3D m)
      Parameters:
      m - The matrix
      Returns:
      Column 1 of the matrix

    • column2

      public static Vector3D column2​(Matrix3x3D m)
      Parameters:
      m - The matrix
      Returns:
      Column 2 of the matrix

    • scale

      public static Matrix3x3D scale​(Matrix3x3D m, double r)
      Scale the matrix m by r.
      Parameters:
      m - The matrix
      r - The scale factor
      Returns:
      m * r

    • subtract

      public static Matrix3x3D subtract​(Matrix3x3D m0, Matrix3x3D m1)
      Subtract the matrices m0 and m1.
      Parameters:
      m0 - The left matrix
      m1 - The right matrix
      Returns:
      m0 - m1

    • trace

      public static double trace​(Matrix3x3D 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 Matrix3x3D transpose​(Matrix3x3D m)
      Calculate the transpose of the matrix m.
      Parameters:
      m - The matrix
      Returns:
      The transpose of m

    • withColumn

      public static Matrix3x3D withColumn​(Matrix3x3D m, int column, double r0, double r1, double r2)
      Set the column column of m to (r0, r1, r2).
      Parameters:
      m - The matrix
      column - The column index in the range [0, 2] * @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
      Returns:
      A matrix with the given row

    • withRow

      public static Matrix3x3D withRow​(Matrix3x3D m, int row, double c0, double c1, double c2)
      Set the row row of m to (c0, c1, c2).
      Parameters:
      m - The matrix
      row - The row index in the range [0, 2]
      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
      Returns:
      A matrix with the given row

    • zero

      public static Matrix3x3D zero()
      The zero matrix.
      Returns:
      A matrix with all zero components

    • identity

      public static Matrix3x3D identity()
      The identity matrix.
      Returns:
      A matrix with all diagonal components set to 1 and all other components set to 0.