mikera.matrixx

Class Matrix33

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.APrimitiveMatrix

mikera.matrixx.Matrix33

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<AVector>, INDArray, IMatrix, ISpecialisedTransform

public final class Matrix33
extends APrimitiveMatrix
implements ISpecialisedTransform

Specialised 3*3 Matrix for Vector3 maths, using primitive matrix elements

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
double	m00
double	m01
double	m02
double	m10
double	m11
double	m12
double	m20
double	m21
double	m22

Constructor Summary

Constructors

Constructor and Description
Matrix33() Create a new (zero-initialised) 3x3 Matrix
Matrix33(AMatrix m)
Matrix33(double m00, double m01, double m02, double m10, double m11, double m12, double m20, double m21, double m22)
Matrix33(Matrix33 source)

Method Summary

Modifier and Type	Method and Description
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
int	checkSquare() Checks if a matrix is square.
Matrix33	clone() Returns a clone of the array data, as a new array which will be fully mutable and may be of a different class to the original.
int	columnCount() Gets the number of columns in this matrix (dimension 1)
void	copyRowTo(int row, double[] dest, int destOffset) Copies the elements in a selected row of this matrix to a double array
static Matrix33	createIdentityMatrix()
static Matrix33	createScaleMatrix(double d)
double	determinant() Calculates the determinant of the matrix.
double	diagonalProduct() Computes the product of entries on the main diagonal of a matrix
long	elementCount() Returns the total number of elements in this array.
boolean	equals(Matrix33 m)
boolean	equals(java.lang.Object o)
Matrix33	exactClone() Creates a deep clone of an array, using the same class implementation as the original array
double	get(int row, int column) Returns the double value at the specified position in a 2D matrix
void	getElements(double[] data, int offset) Copies all elements of this array a double array at the specified offset
Vector3	getRowClone(int row) Returns a row of the matrix as a cloned vector
Matrix33	getTranspose() Returns the transpose of this array.
AMatrix	innerProduct(AMatrix a) Computes the inner product of this matrix with another.
AVector	innerProduct(AVector a) Computes the inner product of this array with a vector
Matrix33	innerProduct(Matrix33 a)
Vector3	innerProduct(Vector3 a)
Matrix33	inverse() Computes the inverse of a matrix.
boolean	isSymmetric() Returns true if a matrix is symmetric
boolean	isZero() Returns true if the matrix is the zero matrix (all components zero)
void	multiply(double factor) Multiplies all elements of the array in place by a given double value
int	rowCount() Gets the number of rows in this matrix (dimension 0)
void	set(int row, int column, double value) Sets a value at a given position in a mutable 2D array
Affine34	toAffineTransform()
double[]	toDoubleArray() Copies the elements of this array to a new double[] array.
double	trace() Computes the trace of a matrix, i.e.
void	transform(AVector source, AVector dest) Transforms a source vector into a destination vector, using matrix multiplication (inner product).
Vector3	transform(Vector3 source)
void	transform(Vector3 source, AVector dest)
void	transform(Vector3 source, Vector3 dest)
void	transformInPlace(AVector dest)
void	transformInPlace(Vector3 dest)
void	transformNormal(AVector source, AVector dest)
void	transformNormal(Vector3 source, Vector3 dest)

Methods inherited from class mikera.matrixx.impl.APrimitiveMatrix

copy, getColumn, getRow, isFullyMutable, isSquare

Methods inherited from class mikera.matrixx.AMatrix

abs, add, add, add, add, add2, addAt, addCopy, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addOuterProduct, addOuterProduct, addOuterProductSparse, addOuterProductSparse, addRowMultiple, addSparse, addSparse, addToArray, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, checkColumn, checkRow, clamp, composeWith, copyColumnTo, dense, denseClone, dimensionality, divide, divide, divide, divide, divideCopy, elementIterator, elementsEqual, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equalsArray, equalsTranspose, exp, fill, get, get, get, get, getBand, getBandWrapped, getColumnClone, getColumns, getColumnView, getElement, getLeadingDiagonal, getLongShape, getRows, getRowView, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTransposeCopy, getTransposeView, hashCode, hasOrthonormalColumns, hasOrthonormalRows, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, isBoolean, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isLowerTriangular, isMutable, isOrthogonal, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSameShape, isSameShape, isUpperTriangular, isView, iterator, join, log, lowerBandwidth, lowerBandwidthLimit, mul, multiply, multiply, multiply, multiplyCopy, multiplyRow, mutable, negate, nonZeroCount, outerProduct, outputDimensions, pow, rank, reciprocal, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, replaceColumn, replaceRow, reshape, reshape, rotateView, rowDotProduct, scaleAdd, scaleAdd, set, set, set, set, set, set, set, set, setApplyOp, setApplyOp, setColumn, setElements, setElements, setMultiple, setMultiple, setMultiple, setMultiple, setMultiple, setRow, setSparse, setSparse, signum, slice, slice, sliceCount, sparse, sparseClone, sqrt, square, sub, sub, sub, subArray, subCopy, subMatrix, swapColumns, swapRows, toDoubleBuffer, toMatrix, toMatrixTranspose, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, transform, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, unsafeGet, unsafeSet, upperBandwidth, upperBandwidthLimit, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

absCopy, absDiff, absDiffCopy, add, addApplyOp, addAt, addCopy, addInnerProduct, addInnerProduct, addMultipleSparse, addPower, addPower, addSparse, broadcastLike, compareTo, componentCount, density, divideCopy, elementAbsPowSum, elementMax, elementMaxAbs, elementMin, elementPowSum, elementProduct, epsilonEquals, equals, equalsArray, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, isSparse, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setSparse, signumCopy, sliceValue, squareCopy, sub, sub, subCopy, withComponents

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.INDArray

absCopy, absDiff, absDiffCopy, addApplyOp, addAt, addInnerProduct, addMultipleSparse, addPower, addPower, addSparse, broadcastLike, componentCount, divideCopy, elementAbsPowSum, elementMax, elementMaxAbs, elementMin, elementPowSum, elementProduct, epsilonEquals, equalsArray, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, isSparse, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setSparse, signumCopy, sliceValue, squareCopy, sub, subCopy, withComponents

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

m00

public double m00

m01

public double m01

m02

public double m02

m10

public double m10

m11

public double m11

m12

public double m12

m20

public double m20

m21

public double m21

m22

public double m22

Constructor Detail

Matrix33

public Matrix33()

Create a new (zero-initialised) 3x3 Matrix

Matrix33

public Matrix33(Matrix33 source)

Matrix33

public Matrix33(double m00,
                double m01,
                double m02,
                double m10,
                double m11,
                double m12,
                double m20,
                double m21,
                double m22)

Matrix33

public Matrix33(AMatrix m)

Method Detail

determinant

public double determinant()

Description copied from class: AMatrix

Calculates the determinant of the matrix.

Overrides:

determinant in class AMatrix

elementCount

public long elementCount()

Description copied from interface: INDArray

Returns the total number of elements in this array. Equivalent to the product of all dimension sizes.

Specified by:

elementCount in interface INDArray

Overrides:

elementCount in class AMatrix

multiply

public void multiply(double factor)

Description copied from interface: INDArray

Multiplies all elements of the array in place by a given double value

Specified by:

multiply in interface INDArray

Overrides:

multiply in class AMatrix

rowCount

public int rowCount()

Description copied from interface: IMatrix

Gets the number of rows in this matrix (dimension 0)

Specified by:

rowCount in interface IMatrix

Returns:

columnCount

public int columnCount()

Description copied from interface: IMatrix

Gets the number of columns in this matrix (dimension 1)

Specified by:

columnCount in interface IMatrix

Returns:

checkSquare

public int checkSquare()

Description copied from class: AMatrix

Checks if a matrix is square. Returns the size if true, throws an exception otherwise;

Specified by:

checkSquare in class APrimitiveMatrix

Returns:

get

public double get(int row,
                  int column)

Description copied from interface: INDArray

Returns the double value at the specified position in a 2D matrix

Specified by:

get in interface INDArray

Specified by:

get in interface IMatrix

Specified by:

get in class AMatrix

set

public void set(int row,
                int column,
                double value)

Description copied from interface: INDArray

Sets a value at a given position in a mutable 2D array

Specified by:

set in interface INDArray

Specified by:

set in interface IMatrix

Specified by:

set in class AMatrix

applyOp

public void applyOp(Op op)

Description copied from interface: INDArray

Applies a unary operator to all elements of the array (in-place)

Specified by:

applyOp in interface INDArray

Overrides:

applyOp in class AMatrix

innerProduct

public AMatrix innerProduct(AMatrix a)

Description copied from interface: IMatrix

Computes the inner product of this matrix with another. Equivalent to matrix x matrix multiplication

Specified by:

innerProduct in interface IMatrix

Overrides:

innerProduct in class AMatrix

Returns:

innerProduct

public AVector innerProduct(AVector a)

Description copied from interface: INDArray

Computes the inner product of this array with a vector

Specified by:

innerProduct in interface INDArray

Specified by:

innerProduct in interface IMatrix

Overrides:

innerProduct in class AMatrix

Parameters:

a - A vector

Returns:

A new array representing the inner product

innerProduct

public Vector3 innerProduct(Vector3 a)

innerProduct

public Matrix33 innerProduct(Matrix33 a)

transform

public void transform(AVector source,
                      AVector dest)

Description copied from interface: IMatrix

Transforms a source vector into a destination vector, using matrix multiplication (inner product). The destination vector is overwritten.

Specified by:

transform in interface IMatrix

Overrides:

transform in class AMatrix

transform

public void transform(Vector3 source,
                      AVector dest)

transform

public void transform(Vector3 source,
                      Vector3 dest)

transformNormal

public void transformNormal(AVector source,
                            AVector dest)

transformNormal

public void transformNormal(Vector3 source,
                            Vector3 dest)

transform

public Vector3 transform(Vector3 source)

transformInPlace

public void transformInPlace(AVector dest)

Specified by:

transformInPlace in interface IMatrix

Overrides:

transformInPlace in class AMatrix

transformInPlace

public void transformInPlace(Vector3 dest)

isSymmetric

public boolean isSymmetric()

Description copied from class: AMatrix

Returns true if a matrix is symmetric

Specified by:

isSymmetric in interface IMatrix

Overrides:

isSymmetric in class AMatrix

Returns:

toAffineTransform

public Affine34 toAffineTransform()

Overrides:

toAffineTransform in class AMatrix

getTranspose

public Matrix33 getTranspose()

Description copied from interface: INDArray

Returns the transpose of this array. A transpose of an array is equivalent to reversing the order of dimensions. May or may not return a view depending on the array type.

Specified by:

getTranspose in interface INDArray

Specified by:

getTranspose in interface IMatrix

Overrides:

getTranspose in class AMatrix

Returns:

the transpose of this matrix

getRowClone

public Vector3 getRowClone(int row)

Returns a row of the matrix as a cloned vector

Specified by:

getRowClone in interface IMatrix

Overrides:

getRowClone in class AMatrix

copyRowTo

public void copyRowTo(int row,
                      double[] dest,
                      int destOffset)

Description copied from class: AMatrix

Copies the elements in a selected row of this matrix to a double array

Overrides:

copyRowTo in class AMatrix

Parameters:

row - The index of the selected row

dest - Destination double[] array

destOffset - Offset into destination array

inverse

public Matrix33 inverse()

Description copied from class: AMatrix

Computes the inverse of a matrix. Returns null if the matrix is singular. Throws an Exception is the matrix is not square

Specified by:

inverse in interface IMatrix

Overrides:

inverse in class AMatrix

Returns:

A matrix which is the inverse of this matrix, or null if the inverse does not exist.

trace

public double trace()

Description copied from interface: IMatrix

Computes the trace of a matrix, i.e. the sum of all elements on the leading diagonal

Specified by:

trace in interface IMatrix

Overrides:

trace in class AMatrix

Returns:

diagonalProduct

public double diagonalProduct()

Description copied from class: AMatrix

Computes the product of entries on the main diagonal of a matrix

Specified by:

diagonalProduct in interface IMatrix

Overrides:

diagonalProduct in class AMatrix

Returns:

clone

public Matrix33 clone()

Description copied from interface: INDArray

Returns a clone of the array data, as a new array which will be fully mutable and may be of a different class to the original. Clone should attempt to return the most efficient possible array type. Clone should preserve sparsity property where possible, but this is not guaranteed.

Specified by:

clone in interface INDArray

Overrides:

clone in class AMatrix

toDoubleArray

public double[] toDoubleArray()

Description copied from interface: INDArray

Copies the elements of this array to a new double[] array.

Specified by:

toDoubleArray in interface INDArray

Overrides:

toDoubleArray in class AMatrix

exactClone

public Matrix33 exactClone()

Description copied from interface: INDArray

Creates a deep clone of an array, using the same class implementation as the original array

Specified by:

exactClone in interface INDArray

Specified by:

exactClone in class AMatrix

Returns:

A clone of the original array

getElements

public void getElements(double[] data,
                        int offset)

Description copied from interface: INDArray

Copies all elements of this array a double array at the specified offset

Specified by:

getElements in interface INDArray

Overrides:

getElements in class AMatrix

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AMatrix

equals

public boolean equals(Matrix33 m)

createIdentityMatrix

public static Matrix33 createIdentityMatrix()

createScaleMatrix

public static Matrix33 createScaleMatrix(double d)

isZero

public boolean isZero()

Description copied from class: AMatrix

Returns true if the matrix is the zero matrix (all components zero)

Specified by:

isZero in interface INDArray

Overrides:

isZero in class AMatrix