agi.foundation.coordinates

(agi.foundation.core-2024r3.jar)

Class Matrix

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.coordinates.Matrix

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IEquatableEpsilon<Matrix>, IFreezable

Direct Known Subclasses:

DenseMatrix, DiagonalMatrix

public abstract class Matrix
extends DefinitionalObject
implements IEquatableEpsilon<Matrix>

A two-dimensional tensor of doubles.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Matrix(int rowDimension, int columnDimension) Initializes a new instance with the specified dimensions.
protected	Matrix(Matrix existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
static Matrix	add(Matrix3By3 leftAddend, Matrix rightAddend) Creates a Matrix which is the sum of the two given matrices.
static Matrix	add(Matrix6By6 left, Matrix rightAddend) Creates a Matrix which is the sum of the two given matrices.
static Matrix	add(Matrix leftAddend, Matrix rightAddend) Creates a Matrix which is the sum of the two given matrices.
static Matrix	add(Matrix leftAddend, Matrix3By3 rightAddend) Creates a Matrix which is the sum of the two given matrices.
static Matrix	add(Matrix leftAddend, Matrix6By6 rightAddend) Creates a Matrix which is the sum of the two given matrices.
static void	addAssign(Matrix leftAddend, Matrix rightAddend, Matrix sum) Sets the sum Matrix to equal the element-wise addition of the leftAddend and the rightAddend.
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(Matrix other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
static Matrix	elementDivide(Matrix3By3 dividend, Matrix divisor) Creates a new Matrix which is the element-by-element division of the two given matrices.
static Matrix	elementDivide(Matrix6By6 dividend, Matrix divisor) Creates a new Matrix which is the element-by-element division of the two given matrices.
static Matrix	elementDivide(Matrix dividend, Matrix divisor) Creates a new Matrix which is the element-by-element division of the two given matrices.
static Matrix	elementDivide(Matrix dividend, Matrix3By3 divisor) Creates a new Matrix which is the element-by-element division of the two given matrices.
static Matrix	elementDivide(Matrix dividend, Matrix6By6 divisor) Creates a new Matrix which is the element-by-element division of the two given matrices.
static void	elementDivideAssign(Matrix dividend, Matrix divisor, Matrix quotient) Sets the quotient Matrix to equal the element-wise division of the dividend divided by the divisor.
static Matrix	elementMultiply(Matrix3By3 multiplicand, Matrix multiplier) Creates a new Matrix which is the element-by-element multiplication of the two given matrices.
static Matrix	elementMultiply(Matrix6By6 multiplicand, Matrix multiplier) Creates a new Matrix which is the element-by-element multiplication of the two given matrices.
static Matrix	elementMultiply(Matrix multiplicand, Matrix multiplier) Creates a new Matrix which is the element-by-element multiplication of the two given matrices.
static Matrix	elementMultiply(Matrix multiplicand, Matrix3By3 multiplier) Creates a new Matrix which is the element-by-element multiplication of the two given matrices.
static Matrix	elementMultiply(Matrix multiplicand, Matrix6By6 multiplier) Creates a new Matrix which is the element-by-element multiplication of the two given matrices.
static void	elementMultiplyAssign(Matrix multiplicand, Matrix multiplier, Matrix product) Sets the product Matrix to equal the element-wise multiplication of the multiplicand times the multiplier.
static boolean	equals(Matrix left, Matrix right) Indicates whether the two provided matrices hold the same data.
boolean	equalsEpsilon(Matrix other, double epsilon) Indicates whether each cell value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.
abstract double	get(int rowIndex, int columnIndex) Gets the value of the element at the given location.
int	getColumnDimension() Gets the number of columns in this matrix.
Matrix	getFrozenCopy() Gets a frozen copy of this Matrix.
Matrix	getMatrix(int[] rowArray, int[] columnArray) Gets a new matrix with the values of the specified subset of this matrix.
void	getMatrix(int[] rowArray, int[] columnArray, Matrix destination) Places the values of a subsection of this matrix into the given matrix.
Matrix	getMatrix(int[] rowArray, int firstColumn, int numberOfColumns) Gets a new matrix with the values of the specified subset of this matrix.
void	getMatrix(int[] rowArray, int firstColumn, int numberOfColumns, Matrix destination) Places the values of a subsection of this matrix into the given matrix.
Matrix	getMatrix(int firstRow, int numberOfRows, int[] columnArray) Gets a new matrix with the values of the specified subset of this matrix.
void	getMatrix(int firstRow, int numberOfRows, int[] columnArray, Matrix destination) Places the values of a subsection of this matrix into the given matrix.
Matrix	getMatrix(int firstRow, int numberOfRows, int firstColumn, int numberOfColumns) Gets a new matrix with the values of the specified subset of this matrix.
void	getMatrix(int firstRow, int numberOfRows, int firstColumn, int numberOfColumns, Matrix destination) Places the values of a subsection of this matrix into the given matrix.
int	getRowDimension() Gets the number of rows in this matrix.
abstract Matrix	multiply(double factor) Creates a new Matrix which has the value of the current matrix multiplied by the given factor.
static Matrix	multiply(double factor, Matrix matrix) Creates a new Matrix which has the value of the given matrix multiplied by the given factor.
static Matrix	multiply(Matrix3By3 multiplicand, Matrix multiplier) Creates a Matrix which is the linear algebra multiplication of the two given matrices.
static Matrix	multiply(Matrix6By6 multiplicand, Matrix multiplier) Creates a Matrix which is the linear algebra multiplication of the two given matrices.
static Matrix	multiply(Matrix matrix, double factor) Creates a new Matrix which has the value of the given matrix multiplied by the given factor.
static Matrix	multiply(Matrix multiplicand, Matrix multiplier) Creates a Matrix which is the linear algebra multiplication of the two given matrices.
static Matrix	multiply(Matrix multiplicand, Matrix3By3 multiplier) Creates a Matrix which is the linear algebra multiplication of the two given matrices.
static Matrix	multiply(Matrix multiplicand, Matrix6By6 multiplier) Creates a Matrix which is the linear algebra multiplication of the two given matrices.
static void	multiplyAssign(Matrix multiplicand, Matrix multiplier, Matrix product) Sets the product Matrix to equal the linear algebra multiplication of the multiplicand times the multiplier.
abstract void	set(int rowIndex, int columnIndex, double value) Sets the value of the element at the given location.
void	setMatrix(int[] rowArray, int[] columnArray, Matrix origin) Sets the contents of a subset of this matrix to equal the values of the given origin matrix.
void	setMatrix(int[] destinationRowArray, int[] destinationColumnArray, Matrix origin, int[] originRowArray, int[] originColumnArray) Sets the contents of a subset of this matrix to equal the values of the given origin matrix.
void	setMatrix(int[] rowArray, int firstColumn, int numberOfColumns, Matrix origin) Sets the contents of a subset of this matrix to equal the values of the given origin matrix.
void	setMatrix(int firstRow, int numberOfRows, int[] columnArray, Matrix origin) Sets the contents of a subset of this matrix to equal the values of the given origin matrix.
void	setMatrix(int firstRow, int numberOfRows, int firstColumn, int numberOfColumns, Matrix origin) Sets the contents of a subset of this matrix to equal the values of the given origin matrix.
static Matrix	subtract(Matrix3By3 minuend, Matrix subtrahend) Creates a Matrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix.
static Matrix	subtract(Matrix6By6 minuend, Matrix subtrahend) Creates a Matrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix.
static Matrix	subtract(Matrix minuend, Matrix subtrahend) Creates a Matrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix.
static Matrix	subtract(Matrix minuend, Matrix3By3 subtrahend) Creates a Matrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix.
static Matrix	subtract(Matrix minuend, Matrix6By6 subtrahend) Creates a Matrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix.
static void	subtractAssign(Matrix minuend, Matrix subtrahend, Matrix difference) Sets the difference Matrix to equal the element-wise subtraction of the minuend by the subtrahend.
String	toString() Returns a string representation of the matrix.
abstract Matrix	transpose() Creates a new Matrix which is the transpose of the current matrix.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Matrix

protected Matrix(int rowDimension,
                 int columnDimension)

Initializes a new instance with the specified dimensions.

Parameters:

rowDimension - The number of rows in the new matrix.

columnDimension - The number of columns in the new matrix.

Throws:

ArgumentOutOfRangeException - Thrown when rowDimension or columnDimension are less than zero.

Matrix

protected Matrix(@Nonnull
                 Matrix existingInstance,
                 @Nonnull
                 CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(Matrix other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the Matrix.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getFrozenCopy

@Nonnull
public final Matrix getFrozenCopy()

Gets a frozen copy of this Matrix. If this matrix is already frozen it returns a reference to itself, otherwise it clones itself, freezes the clone, and returns that object.

Returns:

A frozen copy of the current matrix.

transpose

@Nonnull
public abstract Matrix transpose()

Creates a new Matrix which is the transpose of the current matrix.

Returns:

The new matrix.

multiply

@Nonnull
public abstract Matrix multiply(double factor)

Creates a new Matrix which has the value of the current matrix multiplied by the given factor.

Parameters:

factor - The 'scalar' to multiply by the current Matrix.

Returns:

The new matrix.

equalsEpsilon

public final boolean equalsEpsilon(@Nullable
                                   Matrix other,
                                   double epsilon)

Indicates whether each cell value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.

Specified by:

equalsEpsilon in interface IEquatableEpsilon<Matrix>

Parameters:

other - The Matrix to compare to this instance.

epsilon - The limit at which the absolute differences between the coordinate values will not be considered equal.

Returns:

true if the absolute differences are less than or equal to epsilon; otherwise false.

getMatrix

@Nonnull
public final Matrix getMatrix(int firstRow,
                                        int numberOfRows,
                                        int firstColumn,
                                        int numberOfColumns)

Gets a new matrix with the values of the specified subset of this matrix.

Parameters:

firstRow - Inclusive initial index of rows to output from this matrix.

numberOfRows - Number of rows to output from this matrix.

firstColumn - Inclusive initial index of columns to output from this matrix.

numberOfColumns - Number of columns to output from this matrix.

Returns:

A new matrix with the values of the submatrix occurring between the specified bounds.

Throws:

ArgumentOutOfRangeException - Thrown when firstRow, numberOfRows, firstColumn, or numberOfColumns is less than 0.

ArgumentException - Thrown when firstRow plus numberOfRows is greater than the row dimension of this matrix, or when firstColumn plus numberOfColumns is greater than the column dimension of this matrix.

getMatrix

public final void getMatrix(int firstRow,
                            int numberOfRows,
                            int firstColumn,
                            int numberOfColumns,
                            @Nonnull
                            Matrix destination)

Places the values of a subsection of this matrix into the given matrix. The destination matrix must match the dimensions of the requested submatrix.

Parameters:

firstRow - Inclusive initial index of rows to output from this matrix.

numberOfRows - Number of rows to output from this matrix.

firstColumn - Inclusive initial index of columns to output from this matrix.

numberOfColumns - Number of columns to output from this matrix.

destination - The matrix to fill with the values of the submatrix.

Throws:

ArgumentNullException - Thrown when destination is null.

ArgumentOutOfRangeException - Thrown when firstRow, numberOfRows, firstColumn, or numberOfColumns is less than 0.

ArgumentException - Thrown when firstRow plus numberOfRows is greater than the row dimension of this matrix, or when firstColumn plus numberOfColumns is greater than the column dimension of this matrix, or when the row dimension of destination is not equal to numberOfRows, or when the column dimension of destination is not equal to numberOfColumns.

getMatrix

@Nonnull
public final Matrix getMatrix(@Nonnull
                                        int[] rowArray,
                                        int firstColumn,
                                        int numberOfColumns)

Gets a new matrix with the values of the specified subset of this matrix.

Parameters:

rowArray - Array of indices of rows to output from this matrix.

firstColumn - Inclusive initial index of columns to output from this matrix.

numberOfColumns - Number of columns to output from this matrix.

Returns:

A new matrix with the values of the specified subset of this matrix.

Throws:

ArgumentNullException - Thrown when rowArray is null.

ArgumentOutOfRangeException - Thrown when firstColumn or numberOfColumns is less than 0.

ArgumentException - Thrown when firstColumn plus numberOfColumns is greater than the column dimension of this matrix, or when rowArray contains values less than zero or greater than or equal to the row dimension of this matrix.

getMatrix

public final void getMatrix(@Nonnull
                            int[] rowArray,
                            int firstColumn,
                            int numberOfColumns,
                            @Nonnull
                            Matrix destination)

Places the values of a subsection of this matrix into the given matrix. The destination matrix must match the dimensions of the requested submatrix.

Parameters:

rowArray - Array of indices of rows to output from this matrix.

firstColumn - Inclusive initial index of columns to output from this matrix.

numberOfColumns - Number of columns to output from this matrix.

destination - The matrix to fill with the values of the submatrix.

Throws:

ArgumentNullException - Thrown when rowArray or destination is null.

ArgumentOutOfRangeException - Thrown when firstColumn or numberOfColumns is less than 0.

ArgumentException - Thrown when firstColumn plus numberOfColumns is greater than the column dimension of this matrix, or when the row dimension of destination is not equal to the length of rowArray, or when the column dimension of destination is not equal to numberOfColumns, or when rowArray contains values less than zero or greater than or equal to the row dimension of this matrix.

getMatrix

@Nonnull
public final Matrix getMatrix(int firstRow,
                                        int numberOfRows,
                                        @Nonnull
                                        int[] columnArray)

Gets a new matrix with the values of the specified subset of this matrix.

Parameters:

firstRow - Inclusive initial index of rows to output from this matrix.

numberOfRows - Number of rows to output from this matrix.

columnArray - Array of indices of columns to output from this matrix.

Returns:

A new matrix with the values of the specified subset of this matrix.

Throws:

ArgumentNullException - Thrown when columnArray is null.

ArgumentOutOfRangeException - Thrown when firstRow or numberOfRows is less than 0.

ArgumentException - Thrown when firstRow plus numberOfRows is greater than the row dimension of this matrix, or when columnArray contains values less than zero or greater than or equal to the column dimension of this matrix.

getMatrix

public final void getMatrix(int firstRow,
                            int numberOfRows,
                            @Nonnull
                            int[] columnArray,
                            @Nonnull
                            Matrix destination)

Places the values of a subsection of this matrix into the given matrix. The destination matrix must match the dimensions of the requested submatrix.

Parameters:

firstRow - Inclusive initial index of rows to output from this matrix.

numberOfRows - Number of rows to output from this matrix.

columnArray - Array of indices of columns to output from this matrix.

destination - The matrix to fill with the values of the submatrix.

Throws:

ArgumentNullException - Thrown when columnArray or destination is null.

ArgumentOutOfRangeException - Thrown when firstRow or numberOfRows is less than 0.

ArgumentException - Thrown when firstRow plus numberOfRows is greater than the row dimension of this matrix, or when the row dimension of destination is not equal to numberOfRows, or when the column dimension of destination is not equal to the length of columnArray, or when columnArray contains values less than zero or greater than or equal to the column dimension of this matrix.

getMatrix

@Nonnull
public final Matrix getMatrix(@Nonnull
                                        int[] rowArray,
                                        @Nonnull
                                        int[] columnArray)

Gets a new matrix with the values of the specified subset of this matrix.

Parameters:

rowArray - Array of indices of rows to output from this matrix.

columnArray - Array of indices of columns to output from this matrix.

Returns:

A new matrix with the values of the specified subset of this matrix.

Throws:

ArgumentNullException - Thrown when rowArray or columnArray is null.

ArgumentException - Thrown when rowArray contains values less than zero or greater than or equal to the row dimension of this matrix, or when columnArray contains values less than zero or greater than or equal to the column dimension of this matrix.

getMatrix

public final void getMatrix(@Nonnull
                            int[] rowArray,
                            @Nonnull
                            int[] columnArray,
                            @Nonnull
                            Matrix destination)

Places the values of a subsection of this matrix into the given matrix. The destination matrix must match the dimensions of the requested submatrix.

Parameters:

rowArray - Array of indices of rows to output from this matrix.

columnArray - Array of indices of columns to output from this matrix.

destination - The matrix to fill with the values of the submatrix.

Throws:

ArgumentNullException - Thrown when rowArray, columnArray, or destination is null.

ArgumentException - Thrown when the row dimension of destination is not equal to the length of rowArray, or when the column dimension of destination is not equal to the length of columnArray, or when rowArray contains values less than zero or greater than or equal to the row dimension of this matrix, or when columnArray contains values less than zero or greater than or equal to the column dimension of this matrix.

setMatrix

public final void setMatrix(int firstRow,
                            int numberOfRows,
                            int firstColumn,
                            int numberOfColumns,
                            @Nonnull
                            Matrix origin)

Sets the contents of a subset of this matrix to equal the values of the given origin matrix. The origin matrix must match the dimensions of the requested submatrix.

Parameters:

firstRow - Inclusive initial index of rows to receive input from the origin matrix.

numberOfRows - Number of rows to receive input from the origin matrix.

firstColumn - Inclusive initial index of columns to receive input from the origin matrix.

numberOfColumns - Number of columns to receive input from the origin matrix.

origin - The matrix containing the subset of values to set to the elements of this matrix.

Throws:

ArgumentNullException - Thrown when origin is null.

ArgumentOutOfRangeException - Thrown when firstRow, numberOfRows, firstColumn, or numberOfColumns is less than 0.

ArgumentException - Thrown when firstRow plus numberOfRows is greater than the row dimension of this matrix, or when firstColumn plus numberOfColumns is greater than the column dimension of this matrix, or when the row dimension of origin is not equal to numberOfRows, or when the column dimension of origin is not equal to numberOfColumns.

setMatrix

public final void setMatrix(@Nonnull
                            int[] rowArray,
                            int firstColumn,
                            int numberOfColumns,
                            @Nonnull
                            Matrix origin)

Sets the contents of a subset of this matrix to equal the values of the given origin matrix. The origin matrix must match the dimensions of the requested submatrix.

Parameters:

rowArray - Array of indices of rows to receive input from the origin matrix.

firstColumn - Inclusive initial index of columns to receive input from the origin matrix.

numberOfColumns - Number of columns to receive input from the origin matrix.

origin - The matrix containing the subset of values to set to the elements of this matrix.

Throws:

ArgumentNullException - Thrown when origin is null.

ArgumentOutOfRangeException - Thrown when firstColumn, or numberOfColumns is less than 0.

ArgumentException - Thrown when firstColumn plus numberOfColumns is greater than the column dimension of this matrix, or when the row dimension of origin is not equal to the length of rowArray, or when the column dimension of origin is not equal to numberOfColumns, or when rowArray contains values less than zero or greater than or equal to the row dimension of this matrix.

setMatrix

public final void setMatrix(int firstRow,
                            int numberOfRows,
                            @Nonnull
                            int[] columnArray,
                            @Nonnull
                            Matrix origin)

Sets the contents of a subset of this matrix to equal the values of the given origin matrix. The origin matrix must match the dimensions of the requested submatrix.

Parameters:

firstRow - Inclusive initial index of rows to receive input from the origin matrix.

numberOfRows - Number of rows to receive input from the origin matrix.

columnArray - Array of indices of columns to receive input from the origin matrix.

origin - The matrix containing the subset of values to set to the elements of this matrix.

Throws:

ArgumentNullException - Thrown when columnArray or origin is null.

ArgumentOutOfRangeException - Thrown when firstRow, or numberOfRows is less than 0.

ArgumentException - Thrown when firstRow plus numberOfRows is greater than the row dimension of this matrix, or when the row dimension of origin is not equal to numberOfRows, or when the column dimension of origin is not equal to the length of columnArray, or when columnArray contains values less than zero or greater than or equal to the column dimension of this matrix.

setMatrix

public final void setMatrix(@Nonnull
                            int[] rowArray,
                            @Nonnull
                            int[] columnArray,
                            @Nonnull
                            Matrix origin)

Sets the contents of a subset of this matrix to equal the values of the given origin matrix. The origin matrix must match the dimensions of the requested submatrix.

Parameters:

rowArray - Array of indices of rows to receive input from the origin matrix.

columnArray - Array of indices of columns to receive input from the origin matrix.

origin - The matrix containing the subset of values to set to the elements of this matrix.

Throws:

ArgumentNullException - Thrown when rowArray, columnArray, or origin is null.

ArgumentException - Thrown when the row dimension of origin is not equal to the length of rowArray, or when the column dimension of origin is not equal to the length of columnArray, or when rowArray contains values less than zero or greater than or equal to the row dimension of this matrix, or when columnArray contains values less than zero or greater than or equal to the column dimension of this matrix.

setMatrix

public final void setMatrix(@Nonnull
                            int[] destinationRowArray,
                            @Nonnull
                            int[] destinationColumnArray,
                            @Nonnull
                            Matrix origin,
                            @Nonnull
                            int[] originRowArray,
                            @Nonnull
                            int[] originColumnArray)

Sets the contents of a subset of this matrix to equal the values of the given origin matrix. The origin matrix must match the dimensions of the requested submatrix.

Parameters:

destinationRowArray - Array of indices of rows to receive input from the origin matrix.

destinationColumnArray - Array of indices of columns to receive input from the origin matrix.

origin - The matrix containing the subset of values to set to the elements of this matrix.

originRowArray - Array of indices of rows to take input from the origin matrix.

originColumnArray - Array of indices of columns to take input from the origin matrix.

Throws:

ArgumentNullException - Thrown when destinationRowArray, destinationColumnArray, origin,originRowArray, or originColumnArray is null.

ArgumentException - Thrown when the length of destinationRowArray is not equal to the length of originRowArray, or when the length of destinationColumnArray is not equal to the length of originColumnArray, or when destinationRowArray contains values less than zero or greater than or equal to the row dimension of this matrix, or when destinationColumnArray contains values less than zero or greater than or equal to the column dimension of this matrix, or when originRowArray contains values less than zero or greater than or equal to the row dimension of origin, or when originColumnArray contains values less than zero or greater than or equal to the column dimension of origin.

getRowDimension

public final int getRowDimension()

Gets the number of rows in this matrix.

getColumnDimension

public final int getColumnDimension()

Gets the number of columns in this matrix.

get

public abstract double get(int rowIndex,
                           int columnIndex)

Gets the value of the element at the given location.

Parameters:

rowIndex - The row index of the desired element.

columnIndex - The column index of the desired element.

Returns:

The value of the element at the given location.

Throws:

ObjectFrozenException - Thrown when a set is attempted on a Matrix when IsFrozen (get) is true.

set

public abstract void set(int rowIndex,
                         int columnIndex,
                         double value)

Sets the value of the element at the given location.

Parameters:

rowIndex - The row index of the desired element.

columnIndex - The column index of the desired element.

Throws:

ObjectFrozenException - Thrown when a set is attempted on a Matrix when IsFrozen (get) is true.

equals

public static boolean equals(Matrix left,
                             Matrix right)

Indicates whether the two provided matrices hold the same data. The type of matrix is not examined, only their dimensions and the value of the elements at each index.

Parameters:

left - The first matrix to compare.

right - The second matrix to compare.

Returns:

true if the given matrices hold the same values; otherwise false.

addAssign

public static void addAssign(@Nonnull
                             Matrix leftAddend,
                             @Nonnull
                             Matrix rightAddend,
                             @Nonnull
                             Matrix sum)

Sets the sum Matrix to equal the element-wise addition of the leftAddend and the rightAddend.

Parameters:

leftAddend - The first Matrix to sum.

rightAddend - The second Matrix to sum.

sum - The Matrix to use to store the result of the operation.

subtractAssign

public static void subtractAssign(@Nonnull
                                  Matrix minuend,
                                  @Nonnull
                                  Matrix subtrahend,
                                  @Nonnull
                                  Matrix difference)

Sets the difference Matrix to equal the element-wise subtraction of the minuend by the subtrahend.

Parameters:

minuend - The Matrix being subtracted from.

subtrahend - The Matrix to subtract.

difference - The Matrix to use to store the result of the operation.

elementMultiply

@Nonnull
public static Matrix elementMultiply(@Nonnull
                                               Matrix multiplicand,
                                               @Nonnull
                                               Matrix multiplier)

Creates a new Matrix which is the element-by-element multiplication of the two given matrices.

The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices.

Parameters:

multiplicand - The first Matrix to multiply.

multiplier - The second Matrix to multiply.

Returns:

A Matrix which equals the element multiplication of the two given matrices.

elementMultiply

@Nonnull
public static Matrix elementMultiply(@Nonnull
                                               Matrix multiplicand,
                                               @Nonnull
                                               Matrix3By3 multiplier)

Creates a new Matrix which is the element-by-element multiplication of the two given matrices.

Parameters:

multiplicand - The first Matrix to multiply.

multiplier - The second Matrix3By3 to multiply.

Returns:

A Matrix which equals the element multiplication of the two given matrices.

elementMultiply

@Nonnull
public static Matrix elementMultiply(@Nonnull
                                               Matrix3By3 multiplicand,
                                               @Nonnull
                                               Matrix multiplier)

Creates a new Matrix which is the element-by-element multiplication of the two given matrices.

Parameters:

multiplicand - The first Matrix3By3 to multiply.

multiplier - The second Matrix to multiply.

Returns:

A Matrix which equals the element multiplication of the two given matrices.

elementMultiply

@Nonnull
public static Matrix elementMultiply(@Nonnull
                                               Matrix multiplicand,
                                               @Nonnull
                                               Matrix6By6 multiplier)

Creates a new Matrix which is the element-by-element multiplication of the two given matrices.

Parameters:

multiplicand - The first Matrix to multiply.

multiplier - The second Matrix6By6 to multiply.

Returns:

A Matrix which equals the element multiplication of the two given matrices.

elementMultiply

@Nonnull
public static Matrix elementMultiply(@Nonnull
                                               Matrix6By6 multiplicand,
                                               @Nonnull
                                               Matrix multiplier)

Creates a new Matrix which is the element-by-element multiplication of the two given matrices.

Parameters:

multiplicand - The first Matrix6By6 to multiply.

multiplier - The second Matrix to multiply.

Returns:

A Matrix which equals the element multiplication of the two given matrices.

elementMultiplyAssign

public static void elementMultiplyAssign(@Nonnull
                                         Matrix multiplicand,
                                         @Nonnull
                                         Matrix multiplier,
                                         @Nonnull
                                         Matrix product)

Sets the product Matrix to equal the element-wise multiplication of the multiplicand times the multiplier.

Parameters:

multiplicand - The first Matrix to multiply.

multiplier - The second Matrix to multiply.

product - The Matrix to use to store the result of the operation.

elementDivide

@Nonnull
public static Matrix elementDivide(@Nonnull
                                             Matrix dividend,
                                             @Nonnull
                                             Matrix divisor)

Creates a new Matrix which is the element-by-element division of the two given matrices.

The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices.

Parameters:

dividend - The Matrix whose elements will form the numerators.

divisor - The Matrix whose elements will form the denominators.

Returns:

A Matrix which equals the element division of the two given matrices.

elementDivide

@Nonnull
public static Matrix elementDivide(@Nonnull
                                             Matrix dividend,
                                             @Nonnull
                                             Matrix3By3 divisor)

Creates a new Matrix which is the element-by-element division of the two given matrices.

Parameters:

dividend - The Matrix whose elements will form the numerators.

divisor - The Matrix3By3 whose elements will form the denominators.

Returns:

A Matrix which equals the element division of the two given matrices.

elementDivide

@Nonnull
public static Matrix elementDivide(@Nonnull
                                             Matrix3By3 dividend,
                                             @Nonnull
                                             Matrix divisor)

Creates a new Matrix which is the element-by-element division of the two given matrices.

Parameters:

dividend - The Matrix3By3 whose elements will form the numerators.

divisor - The Matrix whose elements will form the denominators.

Returns:

A Matrix which equals the element division of the two given matrices.

elementDivide

@Nonnull
public static Matrix elementDivide(@Nonnull
                                             Matrix dividend,
                                             @Nonnull
                                             Matrix6By6 divisor)

Creates a new Matrix which is the element-by-element division of the two given matrices.

Parameters:

dividend - The Matrix whose elements will form the numerators.

divisor - The Matrix6By6 whose elements will form the denominators.

Returns:

A Matrix which equals the element division of the two given matrices.

elementDivide

@Nonnull
public static Matrix elementDivide(@Nonnull
                                             Matrix6By6 dividend,
                                             @Nonnull
                                             Matrix divisor)

Creates a new Matrix which is the element-by-element division of the two given matrices.

Parameters:

dividend - The Matrix6By6 whose elements will form the numerators.

divisor - The Matrix whose elements will form the denominators.

Returns:

A Matrix which equals the element division of the two given matrices.

elementDivideAssign

public static void elementDivideAssign(@Nonnull
                                       Matrix dividend,
                                       @Nonnull
                                       Matrix divisor,
                                       @Nonnull
                                       Matrix quotient)

Sets the quotient Matrix to equal the element-wise division of the dividend divided by the divisor.

Parameters:

dividend - The Matrix whose elements will form the numerators.

divisor - The Matrix whose elements will form the denominators.

quotient - The Matrix to use to store the result of the operation.

multiplyAssign

public static void multiplyAssign(@Nonnull
                                  Matrix multiplicand,
                                  @Nonnull
                                  Matrix multiplier,
                                  @Nonnull
                                  Matrix product)

Sets the product Matrix to equal the linear algebra multiplication of the multiplicand times the multiplier.

Parameters:

multiplicand - The first Matrix to multiply.

multiplier - The second Matrix to multiply.

product - The Matrix to use to store the result of the operation.

add

public static Matrix add(Matrix leftAddend,
                         Matrix rightAddend)

Creates a Matrix which is the sum of the two given matrices.

The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices.

Parameters:

leftAddend - The first Matrix to sum.

rightAddend - The second Matrix to sum.

Returns:

A Matrix which is the sum of the two given matrices and the given matrix

add

public static Matrix add(Matrix leftAddend,
                         @Nonnull
                         Matrix3By3 rightAddend)

Creates a Matrix which is the sum of the two given matrices.

Parameters:

leftAddend - The first Matrix to sum.

rightAddend - The second Matrix3By3 to sum.

Returns:

A Matrix which is the sum of the two given matrices and the given matrix

add

public static Matrix add(@Nonnull
                         Matrix3By3 leftAddend,
                         Matrix rightAddend)

Creates a Matrix which is the sum of the two given matrices.

Parameters:

leftAddend - The first Matrix3By3 to sum.

rightAddend - The second Matrix to sum.

Returns:

A Matrix which is the sum of the two given matrices and the given matrix

add

public static Matrix add(Matrix leftAddend,
                         Matrix6By6 rightAddend)

Creates a Matrix which is the sum of the two given matrices.

Parameters:

leftAddend - The first Matrix to sum.

rightAddend - The second Matrix6By6 to sum.

Returns:

A Matrix which is the sum of the two given matrices and the given matrix

add

public static Matrix add(Matrix6By6 left,
                         Matrix rightAddend)

Creates a Matrix which is the sum of the two given matrices.

Parameters:

left - The first Matrix6By6 to sum.

rightAddend - The second Matrix to sum.

Returns:

A Matrix which is the sum of the two given matrices and the given matrix

subtract

public static Matrix subtract(Matrix minuend,
                              Matrix subtrahend)

Creates a Matrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix.

The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices.

Parameters:

minuend - The Matrix being subtracted from.

subtrahend - The Matrix to subtract.

Returns:

A Matrix which is the subtraction of the two given matrices.

subtract

public static Matrix subtract(Matrix minuend,
                              @Nonnull
                              Matrix3By3 subtrahend)

Creates a Matrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix.

Parameters:

minuend - The Matrix being subtracted from.

subtrahend - The Matrix3By3 to subtract.

Returns:

A Matrix which is the subtraction of the two given matrices.

subtract

public static Matrix subtract(@Nonnull
                              Matrix3By3 minuend,
                              Matrix subtrahend)

Creates a Matrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix.

Parameters:

minuend - The Matrix3By3 being subtracted from.

subtrahend - The Matrix to subtract.

Returns:

A Matrix which is the subtraction of the two given matrices.

subtract

public static Matrix subtract(Matrix minuend,
                              Matrix6By6 subtrahend)

Creates a Matrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix.

Parameters:

minuend - The Matrix being subtracted from.

subtrahend - The Matrix6By6 to subtract.

Returns:

A Matrix which is the subtraction of the two given matrices.

subtract

public static Matrix subtract(Matrix6By6 minuend,
                              Matrix subtrahend)

Creates a Matrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix.

Parameters:

minuend - The Matrix6By6 being subtracted from.

subtrahend - The Matrix to subtract.

Returns:

A Matrix which is the subtraction of the two given matrices.

multiply

public static Matrix multiply(Matrix multiplicand,
                              Matrix multiplier)

Creates a Matrix which is the linear algebra multiplication of the two given matrices.

The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices.

Parameters:

multiplicand - The first Matrix to multiply.

multiplier - The second Matrix to multiply.

Returns:

A Matrix which is the multiplication of this matrix and the given matrix.

multiply

public static Matrix multiply(Matrix multiplicand,
                              @Nonnull
                              Matrix3By3 multiplier)

Creates a Matrix which is the linear algebra multiplication of the two given matrices.

Parameters:

multiplicand - The first Matrix to multiply.

multiplier - The second Matrix3By3 to multiply.

Returns:

A Matrix which is the multiplication of this matrix and the given matrix.

multiply

public static Matrix multiply(@Nonnull
                              Matrix3By3 multiplicand,
                              Matrix multiplier)

Creates a Matrix which is the linear algebra multiplication of the two given matrices.

Parameters:

multiplicand - The first Matrix3By3 to multiply.

multiplier - The second Matrix to multiply.

Returns:

A Matrix which is the multiplication of this matrix and the given matrix.

multiply

public static Matrix multiply(Matrix multiplicand,
                              Matrix6By6 multiplier)

Creates a Matrix which is the linear algebra multiplication of the two given matrices.

Parameters:

multiplicand - The first Matrix to multiply.

multiplier - The second Matrix6By6 to multiply.

Returns:

A Matrix which is the multiplication of this matrix and the given matrix.

multiply

public static Matrix multiply(Matrix6By6 multiplicand,
                              Matrix multiplier)

Creates a Matrix which is the linear algebra multiplication of the two given matrices.

Parameters:

multiplicand - The first Matrix6By6 to multiply.

multiplier - The second Matrix to multiply.

Returns:

A Matrix which is the multiplication of this matrix and the given matrix.

multiply

public static Matrix multiply(double factor,
                              Matrix matrix)

Creates a new Matrix which has the value of the given matrix multiplied by the given factor.

Parameters:

factor - The 'scalar' to multiply by the given matrix.

matrix - The matrix to be multiplied by the given factor.

Returns:

The new matrix.

multiply

public static Matrix multiply(Matrix matrix,
                              double factor)

Creates a new Matrix which has the value of the given matrix multiplied by the given factor.

Parameters:

matrix - The matrix to be multiplied by the given factor.

factor - The 'scalar' to multiply by the given matrix.

Returns:

The new matrix.

toString

public String toString()

Returns a string representation of the matrix.

Overrides:

toString in class Object

Returns:

A string representation of the matrix.