agi.foundation.coordinates

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

Class ComplexMatrix

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.coordinates.ComplexMatrix

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ComplexCrossSectionScatteringCoefficient

public class ComplexMatrix
extends DefinitionalObject

A two-dimensional matrix of Complex values.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ComplexMatrix(Complex[][] array) Initializes a new instance from a two-dimensional array of values.
	ComplexMatrix(Complex[][] array, int rowDimension, int columnDimension) Construct a matrix without copying the given array.
	ComplexMatrix(Complex[] elements, int rowDimension) Initializes a new instance from a one-dimensional packed array.
	ComplexMatrix(ComplexMatrix matrix) Initializes a new ComplexMatrix from an existing ComplexMatrix.
protected	ComplexMatrix(ComplexMatrix existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	ComplexMatrix(int rowDimension, int columnDimension) Initializes a new instance with the specified row and column dimensions.
	ComplexMatrix(int rowDimension, int columnDimension, Complex elementValue) Initializes a new instance with the specified row and column dimensions.

Method Summary

Modifier and Type	Method and Description
ComplexMatrix	add(ComplexMatrix addend) Creates a ComplexMatrix which is the sum of this matrix and the given matrix.
static ComplexMatrix	add(ComplexMatrix leftAddend, ComplexMatrix rightAddend) Creates a ComplexMatrix which is the sum of the two given matrices.
static void	addAssign(ComplexMatrix leftAddend, ComplexMatrix rightAddend, ComplexMatrix sum) Assigns the elements of sum to the element-wise addition of leftAddend and rightAddend.
protected boolean	checkForSameDefinition(ComplexMatrix other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
void	clear() Sets the value of every value in the matrix to zero.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
static ComplexMatrix	elementDivide(ComplexMatrix dividend, ComplexMatrix divisor) Creates a new ComplexMatrix which is the element-by-element division of the two given matrices.
static void	elementDivideAssign(ComplexMatrix dividend, ComplexMatrix divisor, ComplexMatrix quotient) Assigns the elements of quotient to the element-wise division of dividend divided by divisor.
ComplexMatrix	elementMultiply(ComplexMatrix matrix) Creates a ComplexMatrix which is the element-by-element multiplication of this matrix times the given matrix.
static ComplexMatrix	elementMultiply(ComplexMatrix multiplicand, ComplexMatrix multiplier) Creates a new ComplexMatrix which is the element-by-element multiplication of the two given matrices.
static void	elementMultiplyAssign(ComplexMatrix multiplicand, ComplexMatrix multiplier, ComplexMatrix product) Sets the product ComplexMatrix to equal the element-wise multiplication of the multiplicand times the multiplier.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
Complex	get(int rowIndex, int columnIndex) Gets the value at the specified location in the matrix.
int	getColumnDimension() Gets the number of columns in this matrix.
ComplexMatrix	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, ComplexMatrix destination) Assigns the values of a subsection of this matrix into the given matrix.
ComplexMatrix	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, ComplexMatrix destination) Assigns the values of a subsection of this matrix into the given matrix.
ComplexMatrix	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, ComplexMatrix destination) Places the values of a subsection of this matrix into the given matrix.
ComplexMatrix	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, ComplexMatrix destination) Assigns the values of a subsection of this matrix into the given matrix.
int	getRowDimension() Gets the number of rows in this matrix.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
ComplexMatrix	hermitianTranspose() Creates a new ComplexMatrix which is the Hermitian or conjugate transpose of the current matrix.
static ComplexMatrix	identity(int rowDimension, int columnDimension) Generates an identity matrix.
ComplexMatrix	inverse() ComplexMatrix inverse.
Complex[]	multiply(Complex[] vector) Returns the result of the multiplication of this matrix and a vector.
static Complex[]	multiply(ComplexMatrix matrix, Complex[] vector) Returns the result of the multiplication of this matrix and a vector.
static ComplexMatrix	multiply(ComplexMatrix multiplicand, ComplexMatrix multiplier) Creates a ComplexMatrix which is the linear algebra multiplication of the two given matrices.
static void	multiplyAssign(ComplexMatrix multiplicand, ComplexMatrix multiplier, ComplexMatrix product) Sets the product ComplexMatrix to equal the linear algebra multiplication of multiplicand times multiplier.
ComplexMatrix	postMultiply(ComplexMatrix multiplier) Creates a ComplexMatrix which is the linear algebra multiplication of this matrix times the given matrix.
ComplexMatrix	preMultiply(ComplexMatrix multiplicand) Creates a ComplexMatrix which is the linear algebra multiplication of the given matrix times this matrix.
void	set(int rowIndex, int columnIndex, Complex value) Sets the value at the specified location in the matrix.
static ComplexMatrix	subtract(ComplexMatrix minuend, ComplexMatrix subtrahend) Creates a ComplexMatrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix.
static void	subtractAssign(ComplexMatrix minuend, ComplexMatrix subtrahend, ComplexMatrix difference) Assigns the elements of difference to the element-wise subtraction of minuend by subtrahend.
ComplexMatrix	subtractFrom(ComplexMatrix minuend) Creates a ComplexMatrix whose elements have the values of the elements of this matrix subtracted by the elements of the given matrix.
ComplexMatrix	transpose() Creates a new ComplexMatrix which is the transpose of the current matrix.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, 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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComplexMatrix

public ComplexMatrix(int rowDimension,
                     int columnDimension)

Initializes a new instance with the specified row and column dimensions. All elements of the matrix will default to zero.

Parameters:

rowDimension - The number of rows in the matrix.

columnDimension - The number of columns in the matrix.

Throws:

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

ComplexMatrix

public ComplexMatrix(int rowDimension,
                     int columnDimension,
                     @Nonnull
                     Complex elementValue)

Initializes a new instance with the specified row and column dimensions. All elements of the matrix will be set to the provided value.

Parameters:

rowDimension - The number of rows in the matrix.

columnDimension - The number of columns in the matrix.

elementValue - The value that all elements in the matrix will be set to.

Throws:

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

ComplexMatrix

public ComplexMatrix(@Nonnull
                     Complex[][] array)

Initializes a new instance from a two-dimensional array of values.

Parameters:

array - A two-dimensional array of Complex values.

Throws:

IllegalStateException - Thrown when all rows are not the same length.

ArgumentNullException - Thrown when array is null.

ComplexMatrix

public ComplexMatrix(@Nonnull
                     Complex[][] array,
                     int rowDimension,
                     int columnDimension)

Construct a matrix without copying the given array.

Parameters:

array - Rectangular two-dimensional array of Complex numbers.

rowDimension - Number of rows, this must match the first dimension of the given array.

columnDimension - Number of columns, this must match the second dimensions of the given array.

Throws:

ArgumentNullException - Thrown when array is null.

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

ComplexMatrix

public ComplexMatrix(@Nonnull
                     Complex[] elements,
                     int rowDimension)

Initializes a new instance from a one-dimensional packed array.

Parameters:

elements - A one-dimensional array containing the values of all of the elements.

rowDimension - The number of rows in the matrix.

Throws:

ArgumentOutOfRangeException - Thrown when rowDimension is less than zero.

ArgumentException - Thrown when the length of elements is not a multiple of the column dimension.

ArgumentNullException - Thrown when elements is null.

ComplexMatrix

public ComplexMatrix(@Nonnull
                     ComplexMatrix matrix)

Initializes a new ComplexMatrix from an existing ComplexMatrix.

Parameters:

matrix - The existing ComplexMatrix to copy.

Throws:

ArgumentNullException - Thrown when matrix is null.

ComplexMatrix

protected ComplexMatrix(@Nonnull
                        ComplexMatrix 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

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

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 boolean checkForSameDefinition(ComplexMatrix 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 ComplexMatrix.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

get

public final Complex get(int rowIndex,
                         int columnIndex)

Gets the value at the specified location in the matrix.

Parameters:

rowIndex - The row index of the element being queried.

columnIndex - The column index of the element being queried.

Returns:

The Complex value in the matrix.

Throws:

IndexOutOfBoundsException - Thrown when rowIndex is greater than RowDimension (get), or when columnIndex is greater than ColumnDimension (get), or when either are less than zero.

set

public final void set(int rowIndex,
                      int columnIndex,
                      Complex value)

Sets the value at the specified location in the matrix.

Parameters:

rowIndex - The row index of the element being queried.

columnIndex - The column index of the element being queried.

Throws:

IndexOutOfBoundsException - Thrown when rowIndex is greater than RowDimension (get), or when columnIndex is greater than ColumnDimension (get), or when either are less than zero.

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.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

clear

public final void clear()

Sets the value of every value in the matrix to zero.

add

public static ComplexMatrix add(ComplexMatrix leftAddend,
                                ComplexMatrix rightAddend)

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

Parameters:

leftAddend - The first ComplexMatrix to sum.

rightAddend - The second ComplexMatrix to sum.

Returns:

A ComplexMatrix which is the sum of the two given matrices.

Throws:

IllegalStateException - Thrown when the dimensions of leftAddend do not match the dimensions of rightAddend.

addAssign

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

Assigns the elements of sum to the element-wise addition of leftAddend and rightAddend.

Parameters:

leftAddend - The first ComplexMatrix to sum.

rightAddend - The second ComplexMatrix to sum.

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

Throws:

ArgumentNullException - Thrown when leftAddend, rightAddend, or sum is null.

IllegalStateException - Thrown when the dimensions of sum do not match the dimensions of leftAddend or rightAddend.

add

@Nonnull
public final ComplexMatrix add(@Nonnull
                                         ComplexMatrix addend)

Creates a ComplexMatrix which is the sum of this matrix and the given matrix.

Parameters:

addend - The ComplexMatrix to add to this matrix.

Returns:

A ComplexMatrix which is the sum of this matrix and the given matrix.

Throws:

ArgumentNullException - Thrown when addend is null.

IllegalStateException - Thrown when the dimensions of addend do not match the dimensions of this ComplexMatrix.

subtract

public static ComplexMatrix subtract(ComplexMatrix minuend,
                                     ComplexMatrix subtrahend)

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

Parameters:

minuend - The ComplexMatrix being subtracted from.

subtrahend - The ComplexMatrix to subtract.

Returns:

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

Throws:

IllegalStateException - Thrown when the dimensions of minuend do not match the dimensions of subtrahend.

subtractAssign

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

Assigns the elements of difference to the element-wise subtraction of minuend by subtrahend.

Parameters:

minuend - The ComplexMatrix being subtracted from.

subtrahend - The ComplexMatrix to subtract.

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

Throws:

ArgumentNullException - Thrown when minuend, subtrahend, or difference is null.

IllegalStateException - Thrown when the dimensions of difference do not match the dimensions of minuend or subtrahend.

subtractFrom

@Nonnull
public final ComplexMatrix subtractFrom(@Nonnull
                                                  ComplexMatrix minuend)

Creates a ComplexMatrix whose elements have the values of the elements of this matrix subtracted by the elements of the given matrix.

Parameters:

minuend - The ComplexMatrix that will be subtracted by this matrix.

Returns:

A ComplexMatrix which is the subtraction of the given matrix and this matrix.

Throws:

ArgumentNullException - Thrown when minuend is null.

IllegalStateException - Thrown when the dimensions of minuend do not match the dimensions of this ComplexMatrix.

multiply

public static ComplexMatrix multiply(ComplexMatrix multiplicand,
                                     ComplexMatrix multiplier)

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

Parameters:

multiplicand - The first ComplexMatrix to multiply.

multiplier - The second ComplexMatrix to multiply.

Returns:

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

Throws:

IllegalStateException - Thrown when the column dimension of multiplicand does not match the row dimension of multiplier.

multiplyAssign

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

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

Parameters:

multiplicand - The first ComplexMatrix to multiply.

multiplier - The second ComplexMatrix to multiply.

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

Throws:

ArgumentNullException - Thrown when multiplicand, multiplier, or product is null.

IllegalStateException - Thrown when the row dimension of multiplier does not match the column dimension of multiplicand, or when the row dimension of product does not match the row dimension of multiplicand, or when the column dimension of product does not match the column dimension of multiplier.

elementMultiply

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

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

Parameters:

multiplicand - The first ComplexMatrix to multiply.

multiplier - The second ComplexMatrix to multiply.

Returns:

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

Throws:

IllegalStateException - Thrown when the dimensions of multiplicand do not match the dimensions of multiplier.

elementMultiply

@Nonnull
public final ComplexMatrix elementMultiply(@Nonnull
                                                     ComplexMatrix matrix)

Creates a ComplexMatrix which is the element-by-element multiplication of this matrix times the given matrix.

Parameters:

matrix - The ComplexMatrix to multiply with this matrix.

Returns:

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

Throws:

ArgumentNullException - Thrown when matrix is null.

IllegalStateException - Thrown when the dimensions of matrix do not match the dimensions of this ComplexMatrix.

elementMultiplyAssign

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

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

Parameters:

multiplicand - The first ComplexMatrix to multiply.

multiplier - The second ComplexMatrix to multiply.

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

Throws:

ArgumentNullException - Thrown when multiplicand, multiplier, or product is null.

IllegalStateException - Thrown when the dimensions of product do not match the dimensions of multiplicand or multiplier.

postMultiply

@Nonnull
public final ComplexMatrix postMultiply(@Nonnull
                                                  ComplexMatrix multiplier)

Creates a ComplexMatrix which is the linear algebra multiplication of this matrix times the given matrix.

Parameters:

multiplier - The ComplexMatrix to multiply this matrix by.

Returns:

A ComplexMatrix which is the multiplication of this matrix by the given matrix.

Throws:

ArgumentNullException - Thrown when multiplier is null.

IllegalStateException - Thrown when the row dimension of multiplier does not match the column dimension of this ComplexMatrix.

preMultiply

@Nonnull
public final ComplexMatrix preMultiply(@Nonnull
                                                 ComplexMatrix multiplicand)

Creates a ComplexMatrix which is the linear algebra multiplication of the given matrix times this matrix.

Parameters:

multiplicand - The ComplexMatrix to multiply by this matrix.

Returns:

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

Throws:

ArgumentNullException - Thrown when multiplicand is null.

IllegalStateException - Thrown when the column dimension of multiplicand does not match the row dimension of this ComplexMatrix.

multiply

@Nonnull
public final Complex[] multiply(@Nonnull
                                          Complex[] vector)

Returns the result of the multiplication of this matrix and a vector.

Parameters:

vector - The vector to be multiplied.

Returns:

The resultant vector.

Throws:

ArgumentNullException - Thrown when vector is null.

IllegalStateException - Thrown when the length of vector does not match the column dimension of this ComplexMatrix.

multiply

public static Complex[] multiply(ComplexMatrix matrix,
                                 Complex[] vector)

Returns the result of the multiplication of this matrix and a vector.

Parameters:

matrix - The matrix to be multiplies.

vector - The vector to be multiplied.

Returns:

The resultant vector.

elementDivide

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

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

Parameters:

dividend - The ComplexMatrix whose elements will form the numerators.

divisor - The ComplexMatrix whose elements will form the denominators.

Returns:

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

Throws:

IllegalStateException - Thrown when the dimensions of dividend do not match the dimensions of divisor.

elementDivideAssign

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

Assigns the elements of quotient to the element-wise division of dividend divided by divisor.

Parameters:

dividend - The ComplexMatrix whose elements will form the numerators.

divisor - The ComplexMatrix whose elements will form the denominators.

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

Throws:

ArgumentNullException - Thrown when dividend, divisor, or quotient is null.

IllegalStateException - Thrown when the dimensions of quotient do not match the dimensions of dividend or divisor.

getMatrix

@Nonnull
public final ComplexMatrix 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
                            ComplexMatrix destination)

Assigns 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 ComplexMatrix 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
                            ComplexMatrix destination)

Assigns 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 ComplexMatrix 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
                            ComplexMatrix 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 ComplexMatrix 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
                            ComplexMatrix destination)

Assigns 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.

inverse

public final ComplexMatrix inverse()

ComplexMatrix inverse.

Returns:

The complex matrix inverse.

Throws:

IllegalStateException - Thrown when this ComplexMatrix is not square. The inverse operation is currently only available for square matrices.

IllegalStateException - Thrown when the ComplexMatrix is singular.

identity

@Nonnull
public static ComplexMatrix identity(int rowDimension,
                                               int columnDimension)

Generates an identity matrix.

Parameters:

rowDimension - Number of rows.

columnDimension - Number of columns.

Returns:

A new ComplexMatrix with ones on the diagonal and zeros elsewhere.

transpose

@Nonnull
public final ComplexMatrix transpose()

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

Returns:

The new transposed matrix.

hermitianTranspose

@Nonnull
public final ComplexMatrix hermitianTranspose()

Creates a new ComplexMatrix which is the Hermitian or conjugate transpose of the current matrix.

Returns:

The new conjugate transposed matrix.