|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.math.linear.AbstractFieldMatrix<T>
org.apache.commons.math.linear.BlockFieldMatrix<T>
T - the type of the field elementspublic class BlockFieldMatrix<T extends FieldElement<T>>
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_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_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.
| Field Summary | |
|---|---|
static int |
BLOCK_SIZE
Block size. |
| Constructor Summary | |
|---|---|
BlockFieldMatrix(Field<T> field,
int rows,
int columns)
Create a new matrix with the supplied row and column dimensions. |
|
BlockFieldMatrix(int rows,
int columns,
T[][] blockData,
boolean copyArray)
Create a new dense matrix copying entries from block layout data. |
|
BlockFieldMatrix(T[][] rawData)
Create a new dense matrix copying entries from raw layout data. |
|
| Method Summary | ||
|---|---|---|
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()
Returns a (deep) copy of this. |
|
static
|
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)
Returns the entries in column number col as an array. |
|
int |
getColumnDimension()
Returns the number of columns in the matrix. |
|
FieldMatrix<T> |
getColumnMatrix(int column)
Returns 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)
Returns the entries in row number row as an array. |
|
int |
getRowDimension()
Returns the number of rows in the matrix. |
|
FieldMatrix<T> |
getRowMatrix(int row)
Returns the entries in row number row
as a row matrix. |
|
FieldVector<T> |
getRowVector(int row)
Returns the entries in row number row
as a vector. |
|
FieldMatrix<T> |
getSubMatrix(int startRow,
int endRow,
int startColumn,
int endColumn)
Gets a submatrix. |
|
BlockFieldMatrix<T> |
multiply(BlockFieldMatrix<T> m)
Returns the result of postmultiplying this by m. |
|
FieldMatrix<T> |
multiply(FieldMatrix<T> m)
Returns the result of postmultiplying this by m. |
|
void |
multiplyEntry(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 vector v. |
|
T[] |
preMultiply(T[] v)
Returns the (row) vector result of premultiplying this by the vector v. |
|
FieldMatrix<T> |
scalarAdd(T d)
Returns the result of adding d to each entry of this. |
|
FieldMatrix<T> |
scalarMultiply(T d)
Returns the result multiplying each entry of this by d. |
|
void |
setColumn(int column,
T[] array)
Sets the entries in column number column
as a column matrix. |
|
void |
setColumnMatrix(int column,
FieldMatrix<T> matrix)
Sets the entries in column number column
as a column matrix. |
|
void |
setColumnVector(int column,
FieldVector<T> vector)
Sets 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)
Sets 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)
Sets the entries in row number row
as a row matrix. |
|
void |
setRowVector(int row,
FieldVector<T> vector)
Sets 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 minus m. |
|
FieldMatrix<T> |
subtract(FieldMatrix<T> m)
Compute this minus m. |
|
static
|
toBlocksLayout(T[][] rawData)
Convert a data array from raw layout to blocks layout. |
|
FieldMatrix<T> |
transpose()
Returns the transpose of this matrix. |
|
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. |
|
| Methods inherited from class org.apache.commons.math.linear.AbstractFieldMatrix |
|---|
buildArray, buildArray, checkAdditionCompatible, checkColumnIndex, checkMultiplicationCompatible, checkRowIndex, checkSubMatrixIndex, checkSubMatrixIndex, checkSubtractionCompatible, copySubMatrix, copySubMatrix, equals, extractField, extractField, getField, getSubMatrix, getTrace, hashCode, isSquare, operate, preMultiply, preMultiply, toString, walkInColumnOrder, walkInColumnOrder, walkInColumnOrder, walkInColumnOrder |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final int BLOCK_SIZE
| Constructor Detail |
|---|
public BlockFieldMatrix(Field<T> field,
int rows,
int columns)
throws IllegalArgumentException
field - field to which the elements belongrows - the number of rows in the new matrixcolumns - the number of columns in the new matrix
IllegalArgumentException - if row or column dimension is not
positive
public BlockFieldMatrix(T[][] rawData)
throws IllegalArgumentException
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 new matrix, in raw layout
IllegalArgumentException - if blockData shape is
inconsistent with block layoutBlockFieldMatrix(int, int, FieldElement[][], boolean)
public BlockFieldMatrix(int rows,
int columns,
T[][] blockData,
boolean copyArray)
throws IllegalArgumentException
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 referenced
IllegalArgumentException - if blockData shape is
inconsistent with block layoutcreateBlocksLayout(Field, int, int),
toBlocksLayout(FieldElement[][]),
BlockFieldMatrix(FieldElement[][])| Method Detail |
|---|
public static <T extends FieldElement<T>> T[][] toBlocksLayout(T[][] rawData)
throws IllegalArgumentException
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 - the type of the field elementsrawData - data array in raw layout
IllegalArgumentException - 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 - the type of the field elementsfield - field to which the elements belongrows - the number of rows in the new matrixcolumns - the number of columns in the new matrix
toBlocksLayout(FieldElement[][]),
BlockFieldMatrix(int, int, FieldElement[][], boolean)
public FieldMatrix<T> createMatrix(int rowDimension,
int columnDimension)
throws IllegalArgumentException
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 matrix
IllegalArgumentException - if row or column dimension is not positivepublic 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 IllegalArgumentException
add in interface FieldMatrix<T extends FieldElement<T>>add in class AbstractFieldMatrix<T extends FieldElement<T>>m - matrix to be added
IllegalArgumentException - if m is not the same size as this
public BlockFieldMatrix<T> add(BlockFieldMatrix<T> m)
throws IllegalArgumentException
m.
m - matrix to be added
IllegalArgumentException - if m is not the same size as this
public FieldMatrix<T> subtract(FieldMatrix<T> m)
throws IllegalArgumentException
subtract in interface FieldMatrix<T extends FieldElement<T>>subtract in class AbstractFieldMatrix<T extends FieldElement<T>>m - matrix to be subtracted
IllegalArgumentException - if m is not the same size as this
public BlockFieldMatrix<T> subtract(BlockFieldMatrix<T> m)
throws IllegalArgumentException
m.
m - matrix to be subtracted
IllegalArgumentException - if m is not the same size as this
public FieldMatrix<T> scalarAdd(T d)
throws IllegalArgumentException
scalarAdd in interface FieldMatrix<T extends FieldElement<T>>scalarAdd in class AbstractFieldMatrix<T extends FieldElement<T>>d - value to be added to each entry
IllegalArgumentException
public FieldMatrix<T> scalarMultiply(T d)
throws IllegalArgumentException
scalarMultiply in interface FieldMatrix<T extends FieldElement<T>>scalarMultiply in class AbstractFieldMatrix<T extends FieldElement<T>>d - value to multiply all entries by
IllegalArgumentException
public FieldMatrix<T> multiply(FieldMatrix<T> m)
throws IllegalArgumentException
multiply in interface FieldMatrix<T extends FieldElement<T>>multiply in class AbstractFieldMatrix<T extends FieldElement<T>>m - matrix to postmultiply by
IllegalArgumentException - if columnDimension(this) != rowDimension(m)
public BlockFieldMatrix<T> multiply(BlockFieldMatrix<T> m)
throws IllegalArgumentException
m - matrix to postmultiply by
IllegalArgumentException - if columnDimension(this) != rowDimension(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 MatrixIndexException
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)
MatrixIndexException - if the indices are not valid
public void setSubMatrix(T[][] subMatrix,
int row,
int column)
throws MatrixIndexException
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 datarow - row coordinate of the top, left element to be replacedcolumn - column coordinate of the top, left element to be replaced
MatrixIndexException - if subMatrix does not fit into this
matrix from element in (row, column)
public FieldMatrix<T> getRowMatrix(int row)
throws MatrixIndexException
row
as a row matrix. Row indices start at 0.
getRowMatrix in interface FieldMatrix<T extends FieldElement<T>>getRowMatrix in class AbstractFieldMatrix<T extends FieldElement<T>>row - the row to be fetched
MatrixIndexException - if the specified row index is invalid
public void setRowMatrix(int row,
FieldMatrix<T> matrix)
throws MatrixIndexException,
InvalidMatrixException
row
as a row matrix. Row indices start at 0.
setRowMatrix in interface FieldMatrix<T extends FieldElement<T>>setRowMatrix in class AbstractFieldMatrix<T extends FieldElement<T>>row - the row to be setmatrix - row matrix (must have one row and the same number of columns
as the instance)
MatrixIndexException - if the specified row index is invalid
InvalidMatrixException - if the matrix dimensions do not match one
instance row
public void setRowMatrix(int row,
BlockFieldMatrix<T> matrix)
throws MatrixIndexException,
InvalidMatrixException
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)
MatrixIndexException - if the specified row index is invalid
InvalidMatrixException - if the matrix dimensions do not match one
instance row
public FieldMatrix<T> getColumnMatrix(int column)
throws MatrixIndexException
column
as a column matrix. Column indices start at 0.
getColumnMatrix in interface FieldMatrix<T extends FieldElement<T>>getColumnMatrix in class AbstractFieldMatrix<T extends FieldElement<T>>column - the column to be fetched
MatrixIndexException - if the specified column index is invalid
public void setColumnMatrix(int column,
FieldMatrix<T> matrix)
throws MatrixIndexException,
InvalidMatrixException
column
as a column matrix. Column indices start at 0.
setColumnMatrix in interface FieldMatrix<T extends FieldElement<T>>setColumnMatrix in class AbstractFieldMatrix<T extends FieldElement<T>>column - the column to be setmatrix - column matrix (must have one column and the same number of rows
as the instance)
MatrixIndexException - if the specified column index is invalid
InvalidMatrixException - if the matrix dimensions do not match one
instance column
public FieldVector<T> getRowVector(int row)
throws MatrixIndexException
row
as a vector. Row indices start at 0.
getRowVector in interface FieldMatrix<T extends FieldElement<T>>getRowVector in class AbstractFieldMatrix<T extends FieldElement<T>>row - the row to be fetched
MatrixIndexException - if the specified row index is invalid
public void setRowVector(int row,
FieldVector<T> vector)
throws MatrixIndexException,
InvalidMatrixException
row
as a vector. Row indices start at 0.
setRowVector in interface FieldMatrix<T extends FieldElement<T>>setRowVector in class AbstractFieldMatrix<T extends FieldElement<T>>row - the row to be setvector - row vector (must have the same number of columns
as the instance)
MatrixIndexException - if the specified row index is invalid
InvalidMatrixException - if the vector dimension does not match one
instance row
public FieldVector<T> getColumnVector(int column)
throws MatrixIndexException
column
as a vector. Column indices start at 0.
getColumnVector in interface FieldMatrix<T extends FieldElement<T>>getColumnVector in class AbstractFieldMatrix<T extends FieldElement<T>>column - the column to be fetched
MatrixIndexException - if the specified column index is invalid
public void setColumnVector(int column,
FieldVector<T> vector)
throws MatrixIndexException,
InvalidMatrixException
column
as a vector. Column indices start at 0.
setColumnVector in interface FieldMatrix<T extends FieldElement<T>>setColumnVector in class AbstractFieldMatrix<T extends FieldElement<T>>column - the column to be setvector - column vector (must have the same number of rows as the instance)
MatrixIndexException - if the specified column index is invalid
InvalidMatrixException - if the vector dimension does not match one
instance column
public T[] getRow(int row)
throws MatrixIndexException
row as an array.
Row indices start at 0. A MatrixIndexException is thrown
unless 0 <= row < rowDimension.
getRow in interface FieldMatrix<T extends FieldElement<T>>getRow in class AbstractFieldMatrix<T extends FieldElement<T>>row - the row to be fetched
MatrixIndexException - if the specified row index is not valid
public void setRow(int row,
T[] array)
throws MatrixIndexException,
InvalidMatrixException
row
as a row matrix. Row indices start at 0.
setRow in interface FieldMatrix<T extends FieldElement<T>>setRow in class AbstractFieldMatrix<T extends FieldElement<T>>row - the row to be setarray - row matrix (must have the same number of columns as the instance)
MatrixIndexException - if the specified row index is invalid
InvalidMatrixException - if the array size does not match one
instance row
public T[] getColumn(int column)
throws MatrixIndexException
col as an array.
Column indices start at 0. A MatrixIndexException is thrown
unless 0 <= column < columnDimension.
getColumn in interface FieldMatrix<T extends FieldElement<T>>getColumn in class AbstractFieldMatrix<T extends FieldElement<T>>column - the column to be fetched
MatrixIndexException - if the specified column index is not valid
public void setColumn(int column,
T[] array)
throws MatrixIndexException,
InvalidMatrixException
column
as a column matrix. Column indices start at 0.
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)
MatrixIndexException - if the specified column index is invalid
InvalidMatrixException - if the array size does not match one
instance column
public T getEntry(int row,
int column)
throws MatrixIndexException
Row and column indices start at 0 and must satisfy
0 <= row < rowDimension 0 <= column < columnDimensionMatrixIndexException is thrown.
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 fetched
MatrixIndexException - if the row or column index is not valid
public void setEntry(int row,
int column,
T value)
throws MatrixIndexException
Row and column indices start at 0 and must satisfy
0 <= row < rowDimension 0 <= column < columnDimensionMatrixIndexException is thrown.
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,column
MatrixIndexException - if the row or column index is not valid
public void addToEntry(int row,
int column,
T increment)
throws MatrixIndexException
Row and column indices start at 0 and must satisfy
0 <= row < rowDimension 0 <= column < columnDimensionMatrixIndexException is thrown.
addToEntry in interface FieldMatrix<T extends FieldElement<T>>addToEntry in class AbstractFieldMatrix<T extends FieldElement<T>>row - row location of entry to be setcolumn - column location of entry to be setincrement - value to add to the current matrix entry in row,column
MatrixIndexException - if the row or column index is not valid
public void multiplyEntry(int row,
int column,
T factor)
throws MatrixIndexException
Row and column indices start at 0 and must satisfy
0 <= row < rowDimension 0 <= column < columnDimensionMatrixIndexException is thrown.
multiplyEntry in interface FieldMatrix<T extends FieldElement<T>>multiplyEntry in class AbstractFieldMatrix<T extends FieldElement<T>>row - row location of entry to be setcolumn - column location of entry to be setfactor - multiplication factor for the current matrix entry in row,column
MatrixIndexException - if the row or column index is not validpublic 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 AnyMatrixgetRowDimension in class AbstractFieldMatrix<T extends FieldElement<T>>public int getColumnDimension()
getColumnDimension in interface AnyMatrixgetColumnDimension in class AbstractFieldMatrix<T extends FieldElement<T>>
public T[] operate(T[] v)
throws IllegalArgumentException
v.
operate in interface FieldMatrix<T extends FieldElement<T>>operate in class AbstractFieldMatrix<T extends FieldElement<T>>v - the vector to operate on
IllegalArgumentException - if columnDimension != v.size()
public T[] preMultiply(T[] v)
throws IllegalArgumentException
v.
preMultiply in interface FieldMatrix<T extends FieldElement<T>>preMultiply in class AbstractFieldMatrix<T extends FieldElement<T>>v - the row vector to premultiply by
IllegalArgumentException - if rowDimension != v.size()
public T walkInRowOrder(FieldMatrixChangingVisitor<T> visitor)
throws MatrixVisitorException
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 entries
FieldMatrixChangingVisitor.end() at the end
of the walk
MatrixVisitorException - if the visitor cannot process an entryFieldMatrix.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)
throws MatrixVisitorException
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 entries
FieldMatrixPreservingVisitor.end() at the end
of the walk
MatrixVisitorException - if the visitor cannot process an entryFieldMatrix.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 MatrixIndexException,
MatrixVisitorException
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 index
FieldMatrixChangingVisitor.end() at the end
of the walk
MatrixIndexException - if the indices are not valid
MatrixVisitorException - if the visitor cannot process an entryFieldMatrix.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 MatrixIndexException,
MatrixVisitorException
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 index
FieldMatrixPreservingVisitor.end() at the end
of the walk
MatrixIndexException - if the indices are not valid
MatrixVisitorException - if the visitor cannot process an entryFieldMatrix.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)
throws MatrixVisitorException
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 entries
FieldMatrixChangingVisitor.end() at the end
of the walk
MatrixVisitorException - if the visitor cannot process an entryFieldMatrix.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)
throws MatrixVisitorException
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 entries
FieldMatrixPreservingVisitor.end() at the end
of the walk
MatrixVisitorException - if the visitor cannot process an entryFieldMatrix.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 MatrixIndexException,
MatrixVisitorException
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 walk
MatrixIndexException - if the indices are not valid
MatrixVisitorException - if the visitor cannot process an entryFieldMatrix.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 MatrixIndexException,
MatrixVisitorException
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 walk
MatrixIndexException - if the indices are not valid
MatrixVisitorException - if the visitor cannot process an entryFieldMatrix.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)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||