mikera.matrixx

Class Matrix22

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.APrimitiveMatrix

mikera.matrixx.Matrix22

All Implemented Interfaces:

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

public final class Matrix22
extends APrimitiveMatrix
implements ISpecialisedTransform

Specialised 2*2 Matrix for Vector2 maths, using primitive matrix elements

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
double	m00
double	m01
double	m10
double	m11

Constructor Summary

Constructors

Constructor and Description
Matrix22()
Matrix22(AMatrix m)
Matrix22(double m00, double m01, double m10, double m11)
Matrix22(Matrix22 source)

Method Summary

Modifier and Type	Method and Description
void	add(AMatrix a) Adds another matrix to this matrix.
void	add(Matrix22 a)
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
int	checkSquare() Checks if a matrix is square.
Matrix22	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 Matrix22	create(double a, double b, double c, double d)
static Matrix22	createIdentity() Creates a new mutable 2D identity matrix
static Matrix22	createReflectionMatrix(AVector normal)
static Matrix22	createReflectionMatrix(Vector2 normal)
static Matrix22	createRotationMatrix(double angle)
static Matrix22	createScaleMatrix(double d)
double	determinant() Calculates the determinant of the matrix.
long	elementCount() Returns the total number of elements in this array.
double	elementMax() Returns the maximum element value in this array.
double	elementMin() Returns the maximum element value in this array.
double	elementSum() Returns the sum of all elements in this matrix
boolean	equals(Matrix22 m)
boolean	equals(java.lang.Object o)
Matrix22	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
Vector2	getColumnClone(int column) Returns a column of the matrix as a new cloned, mutable vector The cloned column may be modified without affecting the original matrix.
void	getElements(double[] data, int offset) Copies all elements of this array a double array at the specified offset
Vector2	getRowClone(int row) Returns a row of the matrix as a new cloned, mutable vector.
Matrix22	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
Matrix22	innerProduct(Matrix22 a)
Vector2	innerProduct(Vector2 a)
Matrix22	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(AMatrix m) Sets this matrix with the element values from another matrix.
void	set(int row, int column, double value) Sets a value at a given position in a mutable 2D array
void	set(Matrix22 a)
void	sub(Matrix22 a)
double[]	toDoubleArray() Copies the elements of this array to a new double[] array.
Vector	toVector() Coerces the array into a flattened dense Vector, in row-major order.
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).
Vector2	transform(Vector2 source)
void	transform(Vector2 source, AVector dest)
void	transform(Vector2 source, Vector2 dest)
void	transformInPlace(Vector2 dest)
void	unsafeSet(AMatrix m)

Methods inherited from class mikera.matrixx.impl.APrimitiveMatrix

copy, getColumn, getRow, isFullyMutable, isSquare

Methods inherited from class mikera.matrixx.AMatrix

abs, 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, diagonalProduct, dimensionality, divide, divide, divide, divide, divideCopy, elementIterator, elementsEqual, elementSquaredSum, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equalsArray, equalsTranspose, exp, fill, get, get, get, get, getBand, getBandWrapped, 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, 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, toAffineTransform, toDoubleBuffer, toMatrix, toMatrixTranspose, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, transform, transformInPlace, 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, elementMaxAbs, 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, elementMaxAbs, 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

m10

public double m10

m11

public double m11

Constructor Detail

Matrix22

public Matrix22()

Matrix22

public Matrix22(Matrix22 source)

Matrix22

public Matrix22(double m00,
                double m01,
                double m10,
                double m11)

Matrix22

public Matrix22(AMatrix m)

Method Detail

set

public void set(Matrix22 a)

set

public void set(AMatrix m)

Description copied from class: AMatrix

Sets this matrix with the element values from another matrix. Source matrix must have the same shape.

Overrides:

set in class AMatrix

unsafeSet

public void unsafeSet(AMatrix m)

create

public static Matrix22 create(double a,
                              double b,
                              double c,
                              double d)

createRotationMatrix

public static Matrix22 createRotationMatrix(double angle)

createScaleMatrix

public static Matrix22 createScaleMatrix(double d)

createIdentity

public static Matrix22 createIdentity()

Creates a new mutable 2D identity matrix

Returns:

createReflectionMatrix

public static Matrix22 createReflectionMatrix(AVector normal)

createReflectionMatrix

public static Matrix22 createReflectionMatrix(Vector2 normal)

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

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

elementSum

public double elementSum()

Description copied from class: AMatrix

Returns the sum of all elements in this matrix

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class AMatrix

elementMin

public double elementMin()

Description copied from interface: INDArray

Returns the maximum element value in this array. Throws an error if there are no elements.

Specified by:

elementMin in interface INDArray

Overrides:

elementMin in class AbstractArray<AVector>

elementMax

public double elementMax()

Description copied from interface: INDArray

Returns the maximum element value in this array. Throws an error if there are no elements.

Specified by:

elementMax in interface INDArray

Overrides:

elementMax in class AbstractArray<AVector>

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:

inverse

public Matrix22 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.

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:

add

public void add(AMatrix a)

Description copied from class: AMatrix

Adds another matrix to this matrix. Matrices must be the same size.

Overrides:

add in class AMatrix

add

public void add(Matrix22 a)

sub

public void sub(Matrix22 a)

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

getRowClone

public Vector2 getRowClone(int row)

Description copied from interface: IMatrix

Returns a row of the matrix as a new cloned, mutable vector. The cloned row may be modified without affecting the original matrix.

Specified by:

getRowClone in interface IMatrix

Overrides:

getRowClone in class AMatrix

getColumnClone

public Vector2 getColumnClone(int column)

Description copied from interface: IMatrix

Returns a column of the matrix as a new cloned, mutable vector The cloned column may be modified without affecting the original matrix.

Specified by:

getColumnClone in interface IMatrix

Overrides:

getColumnClone 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

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

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 Vector2 innerProduct(Vector2 a)

innerProduct

public Matrix22 innerProduct(Matrix22 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(Vector2 source,
                      AVector dest)

transform

public void transform(Vector2 source,
                      Vector2 dest)

transform

public Vector2 transform(Vector2 source)

transformInPlace

public void transformInPlace(Vector2 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:

toVector

public Vector toVector()

Description copied from interface: INDArray

Coerces the array into a flattened dense Vector, in row-major order. May return the same array if it is already a Vector instance.

Specified by:

toVector in interface INDArray

Overrides:

toVector in class AMatrix

getTranspose

public Matrix22 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

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(Matrix22 m)

clone

public Matrix22 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

exactClone

public Matrix22 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

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

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