Matrix3d (sim-math 1.6.0 API)

java.lang.Object
- com.simsilica.mathd.Matrix3d

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class Matrix3d
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
```
A square matrix composed of 9 double-precision elements, used to represent linear transformations of 3-dimensional vectors.
Methods with names ending in "Local" modify the current instance. They are used to avoid creating temporary objects.
By convention, indices start from zero. The conventional order of indices is (row, column).

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`m00` The element in row 0, column 0.
`double`	`m01` The element in row 0, column 1.
`double`	`m02` The element in row 0, column 2.
`double`	`m10` The element in row 1, column 0.
`double`	`m11` The element in row 1, column 1.
`double`	`m12` The element in row 1, column 2.
`double`	`m20` The element in row 2, column 0.
`double`	`m21` The element in row 2, column 1.
`double`	`m22` The element in row 2, column 2.

Constructor Summary

Constructors
Constructor and Description
`Matrix3d()` Instantiates an identity matrix (diagonals = 1, other elements = 0).
`Matrix3d(double m00, double m01, double m02, double m10, double m11, double m12, double m20, double m21, double m22)` Instantiates a matrix with the specified elements.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Matrix3d`	`addLocal(Matrix3d add)` Adds the argument and returns the (modified) current instance.
`Matrix3d`	`clone()` Creates a copy of the current instance.
`double`	`determinant()` Returns the determinant.
`boolean`	`equals(java.lang.Object o)` Tests for exact equality with the argument, distinguishing -0 from 0.
`Vec3d`	`getColumn(int i)` Returns the indexed column.
`int`	`hashCode()` Returns a hash code.
`Matrix3d`	`invert()` Returns the multiplicative inverse.
`boolean`	`isIdentity()` Tests for identity.
`Matrix3d`	`makeIdentity()` Configures the matrix as an identity matrix (diagonals = 1, other elements = 0).
`Matrix3d`	`mult(Matrix3d mat)` Multiplies by the argument and returns the product as a new instance.
`Vec3d`	`mult(Vec3d v)` Multiplies by the specified column vector and returns the product as a new column vector.
`Matrix3d`	`multLocal(double scale)` Multiplies by the scalar argument and returns the (modified) current instance.
`Matrix3d`	`multLocal(Matrix3d mat)` Multiplies by the argument and returns the (modified) current instance.
`Matrix3d`	`set(Matrix3d mat)` Copies all elements of the argument to the current instance.
`Matrix3d`	`setColumn(int i, Vec3d col)` Alters the indexed column and returns the (modified) current instance.
`Matrix3d`	`setSkewSymmetric(Vec3d v)`
`java.lang.String`	`toString()` Returns a string representation of the matrix, which is unaffected.
`Matrix3d`	`transpose()` Returns the transpose.

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

- Field Detail
  - m00
```
public double m00
```
    The element in row 0, column 0.
  - m01
```
public double m01
```
    The element in row 0, column 1.
  - m02
```
public double m02
```
    The element in row 0, column 2.
  - m10
```
public double m10
```
    The element in row 1, column 0.
  - m11
```
public double m11
```
    The element in row 1, column 1.
  - m12
```
public double m12
```
    The element in row 1, column 2.
  - m20
```
public double m20
```
    The element in row 2, column 0.
  - m21
```
public double m21
```
    The element in row 2, column 1.
  - m22
```
public double m22
```
    The element in row 2, column 2.
- Constructor Detail
  - Matrix3d
```
public Matrix3d()
```
    Instantiates an identity matrix (diagonals = 1, other elements = 0).
  - Matrix3d
```
public Matrix3d(double m00,
                double m01,
                double m02,
                double m10,
                double m11,
                double m12,
                double m20,
                double m21,
                double m22)
```
    Instantiates a matrix with the specified elements.
    
    Parameters:
    
    m00 - the desired value for row 0, column 0
    
    m01 - the desired value for row 0, column 1
    
    m02 - the desired value for row 0, column 2
    
    m10 - the desired value for row 1, column 0
    
    m11 - the desired value for row 1, column 1
    
    m12 - the desired value for row 1, column 2
    
    m20 - the desired value for row 2, column 0
    
    m21 - the desired value for row 2, column 1
    
    m22 - the desired value for row 2, column 2
- Method Detail
  - clone
```
public Matrix3d clone()
```
    Creates a copy of the current instance.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a new instance, equivalent to this one
  - set
```
public Matrix3d set(Matrix3d mat)
```
    Copies all elements of the argument to the current instance.
    
    Parameters:
    
    mat - the desired value (not null, unaffected)
    
    Returns:
    
    the (modified) current instance (for chaining)
  - makeIdentity
```
public Matrix3d makeIdentity()
```
    Configures the matrix as an identity matrix (diagonals = 1, other elements = 0).
    
    Returns:
    
    the (modified) current instance (for chaining)
  - isIdentity
```
public boolean isIdentity()
```
    Tests for identity. The matrix is unaffected.
    
    Returns:
    
    true if all diagonal elements are 1 and all other elements are 0 or -0, otherwise false
  - getColumn
```
public Vec3d getColumn(int i)
```
    Returns the indexed column. The matrix is unaffected.
    
    Parameters:
    
    i - 0, 1, or 2
    
    Returns:
    
    a copy of the ith column
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if i is not 0, 1, or 2
  - setColumn
```
public Matrix3d setColumn(int i,
                          Vec3d col)
```
    Alters the indexed column and returns the (modified) current instance.
    
    Parameters:
    
    i - 0, 1, or 2
    
    col - the desired value (not null, unaffected)
    
    Returns:
    
    the current instance (for chaining)
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if i is not 0, 1, or 2
  - mult
```
public Matrix3d mult(Matrix3d mat)
```
    Multiplies by the argument and returns the product as a new instance. The current instance is unaffected.
    
    Parameters:
    
    mat - the right factor (not null, unaffected)
    
    Returns:
    
    a new Vec3d
  - mult
```
public Vec3d mult(Vec3d v)
```
    Multiplies by the specified column vector and returns the product as a new column vector. The current instance is unaffected.
    
    Parameters:
    
    v - the right factor (not null, unaffected)
    
    Returns:
    
    a new Vec3d
  - multLocal
```
public Matrix3d multLocal(Matrix3d mat)
```
    Multiplies by the argument and returns the (modified) current instance.
    It IS safe for mat and this to be the same object.
    
    Parameters:
    
    mat - the right factor (not null, unaffected unless it's this)
    
    Returns:
    
    the (modified) current instance (for chaining)
  - multLocal
```
public Matrix3d multLocal(double scale)
```
    Multiplies by the scalar argument and returns the (modified) current instance.
    
    Parameters:
    
    scale - the scaling factor
    
    Returns:
    
    the (modified) current instance (for chaining)
  - determinant
```
public double determinant()
```
    Returns the determinant. The matrix is unaffected.
    
    Returns:
    
    the determinant
  - invert
```
public Matrix3d invert()
```
    Returns the multiplicative inverse. If the current instance is singular, an identity matrix is returned. The current instance is unaffected.
    
    Returns:
    
    a new Matrix3d
  - transpose
```
public Matrix3d transpose()
```
    Returns the transpose. The current instance is unaffected.
    
    Returns:
    
    a new Matrix3d
  - setSkewSymmetric
```
public Matrix3d setSkewSymmetric(Vec3d v)
```
  - addLocal
```
public Matrix3d addLocal(Matrix3d add)
```
    Adds the argument and returns the (modified) current instance.
    It IS safe for add and this to be the same object.
    
    Parameters:
    
    add - the matrix to add (not null, unaffected unless it's this)
    
    Returns:
    
    the (modified) current instance (for chaining)
  - equals
```
public boolean equals(java.lang.Object o)
```
    Tests for exact equality with the argument, distinguishing -0 from 0. If o is null, false is returned. Either way, the current instance is unaffected.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the object to compare (may be null, unaffected)
    
    Returns:
    
    true if this and o have identical values, otherwise false
  - hashCode
```
public int hashCode()
```
    Returns a hash code. If two matrices have identical values, they will have the same hash code. The matrix is unaffected.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a 32-bit value for use in hashing
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the matrix, which is unaffected. For example, an identity matrix would be represented by:
```
 Matrix3d[{1.0, 0.0, 0.0}, {0.0, 1.0, 0.0}, {0.0, 0.0, 1.0}]
 
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a descriptive string of text (not null, not empty)

Class Matrix3d

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m00

m01

m02

m10

m11

m12

m20

m21

m22

Constructor Detail

Matrix3d

Matrix3d

Method Detail

clone

set

makeIdentity

isIdentity

getColumn

setColumn

mult

mult

multLocal

multLocal

determinant

invert

transpose

setSkewSymmetric

addLocal

equals

hashCode

toString