Package us.ihmc.euclid.matrix.interfaces

Interface Matrix3DBasics

All Superinterfaces:

Clearable, Matrix3DReadOnly

All Known Implementing Classes:

Matrix3D, RotationMatrix, RotationScaleMatrix

public interface Matrix3DBasics
extends Matrix3DReadOnly, Clearable

Write and read interface for a 3-by-3 matrix object.

In this interface, the matrix is assumed to be generic purpose. Therefore, the algorithms used here are limited to generic applications without violating potential constraints of more specific matrices such a rotation matrix.

Author:

Sylvain Bertrand

Method Summary

Modifier and Type	Method	Description
default boolean	containsNaN()	Tests if at least one element of this matrix is equal to Double.NaN.
default void	set(double[] matrixArray)	Copies the values in the given array into this matrix as follows:
void	set(double m00, double m01, double m02, double m10, double m11, double m12, double m20, double m21, double m22)	Sets the 9 coefficients of this matrix to the given ones.
default void	set(int startIndex, double[] matrixArray)	Copies the values in the given array into this matrix as follows:
default void	set(int startRow, int startColumn, org.ejml.data.DenseMatrix64F matrix)	Copies the values in the given dense-matrix into this matrix given index offsets for the row and column.
default void	set(org.ejml.data.DenseMatrix64F matrix)	Copies the values in the given dense-matrix into this matrix.
default void	set(Matrix3DReadOnly other)	Sets this matrix to other.
default void	setIdentity()	Sets this matrix to identity:
default void	setToNaN()	Sets this matrix to contain only Double.NaN:

Methods inherited from interface us.ihmc.euclid.interfaces.Clearable

setToZero

Methods inherited from interface us.ihmc.euclid.matrix.interfaces.Matrix3DReadOnly

addTransform, addTransform, checkIfMatrix2D, checkIfRotationMatrix, determinant, epsilonEquals, equals, get, get, get, get, getColumn, getColumn, getElement, getM00, getM01, getM02, getM10, getM11, getM12, getM20, getM21, getM22, getRow, getRow, inverseTransform, inverseTransform, inverseTransform, inverseTransform, inverseTransform, inverseTransform, inverseTransform, inverseTransform, inverseTransform, inverseTransform, isIdentity, isIdentity, isMatrix2D, isMatrix2D, isMatrixSkewSymmetric, isMatrixSkewSymmetric, isRotationMatrix, isRotationMatrix, transform, transform, transform, transform, transform, transform, transform, transform, transform, transform

Method Detail

set

void set(double m00,
         double m01,
         double m02,
         double m10,
         double m11,
         double m12,
         double m20,
         double m21,
         double m22)

Sets the 9 coefficients of this matrix to the given ones.

Parameters:

m00 - the new 1st row 1st column coefficient for this matrix.

m01 - the new 1st row 2nd column coefficient for this matrix.

m02 - the new 1st row 3rd column coefficient for this matrix.

m10 - the new 2nd row 1st column coefficient for this matrix.

m11 - the new 2nd row 2nd column coefficient for this matrix.

m12 - the new 2nd row 3rd column coefficient for this matrix.

m20 - the new 3rd row 1st column coefficient for this matrix.

m21 - the new 3rd row 2nd column coefficient for this matrix.

m22 - the new 3rd row 3rd column coefficient for this matrix.

setToNaN

default void setToNaN()

Sets this matrix to contain only Double.NaN:

     / NaN  NaN  NaN \
 m = | NaN  NaN  NaN |
     \ NaN  NaN  NaN /
 

Specified by:

setToNaN in interface Clearable

containsNaN

default boolean containsNaN()

Description copied from interface: Matrix3DReadOnly

Tests if at least one element of this matrix is equal to Double.NaN.

Specified by:

containsNaN in interface Clearable

Specified by:

containsNaN in interface Matrix3DReadOnly

Returns:

true if at least one element of this matrix is equal to Double.NaN, false otherwise.

setIdentity

default void setIdentity()

Sets this matrix to identity:

     / 1  0  0 \
 m = | 0  1  0 |
     \ 0  0  1 /
 

set

default void set(Matrix3DReadOnly other)

Sets this matrix to other.

Parameters:

other - the other matrix to copy the values of. Not modified.

set

default void set(double[] matrixArray)

Copies the values in the given array into this matrix as follows:

     / matrixArray[0]  matrixArray[1]  matrixArray[2] \
 m = | matrixArray[3]  matrixArray[4]  matrixArray[5] |
     \ matrixArray[6]  matrixArray[7]  matrixArray[8] /
 

Parameters:

matrixArray - the array containing the new values for this matrix. Not modified.

set

default void set(int startIndex,
                 double[] matrixArray)

Copies the values in the given array into this matrix as follows:

     / matrixArray[startIndex + 0]  matrixArray[startIndex + 1]  matrixArray[startIndex + 2] \
 m = | matrixArray[startIndex + 3]  matrixArray[startIndex + 4]  matrixArray[startIndex + 5] |
     \ matrixArray[startIndex + 6]  matrixArray[startIndex + 7]  matrixArray[startIndex + 8] /
 

Parameters:

startIndex - the first index to start reading from in the array.

matrixArray - the array containing the new values for this matrix. Not modified.

set

default void set(org.ejml.data.DenseMatrix64F matrix)

Copies the values in the given dense-matrix into this matrix.

Parameters:

matrix - the dense-matrix containing the new values for this matrix. Not modified.

set

default void set(int startRow,
                 int startColumn,
                 org.ejml.data.DenseMatrix64F matrix)

Copies the values in the given dense-matrix into this matrix given index offsets for the row and column.

Parameters:

startRow - the first row index to start reading from in the dense-matrix.

startColumn - the first column index to start reading from in the dense-matrix.

matrix - the dense-matrix containing the new values for this matrix. Not modified.