T
- the type of the field elementsSerializable
, AnyMatrix
, FieldMatrix<T>
public class BlockFieldMatrix<T extends FieldElement<T>> extends AbstractFieldMatrix<T> implements Serializable
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.
Modifier and Type | Field | Description |
---|---|---|
static int |
BLOCK_SIZE |
Block size.
|
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.
|
Modifier and Type | Method | Description |
---|---|---|
BlockFieldMatrix<T> |
add(BlockFieldMatrix<T> m) |
Compute the sum of
this and m . |
FieldMatrix<T> |
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.
|
FieldMatrix<T> |
copy() |
Make a (deep) copy of this.
|
static <T extends FieldElement<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 new FieldMatrix
|
T[] |
getColumn(int column) |
Get the entries in column number
col as an array. |
int |
getColumnDimension() |
Returns the number of columns in the matrix.
|
FieldMatrix<T> |
getColumnMatrix(int column) |
Get the entries in column number
column
as a column matrix. |
FieldVector<T> |
getColumnVector(int column) |
Returns the entries in column number
column
as a vector. |
T[][] |
getData() |
Returns matrix entries as a two-dimensional array.
|
T |
getEntry(int row,
int column) |
Returns the entry in the specified row and column.
|
T[] |
getRow(int row) |
Get the entries in row number
row as an array. |
int |
getRowDimension() |
Returns the number of rows in the matrix.
|
FieldMatrix<T> |
getRowMatrix(int row) |
Get the entries in row number
row
as a row matrix. |
FieldVector<T> |
getRowVector(int row) |
Get the entries in row number
row
as 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 postmultiplying
this by m . |
FieldMatrix<T> |
multiply(FieldMatrix<T> m) |
Postmultiply this matrix by
m . |
void |
multiplyEntry(int row,
int column,
T factor) |
Change an entry in the specified row and column.
|
BlockFieldMatrix<T> |
multiplyTransposed(BlockFieldMatrix<T> m) |
Returns the result of postmultiplying
this by m^T . |
BlockFieldMatrix<T> |
multiplyTransposed(FieldMatrix<T> m) |
Returns the result of postmultiplying
this by m^T . |
T[] |
operate(T[] v) |
Returns the result of multiplying this by the vector
v . |
T[] |
preMultiply(T[] v) |
Returns the (row) vector result of premultiplying this by the vector
v . |
FieldMatrix<T> |
scalarAdd(T d) |
Increment each entry of this matrix.
|
FieldMatrix<T> |
scalarMultiply(T d) |
Multiply each entry by
d . |
void |
setColumn(int column,
T[] array) |
Set the entries in column number
column
as a column matrix. |
void |
setColumnMatrix(int column,
FieldMatrix<T> matrix) |
Set the entries in column number
column
as a column matrix. |
void |
setColumnVector(int column,
FieldVector<T> vector) |
Set the entries in column number
column
as a vector. |
void |
setEntry(int row,
int column,
T value) |
Set the entry in the specified row and column.
|
void |
setRow(int row,
T[] array) |
Set the entries in row number
row
as a row matrix. |
void |
setRowMatrix(int row,
BlockFieldMatrix<T> matrix) |
Sets the entries in row number
row
as a row matrix. |
void |
setRowMatrix(int row,
FieldMatrix<T> matrix) |
Set the entries in row number
row
as a row matrix. |
void |
setRowVector(int row,
FieldVector<T> vector) |
Set the entries in row number
row
as a vector. |
void |
setSubMatrix(T[][] subMatrix,
int row,
int column) |
Replace the submatrix starting at
(row, column) using data in the
input subMatrix array. |
BlockFieldMatrix<T> |
subtract(BlockFieldMatrix<T> m) |
Compute
this - m . |
FieldMatrix<T> |
subtract(FieldMatrix<T> m) |
Subtract
m from this matrix. |
static <T extends FieldElement<T>> |
toBlocksLayout(T[][] rawData) |
Convert a data array from raw layout to blocks layout.
|
FieldMatrix<T> |
transpose() |
Returns the transpose of this matrix.
|
BlockFieldMatrix<T> |
transposeMultiply(BlockFieldMatrix<T> m) |
Returns the result of postmultiplying
this^T by m . |
BlockFieldMatrix<T> |
transposeMultiply(FieldMatrix<T> m) |
Returns the result of postmultiplying
this^T by m . |
T |
walkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor) |
Visit (and possibly change) all matrix entries using the fastest possible order.
|
T |
walkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor,
int startRow,
int endRow,
int startColumn,
int endColumn) |
Visit (and possibly change) some matrix entries using the fastest possible order.
|
T |
walkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor) |
Visit (but don't change) all matrix entries using the fastest possible order.
|
T |
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.
|
T |
walkInRowOrder(FieldMatrixChangingVisitor<T> visitor) |
Visit (and possibly change) all matrix entries in row order.
|
T |
walkInRowOrder(FieldMatrixChangingVisitor<T> visitor,
int startRow,
int endRow,
int startColumn,
int endColumn) |
Visit (and possibly change) some matrix entries in row order.
|
T |
walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor) |
Visit (but don't change) all matrix entries in row order.
|
T |
walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor,
int startRow,
int endRow,
int startColumn,
int endColumn) |
Visit (but don't change) some matrix entries in row order.
|
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
public static final int BLOCK_SIZE
public BlockFieldMatrix(Field<T> field, int rows, int columns) throws MathIllegalArgumentException
field
- Field to which the elements belong.rows
- Number of rows in the new matrix.columns
- Number of columns in the new matrix.MathIllegalArgumentException
- if row or column dimension is not
positive.public BlockFieldMatrix(T[][] rawData) throws MathIllegalArgumentException
The input array must already be in raw layout.
Calling this constructor is equivalent to call:
matrix = new BlockFieldMatrix(getField(), rawData.length, rawData[0].length, toBlocksLayout(rawData), false);
rawData
- Data for the new matrix, in raw layout.MathIllegalArgumentException
- if the blockData
shape is
inconsistent with block layout.BlockFieldMatrix(int, int, FieldElement[][], boolean)
public BlockFieldMatrix(int rows, int columns, T[][] blockData, boolean copyArray) throws MathIllegalArgumentException
The input array must already be in blocks layout.
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 referencedMathIllegalArgumentException
- if the blockData
shape is
inconsistent with block layout.MathIllegalArgumentException
- if row or column dimension is not
positive.createBlocksLayout(Field, int, int)
,
toBlocksLayout(FieldElement[][])
,
BlockFieldMatrix(FieldElement[][])
public static <T extends FieldElement<T>> T[][] toBlocksLayout(T[][] rawData) throws MathIllegalArgumentException
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 in BlockFieldMatrix
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.
T
- Type of the field elements.rawData
- Data array in raw layout.MathIllegalArgumentException
- if rawData
is not rectangular
(not all rows have the same length).createBlocksLayout(Field, int, int)
,
BlockFieldMatrix(int, int, FieldElement[][], boolean)
public static <T extends FieldElement<T>> T[][] createBlocksLayout(Field<T> field, int rows, int columns)
This method can be used to create the array argument of the BlockFieldMatrix(int, int, FieldElement[][], boolean)
constructor.
T
- Type of the field elements.field
- Field to which the elements belong.rows
- Number of rows in the new matrix.columns
- Number of columns in the new matrix.toBlocksLayout(FieldElement[][])
,
BlockFieldMatrix(int, int, FieldElement[][], boolean)
public FieldMatrix<T> createMatrix(int rowDimension, int columnDimension) throws MathIllegalArgumentException
createMatrix
in interface FieldMatrix<T extends FieldElement<T>>
createMatrix
in class AbstractFieldMatrix<T extends FieldElement<T>>
rowDimension
- the number of rows in the new matrixcolumnDimension
- the number of columns in the new matrixMathIllegalArgumentException
- if row or column dimension is not
positive.public FieldMatrix<T> copy()
copy
in interface FieldMatrix<T extends FieldElement<T>>
copy
in class AbstractFieldMatrix<T extends FieldElement<T>>
public FieldMatrix<T> add(FieldMatrix<T> m) throws MathIllegalArgumentException
add
in interface FieldMatrix<T extends FieldElement<T>>
add
in class AbstractFieldMatrix<T extends FieldElement<T>>
m
- Matrix to be added.this
+ m
.MathIllegalArgumentException
- if m
is not the same
size as this
matrix.public BlockFieldMatrix<T> add(BlockFieldMatrix<T> m) throws MathIllegalArgumentException
this
and m
.m
- matrix to be addedthis + m
MathIllegalArgumentException
- if m
is not the same
size as this
public FieldMatrix<T> subtract(FieldMatrix<T> m) throws MathIllegalArgumentException
m
from this matrix.subtract
in interface FieldMatrix<T extends FieldElement<T>>
subtract
in class AbstractFieldMatrix<T extends FieldElement<T>>
m
- Matrix to be subtracted.this
- m
.MathIllegalArgumentException
- if m
is not the same
size as this
matrix.public BlockFieldMatrix<T> subtract(BlockFieldMatrix<T> m) throws MathIllegalArgumentException
this - m
.m
- matrix to be subtractedthis - m
MathIllegalArgumentException
- if m
is not the same
size as this
public FieldMatrix<T> scalarAdd(T d)
scalarAdd
in interface FieldMatrix<T extends FieldElement<T>>
scalarAdd
in class AbstractFieldMatrix<T extends FieldElement<T>>
d
- Value to be added to each entry.d
+ this
.public FieldMatrix<T> scalarMultiply(T d)
d
.scalarMultiply
in interface FieldMatrix<T extends FieldElement<T>>
scalarMultiply
in class AbstractFieldMatrix<T extends FieldElement<T>>
d
- Value to multiply all entries by.d
* this
.public FieldMatrix<T> multiply(FieldMatrix<T> m) throws MathIllegalArgumentException
m
.multiply
in interface FieldMatrix<T extends FieldElement<T>>
multiply
in class AbstractFieldMatrix<T extends FieldElement<T>>
m
- Matrix to postmultiply by.this
* m
.MathIllegalArgumentException
- if the number of columns of
this
matrix is not equal to the number of rows of matrix
m
.public BlockFieldMatrix<T> multiply(BlockFieldMatrix<T> m) throws MathIllegalArgumentException
this
by m
.m
- matrix to postmultiply bythis * m
MathIllegalArgumentException
- if the matrices are not compatible.public BlockFieldMatrix<T> multiplyTransposed(BlockFieldMatrix<T> m) throws MathIllegalArgumentException
this
by m^T
.m
- matrix to first transpose and second postmultiply bythis * m
MathIllegalArgumentException
- if
columnDimension(this) != columnDimension(m)
public BlockFieldMatrix<T> multiplyTransposed(FieldMatrix<T> m) throws MathIllegalArgumentException
this
by m^T
.
This is equivalent to call multiply
(m.FieldMatrix.transpose()
),
but some implementations may avoid building the intermediate transposed matrix.
multiplyTransposed
in interface FieldMatrix<T extends FieldElement<T>>
m
- matrix to first transpose and second postmultiply bythis * m^T
MathIllegalArgumentException
- if
columnDimension(this) != columnDimension(m)
public BlockFieldMatrix<T> transposeMultiply(BlockFieldMatrix<T> m) throws MathIllegalArgumentException
this^T
by m
.m
- matrix to postmultiply bythis^T * m
MathIllegalArgumentException
- if
columnDimension(this) != columnDimension(m)
public BlockFieldMatrix<T> transposeMultiply(FieldMatrix<T> m) throws MathIllegalArgumentException
this^T
by m
.
This is equivalent to call FieldMatrix.transpose()
.multiply(m)
,
but some implementations may avoid building the intermediate transposed matrix.
transposeMultiply
in interface FieldMatrix<T extends FieldElement<T>>
m
- matrix to postmultiply bythis^T * m
MathIllegalArgumentException
- if
columnDimension(this) != columnDimension(m)
public T[][] getData()
getData
in interface FieldMatrix<T extends FieldElement<T>>
getData
in class AbstractFieldMatrix<T extends FieldElement<T>>
public FieldMatrix<T> getSubMatrix(int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException
getSubMatrix
in interface FieldMatrix<T extends FieldElement<T>>
getSubMatrix
in class AbstractFieldMatrix<T extends FieldElement<T>>
startRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)MathIllegalArgumentException
- is endRow < startRow
of
endColumn < startColumn
.public void setSubMatrix(T[][] subMatrix, int row, int column) throws MathIllegalArgumentException, NullArgumentException
(row, column)
using data in the
input subMatrix
array. Indexes are 0-based.
Example:
Starting with
1 2 3 4 5 6 7 8 9 0 1 2and
subMatrix = {{3, 4} {5,6}}
, invoking
setSubMatrix(subMatrix,1,1))
will result in
1 2 3 4 5 3 4 8 9 5 6 2
setSubMatrix
in interface FieldMatrix<T extends FieldElement<T>>
setSubMatrix
in class AbstractFieldMatrix<T extends FieldElement<T>>
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.MathIllegalArgumentException
- if subMatrix
does not fit into this
matrix from element in (row, column)
.NullArgumentException
- if subMatrix
is null
.public FieldMatrix<T> getRowMatrix(int row) throws MathIllegalArgumentException
row
as a row matrix.getRowMatrix
in interface FieldMatrix<T extends FieldElement<T>>
getRowMatrix
in class AbstractFieldMatrix<T extends FieldElement<T>>
row
- Row to be fetched.MathIllegalArgumentException
- if the specified row index is invalid.public void setRowMatrix(int row, FieldMatrix<T> matrix) throws MathIllegalArgumentException
row
as a row matrix.setRowMatrix
in interface FieldMatrix<T extends FieldElement<T>>
setRowMatrix
in class AbstractFieldMatrix<T extends FieldElement<T>>
row
- Row to be set.matrix
- Row matrix (must have one row and the same number
of columns as the instance).MathIllegalArgumentException
- if the specified row index is invalid.public void setRowMatrix(int row, BlockFieldMatrix<T> matrix) throws MathIllegalArgumentException
row
as a row matrix. Row indices start at 0.row
- the row to be setmatrix
- row matrix (must have one row and the same number of columns
as the instance)MathIllegalArgumentException
- if the matrix dimensions do
not match one instance row.MathIllegalArgumentException
- if the specified row index is invalid.public FieldMatrix<T> getColumnMatrix(int column) throws MathIllegalArgumentException
column
as a column matrix.getColumnMatrix
in interface FieldMatrix<T extends FieldElement<T>>
getColumnMatrix
in class AbstractFieldMatrix<T extends FieldElement<T>>
column
- Column to be fetched.MathIllegalArgumentException
- if the specified column index is invalid.public void setColumnMatrix(int column, FieldMatrix<T> matrix) throws MathIllegalArgumentException
column
as a column matrix.setColumnMatrix
in interface FieldMatrix<T extends FieldElement<T>>
setColumnMatrix
in class AbstractFieldMatrix<T extends FieldElement<T>>
column
- Column to be set.matrix
- column matrix (must have one column and the same
number of rows as the instance).MathIllegalArgumentException
- if the specified column index is invalid.public FieldVector<T> getRowVector(int row) throws MathIllegalArgumentException
row
as a vector.getRowVector
in interface FieldMatrix<T extends FieldElement<T>>
getRowVector
in class AbstractFieldMatrix<T extends FieldElement<T>>
row
- Row to be fetchedMathIllegalArgumentException
- if the specified row index is invalid.public void setRowVector(int row, FieldVector<T> vector) throws MathIllegalArgumentException
row
as a vector.setRowVector
in interface FieldMatrix<T extends FieldElement<T>>
setRowVector
in class AbstractFieldMatrix<T extends FieldElement<T>>
row
- Row to be set.vector
- row vector (must have the same number of columns
as the instance).MathIllegalArgumentException
- if the specified row index is invalid.public FieldVector<T> getColumnVector(int column) throws MathIllegalArgumentException
column
as a vector.getColumnVector
in interface FieldMatrix<T extends FieldElement<T>>
getColumnVector
in class AbstractFieldMatrix<T extends FieldElement<T>>
column
- Column to be fetched.MathIllegalArgumentException
- if the specified column index is invalid.public void setColumnVector(int column, FieldVector<T> vector) throws MathIllegalArgumentException
column
as a vector.setColumnVector
in interface FieldMatrix<T extends FieldElement<T>>
setColumnVector
in class AbstractFieldMatrix<T extends FieldElement<T>>
column
- Column to be set.vector
- Column vector (must have the same number of rows
as the instance).MathIllegalArgumentException
- if the specified column index is invalid.public T[] getRow(int row) throws MathIllegalArgumentException
row
as an array.getRow
in interface FieldMatrix<T extends FieldElement<T>>
getRow
in class AbstractFieldMatrix<T extends FieldElement<T>>
row
- Row to be fetched.MathIllegalArgumentException
- if the specified row index is not valid.public void setRow(int row, T[] array) throws MathIllegalArgumentException
row
as a row matrix.setRow
in interface FieldMatrix<T extends FieldElement<T>>
setRow
in class AbstractFieldMatrix<T extends FieldElement<T>>
row
- Row to be set.array
- Row matrix (must have the same number of columns as
the instance).MathIllegalArgumentException
- if the specified row index is invalid.public T[] getColumn(int column) throws MathIllegalArgumentException
col
as an array.getColumn
in interface FieldMatrix<T extends FieldElement<T>>
getColumn
in class AbstractFieldMatrix<T extends FieldElement<T>>
column
- the column to be fetchedMathIllegalArgumentException
- if the specified column index is not valid.public void setColumn(int column, T[] array) throws MathIllegalArgumentException
column
as a column matrix.setColumn
in interface FieldMatrix<T extends FieldElement<T>>
setColumn
in class AbstractFieldMatrix<T extends FieldElement<T>>
column
- the column to be setarray
- column array (must have the same number of rows as the instance)MathIllegalArgumentException
- if the specified column index is invalid.public T getEntry(int row, int column) throws MathIllegalArgumentException
getEntry
in interface FieldMatrix<T extends FieldElement<T>>
getEntry
in class AbstractFieldMatrix<T extends FieldElement<T>>
row
- row location of entry to be fetchedcolumn
- column location of entry to be fetchedMathIllegalArgumentException
- if the row or column index is not valid.public void setEntry(int row, int column, T value) throws MathIllegalArgumentException
setEntry
in interface FieldMatrix<T extends FieldElement<T>>
setEntry
in class AbstractFieldMatrix<T extends FieldElement<T>>
row
- row location of entry to be setcolumn
- column location of entry to be setvalue
- matrix entry to be set in row,columnMathIllegalArgumentException
- if the row or column index is not valid.public void addToEntry(int row, int column, T increment) throws MathIllegalArgumentException
addToEntry
in interface FieldMatrix<T extends FieldElement<T>>
addToEntry
in class AbstractFieldMatrix<T extends FieldElement<T>>
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)
.MathIllegalArgumentException
- if the row or column index is not valid.public void multiplyEntry(int row, int column, T factor) throws MathIllegalArgumentException
multiplyEntry
in interface FieldMatrix<T extends FieldElement<T>>
multiplyEntry
in class AbstractFieldMatrix<T extends FieldElement<T>>
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)
MathIllegalArgumentException
- if the row or column index is not valid.public FieldMatrix<T> transpose()
transpose
in interface FieldMatrix<T extends FieldElement<T>>
transpose
in class AbstractFieldMatrix<T extends FieldElement<T>>
public int getRowDimension()
getRowDimension
in interface AnyMatrix
getRowDimension
in class AbstractFieldMatrix<T extends FieldElement<T>>
public int getColumnDimension()
getColumnDimension
in interface AnyMatrix
getColumnDimension
in class AbstractFieldMatrix<T extends FieldElement<T>>
public T[] operate(T[] v) throws MathIllegalArgumentException
v
.operate
in interface FieldMatrix<T extends FieldElement<T>>
operate
in class AbstractFieldMatrix<T extends FieldElement<T>>
v
- the vector to operate onthis * v
MathIllegalArgumentException
- if the number of columns of
this
matrix is not equal to the size of the vector v
.public T[] preMultiply(T[] v) throws MathIllegalArgumentException
v
.preMultiply
in interface FieldMatrix<T extends FieldElement<T>>
preMultiply
in class AbstractFieldMatrix<T extends FieldElement<T>>
v
- the row vector to premultiply byv * this
MathIllegalArgumentException
- if the number of rows of this
matrix is not equal to the size of the vector v
public T walkInRowOrder(FieldMatrixChangingVisitor<T> visitor)
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.
walkInRowOrder
in interface FieldMatrix<T extends FieldElement<T>>
walkInRowOrder
in class AbstractFieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesFieldMatrixChangingVisitor.end()
at the end
of the walkFieldMatrix.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)
public T walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor)
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.
walkInRowOrder
in interface FieldMatrix<T extends FieldElement<T>>
walkInRowOrder
in class AbstractFieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesFieldMatrixPreservingVisitor.end()
at the end
of the walkFieldMatrix.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)
public T walkInRowOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException
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.
walkInRowOrder
in interface FieldMatrix<T extends FieldElement<T>>
walkInRowOrder
in class AbstractFieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column indexFieldMatrixChangingVisitor.end()
at the end
of the walkMathIllegalArgumentException
- if the indices are not valid.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)
public T walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException
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.
walkInRowOrder
in interface FieldMatrix<T extends FieldElement<T>>
walkInRowOrder
in class AbstractFieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column indexFieldMatrixPreservingVisitor.end()
at the end
of the walkMathIllegalArgumentException
- if the indices are not valid.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)
public T walkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor)
The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
walkInOptimizedOrder
in interface FieldMatrix<T extends FieldElement<T>>
walkInOptimizedOrder
in class AbstractFieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesFieldMatrixChangingVisitor.end()
at the end
of the walkFieldMatrix.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)
public T walkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor)
The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
walkInOptimizedOrder
in interface FieldMatrix<T extends FieldElement<T>>
walkInOptimizedOrder
in class AbstractFieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesFieldMatrixPreservingVisitor.end()
at the end
of the walkFieldMatrix.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)
public T walkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException
The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
walkInOptimizedOrder
in interface FieldMatrix<T extends FieldElement<T>>
walkInOptimizedOrder
in class AbstractFieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)FieldMatrixChangingVisitor.end()
at the end
of the walkMathIllegalArgumentException
- if endRow < startRow
or
endColumn < startColumn
.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)
public T walkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException
The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
walkInOptimizedOrder
in interface FieldMatrix<T extends FieldElement<T>>
walkInOptimizedOrder
in class AbstractFieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)FieldMatrixPreservingVisitor.end()
at the end
of the walkMathIllegalArgumentException
- if endRow < startRow
or
endColumn < startColumn
.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)
Copyright © 2016–2018 Hipparchus.org. All rights reserved.