Class BlockFieldMatrix<T extends FieldElement<T>>
- java.lang.Object
-
- org.apache.commons.math4.legacy.linear.AbstractFieldMatrix<T>
-
- org.apache.commons.math4.legacy.linear.BlockFieldMatrix<T>
-
- Type Parameters:
T- the type of the field elements
- All Implemented Interfaces:
Serializable,AnyMatrix,FieldMatrix<T>
public class BlockFieldMatrix<T extends FieldElement<T>> extends AbstractFieldMatrix<T> implements Serializable
Cache-friendly implementation of FieldMatrix using a flat arrays to store square blocks of the matrix.This implementation is specially designed to be cache-friendly. Square blocks are stored as small arrays and allow efficient traversal of data both in row major direction and columns major direction, one block at a time. This greatly increases performances for algorithms that use crossed directions loops like multiplication or transposition.
The size of square blocks is a static parameter. It may be tuned according to the cache size of the target computer processor. As a rule of thumbs, it should be the largest value that allows three blocks to be simultaneously cached (this is necessary for example for matrix multiplication). The default value is to use 36x36 blocks.
The regular blocks represent
BLOCK_SIZExBLOCK_SIZEsquares. Blocks at right hand side and bottom side which may be smaller to fit matrix dimensions. The square blocks are flattened in row major order in single dimension arrays which are thereforeBLOCK_SIZE2 elements long for regular blocks. The blocks are themselves organized in row major order.As an example, for a block size of 36x36, a 100x60 matrix would be stored in 6 blocks. Block 0 would be a Field[1296] array holding the upper left 36x36 square, block 1 would be a Field[1296] array holding the upper center 36x36 square, block 2 would be a Field[1008] array holding the upper right 36x28 rectangle, block 3 would be a Field[864] array holding the lower left 24x36 rectangle, block 4 would be a Field[864] array holding the lower center 24x36 rectangle and block 5 would be a Field[672] array holding the lower right 24x28 rectangle.
The layout complexity overhead versus simple mapping of matrices to java arrays is negligible for small matrices (about 1%). The gain from cache efficiency leads to up to 3-fold improvements for matrices of moderate to large size.
- Since:
- 2.0
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static intBLOCK_SIZEBlock size.
-
Constructor Summary
Constructors Constructor Description BlockFieldMatrix(int rows, int columns, T[][] blockData, boolean copyArray)Create a new dense matrix copying entries from block layout data.BlockFieldMatrix(Field<T> field, int rows, int columns)Create a new matrix with the supplied row and column dimensions.BlockFieldMatrix(T[][] rawData)Create a new dense matrix copying entries from raw layout data.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BlockFieldMatrix<T>add(BlockFieldMatrix<T> m)Compute the sum ofthisandm.FieldMatrix<T>add(FieldMatrix<T> m)Compute the sum of this and m.voidaddToEntry(int row, int column, T increment)Change an entry in the specified row and column.FieldMatrix<T>copy()Make a (deep) copy of this.static <T extends FieldElement<T>>
T[][]createBlocksLayout(Field<T> field, int rows, int columns)Create a data array in blocks layout.FieldMatrix<T>createMatrix(int rowDimension, int columnDimension)Create a newFieldMatrix<T>of the same type as the instance with the supplied row and column dimensions.T[]getColumn(int column)Get the entries in column numbercolas an array.intgetColumnDimension()Gets the number of columns.FieldMatrix<T>getColumnMatrix(int column)Get the entries in column numbercolumnas a column matrix.FieldVector<T>getColumnVector(int column)Returns the entries in column numbercolumnas a vector.T[][]getData()Returns matrix entries as a two-dimensional array.TgetEntry(int row, int column)Returns the entry in the specified row and column.T[]getRow(int row)Get the entries in row numberrowas an array.intgetRowDimension()Gets the number of rows.FieldMatrix<T>getRowMatrix(int row)Get the entries in row numberrowas a row matrix.FieldVector<T>getRowVector(int row)Get the entries in row numberrowas a vector.FieldMatrix<T>getSubMatrix(int startRow, int endRow, int startColumn, int endColumn)Get a submatrix.BlockFieldMatrix<T>multiply(BlockFieldMatrix<T> m)Returns the result of postmultiplyingthisbym.FieldMatrix<T>multiply(FieldMatrix<T> m)Postmultiply this matrix bym.voidmultiplyEntry(int row, int column, T factor)Change an entry in the specified row and column.T[]operate(T[] v)Returns the result of multiplying this by the vectorv.T[]preMultiply(T[] v)Returns the (row) vector result of premultiplying this by the vectorv.FieldMatrix<T>scalarAdd(T d)Increment each entry of this matrix.FieldMatrix<T>scalarMultiply(T d)Multiply each entry byd.voidsetColumn(int column, T[] array)Set the entries in column numbercolumnas a column matrix.voidsetColumnMatrix(int column, FieldMatrix<T> matrix)Set the entries in column numbercolumnas a column matrix.voidsetColumnVector(int column, FieldVector<T> vector)Set the entries in column numbercolumnas a vector.voidsetEntry(int row, int column, T value)Set the entry in the specified row and column.voidsetRow(int row, T[] array)Set the entries in row numberrowas a row matrix.voidsetRowMatrix(int row, BlockFieldMatrix<T> matrix)Sets the entries in row numberrowas a row matrix.voidsetRowMatrix(int row, FieldMatrix<T> matrix)Set the entries in row numberrowas a row matrix.voidsetRowVector(int row, FieldVector<T> vector)Set the entries in row numberrowas a vector.voidsetSubMatrix(T[][] subMatrix, int row, int column)Replace the submatrix starting at(row, column)using data in the inputsubMatrixarray.BlockFieldMatrix<T>subtract(BlockFieldMatrix<T> m)Computethis - m.FieldMatrix<T>subtract(FieldMatrix<T> m)Subtractmfrom this matrix.static <T extends FieldElement<T>>
T[][]toBlocksLayout(T[][] rawData)Convert a data array from raw layout to blocks layout.FieldMatrix<T>transpose()Returns the transpose of this matrix.TwalkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor)Visit (and possibly change) all matrix entries using the fastest possible order.TwalkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn)Visit (and possibly change) some matrix entries using the fastest possible order.TwalkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor)Visit (but don't change) all matrix entries using the fastest possible order.TwalkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn)Visit (but don't change) some matrix entries using the fastest possible order.TwalkInRowOrder(FieldMatrixChangingVisitor<T> visitor)Visit (and possibly change) all matrix entries in row order.TwalkInRowOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn)Visit (and possibly change) some matrix entries in row order.TwalkInRowOrder(FieldMatrixPreservingVisitor<T> visitor)Visit (but don't change) all matrix entries in row order.TwalkInRowOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn)Visit (but don't change) some matrix entries in row order.-
Methods inherited from class org.apache.commons.math4.legacy.linear.AbstractFieldMatrix
checkColumnIndex, checkRowIndex, checkSubMatrixIndex, checkSubMatrixIndex, copySubMatrix, copySubMatrix, equals, extractField, extractField, getField, getSubMatrix, getTrace, hashCode, operate, power, preMultiply, preMultiply, toString, walkInColumnOrder, walkInColumnOrder, walkInColumnOrder, walkInColumnOrder
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.commons.math4.legacy.linear.AnyMatrix
canAdd, canMultiply, checkAdd, checkMultiply, isSquare
-
-
-
-
Field Detail
-
BLOCK_SIZE
public static final int BLOCK_SIZE
Block size.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BlockFieldMatrix
public BlockFieldMatrix(Field<T> field, int rows, int columns) throws NotStrictlyPositiveException
Create a new matrix with the supplied row and column dimensions.- Parameters:
field- Field to which the elements belong.rows- Number of rows in the new matrix.columns- Number of columns in the new matrix.- Throws:
NotStrictlyPositiveException- if row or column dimension is not positive.
-
BlockFieldMatrix
public BlockFieldMatrix(T[][] rawData) throws DimensionMismatchException
Create a new dense matrix copying entries from raw layout data.The input array must already be in raw layout.
Calling this constructor is equivalent to call:
matrix = new BlockFieldMatrix<T>(getField(), rawData.length, rawData[0].length, toBlocksLayout(rawData), false);- Parameters:
rawData- Data for the new matrix, in raw layout.- Throws:
DimensionMismatchException- if theblockDatashape is inconsistent with block layout.- See Also:
BlockFieldMatrix(int, int, FieldElement[][], boolean)
-
BlockFieldMatrix
public BlockFieldMatrix(int rows, int columns, T[][] blockData, boolean copyArray) throws DimensionMismatchException, NotStrictlyPositiveException
Create a new dense matrix copying entries from block layout data.The input array must already be in blocks layout.
- Parameters:
rows- the number of rows in the new matrixcolumns- the number of columns in the new matrixblockData- data for new matrixcopyArray- if true, the input array will be copied, otherwise it will be referenced- Throws:
DimensionMismatchException- if theblockDatashape is inconsistent with block layout.NotStrictlyPositiveException- if row or column dimension is not positive.- See Also:
createBlocksLayout(Field, int, int),toBlocksLayout(FieldElement[][]),BlockFieldMatrix(FieldElement[][])
-
-
Method Detail
-
toBlocksLayout
public static <T extends FieldElement<T>> T[][] toBlocksLayout(T[][] rawData) throws DimensionMismatchException
Convert a data array from raw layout to blocks layout.Raw layout is the straightforward layout where element at row i and column j is in array element
rawData[i][j]. Blocks layout is the layout used inBlockFieldMatrixinstances, where the matrix is split in square blocks (except at right and bottom side where blocks may be rectangular to fit matrix size) and each block is stored in a flattened one-dimensional array.This method creates an array in blocks layout from an input array in raw layout. It can be used to provide the array argument of the
BlockFieldMatrix(int, int, FieldElement[][], boolean)constructor.- Type Parameters:
T- Type of the field elements.- Parameters:
rawData- Data array in raw layout.- Returns:
- a new data array containing the same entries but in blocks layout
- Throws:
DimensionMismatchException- ifrawDatais not rectangular (not all rows have the same length).- See Also:
createBlocksLayout(Field, int, int),BlockFieldMatrix(int, int, FieldElement[][], boolean)
-
createBlocksLayout
public static <T extends FieldElement<T>> T[][] createBlocksLayout(Field<T> field, int rows, int columns)
Create a data array in blocks layout.This method can be used to create the array argument of the
BlockFieldMatrix(int, int, FieldElement[][], boolean)constructor.- Type Parameters:
T- Type of the field elements.- Parameters:
field- Field to which the elements belong.rows- Number of rows in the new matrix.columns- Number of columns in the new matrix.- Returns:
- a new data array in blocks layout.
- See Also:
toBlocksLayout(FieldElement[][]),BlockFieldMatrix(int, int, FieldElement[][], boolean)
-
createMatrix
public FieldMatrix<T> createMatrix(int rowDimension, int columnDimension) throws NotStrictlyPositiveException
Create a newFieldMatrix<T>of the same type as the instance with the supplied row and column dimensions.- Specified by:
createMatrixin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
createMatrixin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
rowDimension- the number of rows in the new matrixcolumnDimension- the number of columns in the new matrix- Returns:
- a new matrix of the same type as the instance
- Throws:
NotStrictlyPositiveException- if row or column dimension is not positive.
-
copy
public FieldMatrix<T> copy()
Make a (deep) copy of this.- Specified by:
copyin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
copyin classAbstractFieldMatrix<T extends FieldElement<T>>- Returns:
- a copy of this matrix.
-
add
public FieldMatrix<T> add(FieldMatrix<T> m) throws MatrixDimensionMismatchException
Compute the sum of this and m.- Specified by:
addin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
addin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
m- Matrix to be added.- Returns:
this+m.- Throws:
MatrixDimensionMismatchException- ifmis not the same size asthismatrix.
-
add
public BlockFieldMatrix<T> add(BlockFieldMatrix<T> m) throws MatrixDimensionMismatchException
Compute the sum ofthisandm.- Parameters:
m- matrix to be added- Returns:
this + m- Throws:
MatrixDimensionMismatchException- ifmis not the same size asthis
-
subtract
public FieldMatrix<T> subtract(FieldMatrix<T> m) throws MatrixDimensionMismatchException
Subtractmfrom this matrix.- Specified by:
subtractin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
subtractin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
m- Matrix to be subtracted.- Returns:
this-m.- Throws:
MatrixDimensionMismatchException- ifmis not the same size asthismatrix.
-
subtract
public BlockFieldMatrix<T> subtract(BlockFieldMatrix<T> m) throws MatrixDimensionMismatchException
Computethis - m.- Parameters:
m- matrix to be subtracted- Returns:
this - m- Throws:
MatrixDimensionMismatchException- ifmis not the same size asthis
-
scalarAdd
public FieldMatrix<T> scalarAdd(T d)
Increment each entry of this matrix.- Specified by:
scalarAddin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
scalarAddin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
d- Value to be added to each entry.- Returns:
d+this.
-
scalarMultiply
public FieldMatrix<T> scalarMultiply(T d)
Multiply each entry byd.- Specified by:
scalarMultiplyin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
scalarMultiplyin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
d- Value to multiply all entries by.- Returns:
d*this.
-
multiply
public FieldMatrix<T> multiply(FieldMatrix<T> m) throws DimensionMismatchException
Postmultiply this matrix bym.- Specified by:
multiplyin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
multiplyin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
m- Matrix to postmultiply by.- Returns:
this*m.- Throws:
DimensionMismatchException- if the number of columns ofthismatrix is not equal to the number of rows of matrixm.
-
multiply
public BlockFieldMatrix<T> multiply(BlockFieldMatrix<T> m) throws DimensionMismatchException
Returns the result of postmultiplyingthisbym.- Parameters:
m- matrix to postmultiply by- Returns:
this * m- Throws:
DimensionMismatchException- if the matrices are not compatible.
-
getData
public T[][] getData()
Returns matrix entries as a two-dimensional array.- Specified by:
getDatain interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
getDatain classAbstractFieldMatrix<T extends FieldElement<T>>- Returns:
- a 2-dimensional array of entries.
-
getSubMatrix
public FieldMatrix<T> getSubMatrix(int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException
Get a submatrix. Rows and columns are indicated counting from 0 to n - 1.- Specified by:
getSubMatrixin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
getSubMatrixin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
startRow- Initial row indexendRow- Final row index (inclusive)startColumn- Initial column indexendColumn- Final column index (inclusive)- Returns:
- the matrix containing the data of the specified rows and columns.
- Throws:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- isendRow < startRowofendColumn < startColumn.
-
setSubMatrix
public void setSubMatrix(T[][] subMatrix, int row, int column) throws DimensionMismatchException, OutOfRangeException, NoDataException, NullArgumentException
Replace the submatrix starting at(row, column)using data in the inputsubMatrixarray. Indexes are 0-based.Example:
Starting with1 2 3 4 5 6 7 8 9 0 1 2
andsubMatrix = {{3, 4} {5,6}}, invokingsetSubMatrix(subMatrix,1,1))will result in1 2 3 4 5 3 4 8 9 5 6 2
- Specified by:
setSubMatrixin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
setSubMatrixin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
subMatrix- Array containing the submatrix replacement data.row- Row coordinate of the top-left element to be replaced.column- Column coordinate of the top-left element to be replaced.- Throws:
DimensionMismatchException- ifsubMatrixis not rectangular (not all rows have the same length).OutOfRangeException- ifsubMatrixdoes not fit into this matrix from element in(row, column).NoDataException- if a row or column ofsubMatrixis empty.NullArgumentException- ifsubMatrixisnull.
-
getRowMatrix
public FieldMatrix<T> getRowMatrix(int row) throws OutOfRangeException
Get the entries in row numberrowas a row matrix.- Specified by:
getRowMatrixin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
getRowMatrixin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- Row to be fetched.- Returns:
- a row matrix.
- Throws:
OutOfRangeException- if the specified row index is invalid.
-
setRowMatrix
public void setRowMatrix(int row, FieldMatrix<T> matrix) throws MatrixDimensionMismatchException, OutOfRangeException
Set the entries in row numberrowas a row matrix.- Specified by:
setRowMatrixin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
setRowMatrixin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- Row to be set.matrix- Row matrix (must have one row and the same number of columns as the instance).- Throws:
MatrixDimensionMismatchException- if the matrix dimensions do not match one instance row.OutOfRangeException- if the specified row index is invalid.
-
setRowMatrix
public void setRowMatrix(int row, BlockFieldMatrix<T> matrix) throws MatrixDimensionMismatchException, OutOfRangeException
Sets the entries in row numberrowas a row matrix. Row indices start at 0.- Parameters:
row- the row to be setmatrix- row matrix (must have one row and the same number of columns as the instance)- Throws:
MatrixDimensionMismatchException- if the matrix dimensions do not match one instance row.OutOfRangeException- if the specified row index is invalid.
-
getColumnMatrix
public FieldMatrix<T> getColumnMatrix(int column) throws OutOfRangeException
Get the entries in column numbercolumnas a column matrix.- Specified by:
getColumnMatrixin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
getColumnMatrixin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
column- Column to be fetched.- Returns:
- a column matrix.
- Throws:
OutOfRangeException- if the specified column index is invalid.
-
setColumnMatrix
public void setColumnMatrix(int column, FieldMatrix<T> matrix) throws MatrixDimensionMismatchException, OutOfRangeException
Set the entries in column numbercolumnas a column matrix.- Specified by:
setColumnMatrixin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
setColumnMatrixin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
column- Column to be set.matrix- column matrix (must have one column and the same number of rows as the instance).- Throws:
MatrixDimensionMismatchException- if the matrix dimensions do not match one instance column.OutOfRangeException- if the specified column index is invalid.
-
getRowVector
public FieldVector<T> getRowVector(int row) throws OutOfRangeException
Get the entries in row numberrowas a vector.- Specified by:
getRowVectorin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
getRowVectorin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- Row to be fetched- Returns:
- a row vector.
- Throws:
OutOfRangeException- if the specified row index is invalid.
-
setRowVector
public void setRowVector(int row, FieldVector<T> vector) throws MatrixDimensionMismatchException, OutOfRangeException
Set the entries in row numberrowas a vector.- Specified by:
setRowVectorin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
setRowVectorin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- Row to be set.vector- row vector (must have the same number of columns as the instance).- Throws:
MatrixDimensionMismatchException- if the vector dimension does not match one instance row.OutOfRangeException- if the specified row index is invalid.
-
getColumnVector
public FieldVector<T> getColumnVector(int column) throws OutOfRangeException
Returns the entries in column numbercolumnas a vector.- Specified by:
getColumnVectorin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
getColumnVectorin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
column- Column to be fetched.- Returns:
- a column vector.
- Throws:
OutOfRangeException- if the specified column index is invalid.
-
setColumnVector
public void setColumnVector(int column, FieldVector<T> vector) throws OutOfRangeException, MatrixDimensionMismatchException
Set the entries in column numbercolumnas a vector.- Specified by:
setColumnVectorin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
setColumnVectorin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
column- Column to be set.vector- Column vector (must have the same number of rows as the instance).- Throws:
OutOfRangeException- if the specified column index is invalid.MatrixDimensionMismatchException- if the vector dimension does not match one instance column.
-
getRow
public T[] getRow(int row) throws OutOfRangeException
Get the entries in row numberrowas an array.- Specified by:
getRowin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
getRowin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- Row to be fetched.- Returns:
- array of entries in the row.
- Throws:
OutOfRangeException- if the specified row index is not valid.
-
setRow
public void setRow(int row, T[] array) throws OutOfRangeException, MatrixDimensionMismatchException
Set the entries in row numberrowas a row matrix.- Specified by:
setRowin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
setRowin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- Row to be set.array- Row matrix (must have the same number of columns as the instance).- Throws:
OutOfRangeException- if the specified row index is invalid.MatrixDimensionMismatchException- if the array size does not match one instance row.
-
getColumn
public T[] getColumn(int column) throws OutOfRangeException
Get the entries in column numbercolas an array.- Specified by:
getColumnin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
getColumnin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
column- the column to be fetched- Returns:
- array of entries in the column
- Throws:
OutOfRangeException- if the specified column index is not valid.
-
setColumn
public void setColumn(int column, T[] array) throws MatrixDimensionMismatchException, OutOfRangeException
Set the entries in column numbercolumnas a column matrix.- Specified by:
setColumnin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
setColumnin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
column- the column to be setarray- column array (must have the same number of rows as the instance)- Throws:
MatrixDimensionMismatchException- if the array size does not match one instance column.OutOfRangeException- if the specified column index is invalid.
-
getEntry
public T getEntry(int row, int column) throws OutOfRangeException
Returns the entry in the specified row and column.- Specified by:
getEntryin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
getEntryin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- row location of entry to be fetchedcolumn- column location of entry to be fetched- Returns:
- matrix entry in row,column
- Throws:
OutOfRangeException- if the row or column index is not valid.
-
setEntry
public void setEntry(int row, int column, T value) throws OutOfRangeException
Set the entry in the specified row and column.- Specified by:
setEntryin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
setEntryin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- row location of entry to be setcolumn- column location of entry to be setvalue- matrix entry to be set in row,column- Throws:
OutOfRangeException- if the row or column index is not valid.
-
addToEntry
public void addToEntry(int row, int column, T increment) throws OutOfRangeException
Change an entry in the specified row and column.- Specified by:
addToEntryin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
addToEntryin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- Row location of entry to be set.column- Column location of entry to be set.increment- Value to add to the current matrix entry in(row, column).- Throws:
OutOfRangeException- if the row or column index is not valid.
-
multiplyEntry
public void multiplyEntry(int row, int column, T factor) throws OutOfRangeException
Change an entry in the specified row and column.- Specified by:
multiplyEntryin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
multiplyEntryin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- Row location of entry to be set.column- Column location of entry to be set.factor- Multiplication factor for the current matrix entry in(row,column)- Throws:
OutOfRangeException- if the row or column index is not valid.
-
transpose
public FieldMatrix<T> transpose()
Returns the transpose of this matrix.- Specified by:
transposein interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
transposein classAbstractFieldMatrix<T extends FieldElement<T>>- Returns:
- transpose matrix
-
getRowDimension
public int getRowDimension()
Gets the number of rows.- Specified by:
getRowDimensionin interfaceAnyMatrix- Returns:
- the number of rows.
-
getColumnDimension
public int getColumnDimension()
Gets the number of columns.- Specified by:
getColumnDimensionin interfaceAnyMatrix- Returns:
- the number of columns.
-
operate
public T[] operate(T[] v) throws DimensionMismatchException
Returns the result of multiplying this by the vectorv.- Specified by:
operatein interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
operatein classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
v- the vector to operate on- Returns:
this * v- Throws:
DimensionMismatchException- if the number of columns ofthismatrix is not equal to the size of the vectorv.
-
preMultiply
public T[] preMultiply(T[] v) throws DimensionMismatchException
Returns the (row) vector result of premultiplying this by the vectorv.- Specified by:
preMultiplyin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
preMultiplyin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
v- the row vector to premultiply by- Returns:
v * this- Throws:
DimensionMismatchException- if the number of rows ofthismatrix is not equal to the size of the vectorv
-
walkInRowOrder
public T walkInRowOrder(FieldMatrixChangingVisitor<T> visitor)
Visit (and possibly change) all matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Specified by:
walkInRowOrderin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInRowOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()at the end of the walk - See Also:
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInRowOrder
public T walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor)
Visit (but don't change) all matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Specified by:
walkInRowOrderin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInRowOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()at the end of the walk - See Also:
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInRowOrder
public T walkInRowOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException
Visit (and possibly change) some matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Specified by:
walkInRowOrderin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInRowOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
visitor- visitor used to process all matrix entriesstartRow- Initial row indexendRow- Final row index (inclusive)startColumn- Initial column indexendColumn- Final column index- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()at the end of the walk - Throws:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInRowOrder
public T walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException
Visit (but don't change) some matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Specified by:
walkInRowOrderin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInRowOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
visitor- visitor used to process all matrix entriesstartRow- Initial row indexendRow- Final row index (inclusive)startColumn- Initial column indexendColumn- Final column index- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()at the end of the walk - Throws:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInOptimizedOrder
public T walkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor)
Visit (and possibly change) all matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Specified by:
walkInOptimizedOrderin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInOptimizedOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()at the end of the walk - See Also:
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInOptimizedOrder
public T walkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor)
Visit (but don't change) all matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Specified by:
walkInOptimizedOrderin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInOptimizedOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()at the end of the walk - See Also:
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInOptimizedOrder
public T walkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException
Visit (and possibly change) some matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Specified by:
walkInOptimizedOrderin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInOptimizedOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
visitor- visitor used to process all matrix entriesstartRow- Initial row indexendRow- Final row index (inclusive)startColumn- Initial column indexendColumn- Final column index (inclusive)- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()at the end of the walk - Throws:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInOptimizedOrder
public T walkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException
Visit (but don't change) some matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Specified by:
walkInOptimizedOrderin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInOptimizedOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
visitor- visitor used to process all matrix entriesstartRow- Initial row indexendRow- Final row index (inclusive)startColumn- Initial column indexendColumn- Final column index (inclusive)- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()at the end of the walk - Throws:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int),FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor),FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
-
-