Class BlockFieldMatrix<T extends FieldElement<T>>
- Type Parameters:
T
- the type of the field elements
- All Implemented Interfaces:
Serializable
,AnyMatrix
,FieldMatrix<T>
,FieldBlendable<FieldMatrix<T>,
T>
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_SIZE
x BLOCK_SIZE
squares. 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 therefore
BLOCK_SIZE
2 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.
- See Also:
-
Field Summary
-
Constructor Summary
ConstructorDescriptionBlockFieldMatrix
(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
Modifier and TypeMethodDescriptionadd
(BlockFieldMatrix<T> m) Compute the sum ofthis
andm
.add
(FieldMatrix<T> m) Compute the sum of this and m.void
addToEntry
(int row, int column, T increment) Change an entry in the specified row and column.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.createMatrix
(int rowDimension, int columnDimension) Create a newFieldMatrix
of the same type as the instance with the supplied row and column dimensions.T[]
getColumn
(int column) Get the entries in column numbercol
as an array.int
Returns the number of columns in the matrix.getColumnMatrix
(int column) Get the entries in column numbercolumn
as a column matrix.getColumnVector
(int column) Returns the entries in column numbercolumn
as a vector.T[][]
getData()
Returns matrix entries as a two-dimensional array.getEntry
(int row, int column) Returns the entry in the specified row and column.T[]
getRow
(int row) Get the entries in row numberrow
as an array.int
Returns the number of rows in the matrix.getRowMatrix
(int row) Get the entries in row numberrow
as a row matrix.getRowVector
(int row) Get the entries in row numberrow
as a vector.getSubMatrix
(int startRow, int endRow, int startColumn, int endColumn) Get a submatrix.Returns the result of postmultiplyingthis
bym
.multiply
(FieldMatrix<T> m) Postmultiply this matrix bym
.void
multiplyEntry
(int row, int column, T factor) Change an entry in the specified row and column.Returns the result of postmultiplyingthis
bym^T
.Returns the result of postmultiplyingthis
bym^T
.T[]
Returns the result of multiplying this by the vectorv
.T[]
preMultiply
(T[] v) Returns the (row) vector result of premultiplying this by the vectorv
.Increment each entry of this matrix.scalarMultiply
(T d) Multiply each entry byd
.void
Set the entries in column numbercolumn
as a column matrix.void
setColumnMatrix
(int column, FieldMatrix<T> matrix) Set the entries in column numbercolumn
as a column matrix.void
setColumnVector
(int column, FieldVector<T> vector) Set the entries in column numbercolumn
as a vector.void
Set the entry in the specified row and column.void
Set the entries in row numberrow
as a row matrix.void
setRowMatrix
(int row, BlockFieldMatrix<T> matrix) Sets the entries in row numberrow
as a row matrix.void
setRowMatrix
(int row, FieldMatrix<T> matrix) Set the entries in row numberrow
as a row matrix.void
setRowVector
(int row, FieldVector<T> vector) Set the entries in row numberrow
as a vector.void
setSubMatrix
(T[][] subMatrix, int row, int column) Replace the submatrix starting at(row, column)
using data in the inputsubMatrix
array.Computethis - m
.subtract
(FieldMatrix<T> m) Subtractm
from this matrix.static <T extends FieldElement<T>>
T[][]toBlocksLayout
(T[][] rawData) Convert a data array from raw layout to blocks layout.Returns the transpose of this matrix.Returns the result of postmultiplyingthis^T
bym
.Returns the result of postmultiplyingthis^T
bym
.walkInOptimizedOrder
(FieldMatrixChangingVisitor<T> visitor) Visit (and possibly change) all matrix entries using the fastest possible order.walkInOptimizedOrder
(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (and possibly change) some matrix entries using the fastest possible order.Visit (but don't change) all matrix entries using the fastest possible order.walkInOptimizedOrder
(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (but don't change) some matrix entries using the fastest possible order.walkInRowOrder
(FieldMatrixChangingVisitor<T> visitor) Visit (and possibly change) all matrix entries in row order.walkInRowOrder
(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (and possibly change) some matrix entries in row order.walkInRowOrder
(FieldMatrixPreservingVisitor<T> visitor) Visit (but don't change) all matrix entries in row order.walkInRowOrder
(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.hipparchus.linear.AbstractFieldMatrix
checkAdditionCompatible, checkColumnIndex, checkMultiplicationCompatible, checkRowIndex, checkSubMatrixIndex, checkSubMatrixIndex, checkSubtractionCompatible, copySubMatrix, copySubMatrix, equals, extractField, extractField, getField, getSubMatrix, getTrace, hashCode, isSquare, 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.hipparchus.linear.FieldMatrix
blendArithmeticallyWith, map, mapToSelf
-
Field Details
-
BLOCK_SIZE
public static final int BLOCK_SIZEBlock size.- See Also:
-
-
Constructor Details
-
BlockFieldMatrix
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:
MathIllegalArgumentException
- if row or column dimension is not positive.
-
BlockFieldMatrix
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:
MathIllegalArgumentException
- if theblockData
shape is inconsistent with block layout.- See Also:
-
BlockFieldMatrix
public BlockFieldMatrix(int rows, int columns, T[][] blockData, boolean copyArray) throws MathIllegalArgumentException 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:
MathIllegalArgumentException
- if theblockData
shape is inconsistent with block layout.MathIllegalArgumentException
- if row or column dimension is not positive.- See Also:
-
-
Method Details
-
toBlocksLayout
public static <T extends FieldElement<T>> T[][] toBlocksLayout(T[][] rawData) throws MathIllegalArgumentException 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 inBlockFieldMatrix
instances, 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:
MathIllegalArgumentException
- ifrawData
is not rectangular (not all rows have the same length).- See Also:
-
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:
-
createMatrix
public FieldMatrix<T> createMatrix(int rowDimension, int columnDimension) throws MathIllegalArgumentException Create a newFieldMatrix
of the same type as the instance with the supplied row and column dimensions.- Specified by:
createMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Specified by:
createMatrix
in 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:
MathIllegalArgumentException
- if row or column dimension is not positive.
-
copy
Make a (deep) copy of this.- Specified by:
copy
in interfaceFieldMatrix<T extends FieldElement<T>>
- Specified by:
copy
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Returns:
- a copy of this matrix.
-
add
Compute the sum of this and m.- Specified by:
add
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
add
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
m
- Matrix to be added.- Returns:
this
+m
.- Throws:
MathIllegalArgumentException
- ifm
is not the same size asthis
matrix.
-
add
Compute the sum ofthis
andm
.- Parameters:
m
- matrix to be added- Returns:
this + m
- Throws:
MathIllegalArgumentException
- ifm
is not the same size asthis
-
subtract
Subtractm
from this matrix.- Specified by:
subtract
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
subtract
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
m
- Matrix to be subtracted.- Returns:
this
-m
.- Throws:
MathIllegalArgumentException
- ifm
is not the same size asthis
matrix.
-
subtract
Computethis - m
.- Parameters:
m
- matrix to be subtracted- Returns:
this - m
- Throws:
MathIllegalArgumentException
- ifm
is not the same size asthis
-
scalarAdd
Increment each entry of this matrix.- Specified by:
scalarAdd
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
scalarAdd
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
d
- Value to be added to each entry.- Returns:
d
+this
.
-
scalarMultiply
Multiply each entry byd
.- Specified by:
scalarMultiply
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
scalarMultiply
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
d
- Value to multiply all entries by.- Returns:
d
*this
.
-
multiply
Postmultiply this matrix bym
.- Specified by:
multiply
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
multiply
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
m
- Matrix to postmultiply by.- Returns:
this
*m
.- Throws:
MathIllegalArgumentException
- if the number of columns ofthis
matrix is not equal to the number of rows of matrixm
.
-
multiply
Returns the result of postmultiplyingthis
bym
.- Parameters:
m
- matrix to postmultiply by- Returns:
this * m
- Throws:
MathIllegalArgumentException
- if the matrices are not compatible.
-
multiplyTransposed
public BlockFieldMatrix<T> multiplyTransposed(BlockFieldMatrix<T> m) throws MathIllegalArgumentException Returns the result of postmultiplyingthis
bym^T
.- Parameters:
m
- matrix to first transpose and second postmultiply by- Returns:
this * m
- Throws:
MathIllegalArgumentException
- ifcolumnDimension(this) != columnDimension(m)
- Since:
- 1.3
-
multiplyTransposed
Returns the result of postmultiplyingthis
bym^T
.This is equivalent to call
multiply
(m.FieldMatrix.transpose()
), but some implementations may avoid building the intermediate transposed matrix.- Specified by:
multiplyTransposed
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
m
- matrix to first transpose and second postmultiply by- Returns:
this * m^T
- Throws:
MathIllegalArgumentException
- ifcolumnDimension(this) != columnDimension(m)
-
transposeMultiply
public BlockFieldMatrix<T> transposeMultiply(BlockFieldMatrix<T> m) throws MathIllegalArgumentException Returns the result of postmultiplyingthis^T
bym
.- Parameters:
m
- matrix to postmultiply by- Returns:
this^T * m
- Throws:
MathIllegalArgumentException
- ifcolumnDimension(this) != columnDimension(m)
- Since:
- 1.3
-
transposeMultiply
Returns the result of postmultiplyingthis^T
bym
.This is equivalent to call
FieldMatrix.transpose()
.multiply(m)
, but some implementations may avoid building the intermediate transposed matrix.- Specified by:
transposeMultiply
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
m
- matrix to postmultiply by- Returns:
this^T * m
- Throws:
MathIllegalArgumentException
- ifcolumnDimension(this) != columnDimension(m)
-
getData
Returns matrix entries as a two-dimensional array.- Specified by:
getData
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
getData
in 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 MathIllegalArgumentException Get a submatrix. Rows and columns are indicated counting from 0 to n - 1.- Specified by:
getSubMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
getSubMatrix
in 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:
MathIllegalArgumentException
- isendRow < startRow
ofendColumn < startColumn
.
-
setSubMatrix
public void setSubMatrix(T[][] subMatrix, int row, int column) throws MathIllegalArgumentException, NullArgumentException Replace the submatrix starting at(row, column)
using data in the inputsubMatrix
array. Indexes are 0-based.Example:
Starting with1 2 3 4 5 6 7 8 9 0 1 2
and
subMatrix = {{3, 4} {5,6}}
, invokingsetSubMatrix(subMatrix,1,1))
will result in1 2 3 4 5 3 4 8 9 5 6 2
- Specified by:
setSubMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
setSubMatrix
in 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:
MathIllegalArgumentException
- ifsubMatrix
does not fit into this matrix from element in(row, column)
.NullArgumentException
- ifsubMatrix
isnull
.
-
getRowMatrix
Get the entries in row numberrow
as a row matrix.- Specified by:
getRowMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
getRowMatrix
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
row
- Row to be fetched.- Returns:
- a row matrix.
- Throws:
MathIllegalArgumentException
- if the specified row index is invalid.
-
setRowMatrix
Set the entries in row numberrow
as a row matrix.- Specified by:
setRowMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
setRowMatrix
in 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:
MathIllegalArgumentException
- if the specified row index is invalid.
-
setRowMatrix
Sets the entries in row numberrow
as 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:
MathIllegalArgumentException
- if the matrix dimensions do not match one instance row.MathIllegalArgumentException
- if the specified row index is invalid.
-
getColumnMatrix
Get the entries in column numbercolumn
as a column matrix.- Specified by:
getColumnMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
getColumnMatrix
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
column
- Column to be fetched.- Returns:
- a column matrix.
- Throws:
MathIllegalArgumentException
- if the specified column index is invalid.
-
setColumnMatrix
Set the entries in column numbercolumn
as a column matrix.- Specified by:
setColumnMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
setColumnMatrix
in 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:
MathIllegalArgumentException
- if the specified column index is invalid.
-
getRowVector
Get the entries in row numberrow
as a vector.- Specified by:
getRowVector
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
getRowVector
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
row
- Row to be fetched- Returns:
- a row vector.
- Throws:
MathIllegalArgumentException
- if the specified row index is invalid.
-
setRowVector
Set the entries in row numberrow
as a vector.- Specified by:
setRowVector
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
setRowVector
in 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:
MathIllegalArgumentException
- if the specified row index is invalid.
-
getColumnVector
Returns the entries in column numbercolumn
as a vector.- Specified by:
getColumnVector
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
getColumnVector
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
column
- Column to be fetched.- Returns:
- a column vector.
- Throws:
MathIllegalArgumentException
- if the specified column index is invalid.
-
setColumnVector
Set the entries in column numbercolumn
as a vector.- Specified by:
setColumnVector
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
setColumnVector
in 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:
MathIllegalArgumentException
- if the specified column index is invalid.
-
getRow
Get the entries in row numberrow
as an array.- Specified by:
getRow
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
getRow
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
row
- Row to be fetched.- Returns:
- array of entries in the row.
- Throws:
MathIllegalArgumentException
- if the specified row index is not valid.
-
setRow
Set the entries in row numberrow
as a row matrix.- Specified by:
setRow
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
setRow
in 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:
MathIllegalArgumentException
- if the specified row index is invalid.
-
getColumn
Get the entries in column numbercol
as an array.- Specified by:
getColumn
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
getColumn
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
column
- the column to be fetched- Returns:
- array of entries in the column
- Throws:
MathIllegalArgumentException
- if the specified column index is not valid.
-
setColumn
Set the entries in column numbercolumn
as a column matrix.- Specified by:
setColumn
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
setColumn
in 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:
MathIllegalArgumentException
- if the specified column index is invalid.
-
getEntry
Returns the entry in the specified row and column.- Specified by:
getEntry
in interfaceFieldMatrix<T extends FieldElement<T>>
- Specified by:
getEntry
in 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:
MathIllegalArgumentException
- if the row or column index is not valid.
-
setEntry
Set the entry in the specified row and column.- Specified by:
setEntry
in interfaceFieldMatrix<T extends FieldElement<T>>
- Specified by:
setEntry
in 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:
MathIllegalArgumentException
- if the row or column index is not valid.
-
addToEntry
Change an entry in the specified row and column.- Specified by:
addToEntry
in interfaceFieldMatrix<T extends FieldElement<T>>
- Specified by:
addToEntry
in 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:
MathIllegalArgumentException
- if the row or column index is not valid.
-
multiplyEntry
Change an entry in the specified row and column.- Specified by:
multiplyEntry
in interfaceFieldMatrix<T extends FieldElement<T>>
- Specified by:
multiplyEntry
in 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:
MathIllegalArgumentException
- if the row or column index is not valid.
-
transpose
Returns the transpose of this matrix.- Specified by:
transpose
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
transpose
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Returns:
- transpose matrix
-
getRowDimension
public int getRowDimension()Returns the number of rows in the matrix.- Specified by:
getRowDimension
in interfaceAnyMatrix
- Specified by:
getRowDimension
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Returns:
- rowDimension
-
getColumnDimension
public int getColumnDimension()Returns the number of columns in the matrix.- Specified by:
getColumnDimension
in interfaceAnyMatrix
- Specified by:
getColumnDimension
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Returns:
- columnDimension
-
operate
Returns the result of multiplying this by the vectorv
.- Specified by:
operate
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
operate
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
v
- the vector to operate on- Returns:
this * v
- Throws:
MathIllegalArgumentException
- if the number of columns ofthis
matrix is not equal to the size of the vectorv
.
-
preMultiply
Returns the (row) vector result of premultiplying this by the vectorv
.- Specified by:
preMultiply
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
preMultiply
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Parameters:
v
- the row vector to premultiply by- Returns:
v * this
- Throws:
MathIllegalArgumentException
- if the number of rows ofthis
matrix is not equal to the size of the vectorv
-
walkInRowOrder
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:
walkInRowOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
walkInRowOrder
in 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
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:
walkInRowOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
walkInRowOrder
in 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 MathIllegalArgumentException 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:
walkInRowOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
walkInRowOrder
in 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:
MathIllegalArgumentException
- if the indices are not valid.- 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 MathIllegalArgumentException 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:
walkInRowOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
walkInRowOrder
in 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:
MathIllegalArgumentException
- if the indices are not valid.- 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
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:
walkInOptimizedOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
walkInOptimizedOrder
in 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
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:
walkInOptimizedOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
walkInOptimizedOrder
in 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 MathIllegalArgumentException 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:
walkInOptimizedOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
walkInOptimizedOrder
in 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:
MathIllegalArgumentException
- ifendRow < startRow
orendColumn < 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 MathIllegalArgumentException 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:
walkInOptimizedOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Overrides:
walkInOptimizedOrder
in 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:
MathIllegalArgumentException
- ifendRow < startRow
orendColumn < 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)
-