Package org.flag4j.operations

Class MatrixMultiplyDispatcher

java.lang.Object

org.flag4j.operations.MatrixMultiplyDispatcher

public final class MatrixMultiplyDispatcher
extends Object

Dispatches matrix multiplication to the appropriate algorithm based on the size of the matrices to be multiplied.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	MatrixMultiplyDispatcher.AlgorithmName	Simple enum class containing all possible choices of matrix multiply algorithms.

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	CONCURRENT_SWAPPED_THRESHOLD	Threshold for matrices to use the concurrent ikj algorithm.
private static final int	SEQUENTIAL_SWAPPED_THRESHOLD	Threshold for small matrices which should be multiplied using the standard ikj algorithm.
private static final double	SQUARENESS_RATIO	Ration measuring squareness.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MatrixMultiplyDispatcher()

Method Summary

Modifier and Type	Method	Description
static MatrixMultiplyDispatcher.AlgorithmName	chooseAlgorithmComplex(Shape shape1, Shape shape2)	Dynamically chooses matrix multiply algorithm based on the shapes of the two matrices to multiply.
static MatrixMultiplyDispatcher.AlgorithmName	chooseAlgorithmComplexTranspose(Shape shape)	Dynamically chooses the matrix multiplication-transpose algorithm to used based on the shape of the first matrix.
static MatrixMultiplyDispatcher.AlgorithmName	chooseAlgorithmComplexVector(Shape shape)	Dynamically chooses matrix-vector multiply algorithm based on the shapes of the matrix to multiply.
static MatrixMultiplyDispatcher.AlgorithmName	chooseAlgorithmRealComplex(Shape shape1, Shape shape2)	Dynamically chooses matrix multiply algorithm based on the shapes of the two matrices to multiply.
static MatrixMultiplyDispatcher.AlgorithmName	chooseAlgorithmRealComplexTranspose(Shape shape)	Dynamically chooses the matrix multiplication-transpose algorithm to used based on the shape of the first matrix.
static MatrixMultiplyDispatcher.AlgorithmName	chooseAlgorithmRealComplexVector(Shape shape)	Dynamically chooses matrix-vector multiply algorithm based on the shapes of the matrix to multiply.
static MatrixMultiplyDispatcher.AlgorithmName	chooseAlgorithmRealVector(Shape shape)	Dynamically chooses matrix-vector multiply algorithm based on the shapes of the matrix to multiply.
static CNumber[]	dispatch(CMatrix A, CMatrix B)	Dispatches a matrix multiplication problem to the appropriate algorithm based on the size.
static CNumber[]	dispatch(CMatrix A, CVector b)	Dynamically chooses the appropriate matrix-vector multiplication algorithm based on the shapes of the matrix and vector.
static CNumber[]	dispatch(CMatrix A, Matrix B)	Dispatches a matrix multiplication problem to the appropriate algorithm based on the size.
static CNumber[]	dispatch(CMatrix A, Vector b)	Dynamically chooses the appropriate matrix-vector multiplication algorithm based on the shapes of the matrix and vector.
static CNumber[]	dispatch(Matrix A, CMatrix B)	Dispatches a matrix multiplication problem to the appropriate algorithm based on the size.
static CNumber[]	dispatch(Matrix A, CVector b)	Dynamically chooses the appropriate matrix-vector multiplication algorithm based on the shapes of the matrix and vector.
static double[]	dispatch(Matrix A, Vector b)	Dynamically chooses the appropriate matrix-vector multiplication algorithm based on the shapes of the matrix and vector.
static CNumber[]	dispatch(CNumber[] src1, Shape shape1, CNumber[] src2, Shape shape2)	Dispatches a matrix multiplication problem to the appropriate algorithm based on the size.
static CNumber[]	dispatchTranspose(CMatrix A, CMatrix B)	Dispatches a matrix multiplication-transpose problem to the appropriate algorithm based on the size.
static CNumber[]	dispatchTranspose(CMatrix A, Matrix B)	Dispatches a matrix multiplication-transpose problem to the appropriate algorithm based on the size.
static CNumber[]	dispatchTranspose(Matrix A, CMatrix B)	Dispatches a matrix multiplication-transpose problem to the appropriate algorithm based on the size.
private static double	getRatio(Shape shape)	Computes the squareness ratio of a matrix.

Methods inherited from class java.lang.Object

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

Field Details

SQUARENESS_RATIO

private static final double SQUARENESS_RATIO

Ration measuring squareness. the closer to one, the more square the matrix is.

See Also:

• Constant Field Values

SEQUENTIAL_SWAPPED_THRESHOLD

private static final int SEQUENTIAL_SWAPPED_THRESHOLD

Threshold for small matrices which should be multiplied using the standard ikj algorithm.

See Also:

• Constant Field Values

CONCURRENT_SWAPPED_THRESHOLD

private static final int CONCURRENT_SWAPPED_THRESHOLD

Threshold for matrices to use the concurrent ikj algorithm.

See Also:

• Constant Field Values

Constructor Details

MatrixMultiplyDispatcher

private MatrixMultiplyDispatcher()

Method Details

dispatch

public static double[] dispatch(Matrix A,
 Vector b)

Dynamically chooses the appropriate matrix-vector multiplication algorithm based on the shapes of the matrix and vector.

Parameters:

A - Matrix to multiply.

b - Vector to multiply.

Returns:

The result of the matrix-vector multiplication.

dispatch

public static CNumber[] dispatch(Matrix A,
 CVector b)

Dynamically chooses the appropriate matrix-vector multiplication algorithm based on the shapes of the matrix and vector.

Parameters:

A - Matrix to multiply.

b - Vector to multiply.

Returns:

The result of the matrix-vector multiplication.

dispatch

public static CNumber[] dispatch(CMatrix A,
 Vector b)

Dynamically chooses the appropriate matrix-vector multiplication algorithm based on the shapes of the matrix and vector.

Parameters:

A - Matrix to multiply.

b - Vector to multiply.

Returns:

The result of the matrix-vector multiplication.

dispatch

public static CNumber[] dispatch(CMatrix A,
 CVector b)

Dynamically chooses the appropriate matrix-vector multiplication algorithm based on the shapes of the matrix and vector.

Parameters:

A - Matrix to multiply.

b - Vector to multiply.

Returns:

The result of the matrix-vector multiplication.

dispatch

public static CNumber[] dispatch(CMatrix A,
 CMatrix B)

Dispatches a matrix multiplication problem to the appropriate algorithm based on the size.

Parameters:

A - First matrix in matrix multiplication.

B - Second matrix in matrix multiplication.

Returns:

The result of the matrix multiplication.

Throws:

IllegalArgumentException - If the shapes of the two matrices are not conducive to matrix multiplication.

dispatch

public static CNumber[] dispatch(CNumber[] src1,
 Shape shape1,
 CNumber[] src2,
 Shape shape2)

Dispatches a matrix multiplication problem to the appropriate algorithm based on the size.

Parameters:

src1 - Entries of the first matrix.

shape1 - Shape of the first matrix.

src2 - Entries of the second matrix.

shape2 - Shape of the second matrix.

Returns:

The result of the matrix multiplication between the two matrices.

dispatch

public static CNumber[] dispatch(Matrix A,
 CMatrix B)

Dispatches a matrix multiplication problem to the appropriate algorithm based on the size.

Parameters:

A - First matrix in matrix multiplication.

B - Second matrix in matrix multiplication.

Returns:

The result of the matrix multiplication.

Throws:

IllegalArgumentException - If the shapes of the two matrices are not conducive to matrix multiplication.

dispatch

public static CNumber[] dispatch(CMatrix A,
 Matrix B)

Dispatches a matrix multiplication problem to the appropriate algorithm based on the size.

Parameters:

A - First matrix in matrix multiplication.

B - Second matrix in matrix multiplication.

Returns:

The result of the matrix multiplication.

Throws:

IllegalArgumentException - If the shapes of the two matrices are not conducive to matrix multiplication.

dispatchTranspose

public static CNumber[] dispatchTranspose(CMatrix A,
 Matrix B)

Dispatches a matrix multiplication-transpose problem to the appropriate algorithm based on the size.

Parameters:

A - First matrix in matrix multiplication.

B - Second matrix in matrix multiplication and the matrix to transpose.

Returns:

The result of the matrix multiplication-transpose.

Throws:

IllegalArgumentException - If the shapes of the two matrices are not conducive to matrix multiplication-transpose.

dispatchTranspose

public static CNumber[] dispatchTranspose(Matrix A,
 CMatrix B)

Dispatches a matrix multiplication-transpose problem to the appropriate algorithm based on the size.

Parameters:

A - First matrix in matrix multiplication.

B - Second matrix in matrix multiplication and the matrix to transpose.

Returns:

The result of the matrix multiplication-transpose.

Throws:

IllegalArgumentException - If the shapes of the two matrices are not conducive to matrix multiplication-transpose.

dispatchTranspose

public static CNumber[] dispatchTranspose(CMatrix A,
 CMatrix B)

Dispatches a matrix multiplication-transpose problem to the appropriate algorithm based on the size.

Parameters:

A - First matrix in matrix multiplication.

B - Second matrix in matrix multiplication and the matrix to transpose.

Returns:

The result of the matrix multiplication-transpose.

Throws:

IllegalArgumentException - If the shapes of the two matrices are not conducive to matrix multiplication-transpose.

chooseAlgorithmRealComplexTranspose

public static MatrixMultiplyDispatcher.AlgorithmName chooseAlgorithmRealComplexTranspose(Shape shape)

Dynamically chooses the matrix multiplication-transpose algorithm to used based on the shape of the first matrix.

Parameters:

shape - Shape of the first matrix.

chooseAlgorithmComplexTranspose

public static MatrixMultiplyDispatcher.AlgorithmName chooseAlgorithmComplexTranspose(Shape shape)

Dynamically chooses the matrix multiplication-transpose algorithm to used based on the shape of the first matrix.

Parameters:

shape - Shape of the first matrix.

chooseAlgorithmRealVector

public static MatrixMultiplyDispatcher.AlgorithmName chooseAlgorithmRealVector(Shape shape)

Dynamically chooses matrix-vector multiply algorithm based on the shapes of the matrix to multiply.

Parameters:

shape - The shape of the matrix.

Returns:

The algorithm to use in the matrix multiplication.

chooseAlgorithmComplex

public static MatrixMultiplyDispatcher.AlgorithmName chooseAlgorithmComplex(Shape shape1,
 Shape shape2)

Dynamically chooses matrix multiply algorithm based on the shapes of the two matrices to multiply.

Parameters:

shape1 - The shape of the first matrix.

shape2 - The shape fo the second matrix.

Returns:

The algorithm to use in the matrix multiplication.

chooseAlgorithmComplexVector

public static MatrixMultiplyDispatcher.AlgorithmName chooseAlgorithmComplexVector(Shape shape)

Dynamically chooses matrix-vector multiply algorithm based on the shapes of the matrix to multiply.

Parameters:

shape - The shape of the matrix.

Returns:

The algorithm to use in the matrix multiplication.

chooseAlgorithmRealComplex

public static MatrixMultiplyDispatcher.AlgorithmName chooseAlgorithmRealComplex(Shape shape1,
 Shape shape2)

Dynamically chooses matrix multiply algorithm based on the shapes of the two matrices to multiply.

Parameters:

shape1 - The shape of the first matrix.

shape2 - The shape fo the second matrix.

Returns:

The algorithm to use in the matrix multiplication.

chooseAlgorithmRealComplexVector

public static MatrixMultiplyDispatcher.AlgorithmName chooseAlgorithmRealComplexVector(Shape shape)

Dynamically chooses matrix-vector multiply algorithm based on the shapes of the matrix to multiply.

Parameters:

shape - The shape of the matrix.

Returns:

The algorithm to use in the matrix multiplication.

getRatio

private static double getRatio(Shape shape)

Computes the squareness ratio of a matrix. This is a value between 0 and 1 with 1 being perfectly square and 0 being a row/column vector.

Parameters:

shape - Shape of the matrix to compute the squareness ratio of.

Returns:

The squareness ratio for the specified shape.