|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.math.linear.AbstractRealMatrix
org.apache.commons.math.linear.BlockRealMatrix
public class BlockRealMatrix
Cache-friendly implementation of RealMatrix 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 52x52 blocks which is well suited for processors with 64k L1 cache (one block holds 2704 values or 21632 bytes). This value could be lowered to 36x36 for processors with 32k L1 cache.
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 52x52, a 100x60 matrix would be stored in 4 blocks. Block 0 would be a double[2704] array holding the upper left 52x52 square, block 1 would be a double[416] array holding the upper right 52x8 rectangle, block 2 would be a double[2496] array holding the lower left 48x52 rectangle and block 3 would be a double[384] array holding the lower right 48x8 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 | |
|---|---|
BlockRealMatrix(double[][] rawData)
Create a new dense matrix copying entries from raw layout data. |
|
BlockRealMatrix(int rows,
int columns)
Create a new matrix with the supplied row and column dimensions. |
|
BlockRealMatrix(int rows,
int columns,
double[][] blockData,
boolean copyArray)
Create a new dense matrix copying entries from block layout data. |
|
| Method Summary | |
|---|---|
BlockRealMatrix |
add(BlockRealMatrix m)
Compute the sum of this and m. |
BlockRealMatrix |
add(RealMatrix m)
Compute the sum of this and m. |
void |
addToEntry(int row,
int column,
double increment)
Change an entry in the specified row and column. |
BlockRealMatrix |
copy()
Returns a (deep) copy of this. |
static double[][] |
createBlocksLayout(int rows,
int columns)
Create a data array in blocks layout. |
BlockRealMatrix |
createMatrix(int rowDimension,
int columnDimension)
Create a new RealMatrix of the same type as the instance with the supplied row and column dimensions. |
double[] |
getColumn(int column)
Returns the entries in column number col as an array. |
int |
getColumnDimension()
Returns the number of columns in the matrix. |
BlockRealMatrix |
getColumnMatrix(int column)
Returns the entries in column number column
as a column matrix. |
RealVector |
getColumnVector(int column)
Returns the entries in column number column
as a vector. |
double[][] |
getData()
Returns matrix entries as a two-dimensional array. |
double |
getEntry(int row,
int column)
Returns the entry in the specified row and column. |
double |
getFrobeniusNorm()
Returns the Frobenius norm of the matrix. |
double |
getNorm()
Returns the maximum absolute row sum norm of the matrix. |
double[] |
getRow(int row)
Returns the entries in row number row as an array. |
int |
getRowDimension()
Returns the number of rows in the matrix. |
BlockRealMatrix |
getRowMatrix(int row)
Returns the entries in row number row
as a row matrix. |
RealVector |
getRowVector(int row)
Returns the entries in row number row
as a vector. |
BlockRealMatrix |
getSubMatrix(int startRow,
int endRow,
int startColumn,
int endColumn)
Gets a submatrix. |
BlockRealMatrix |
multiply(BlockRealMatrix m)
Returns the result of postmultiplying this by m. |
BlockRealMatrix |
multiply(RealMatrix m)
Returns the result of postmultiplying this by m. |
void |
multiplyEntry(int row,
int column,
double factor)
Change an entry in the specified row and column. |
double[] |
operate(double[] v)
Returns the result of multiplying this by the vector v. |
double[] |
preMultiply(double[] v)
Returns the (row) vector result of premultiplying this by the vector v. |
BlockRealMatrix |
scalarAdd(double d)
Returns the result of adding d to each entry of this. |
RealMatrix |
scalarMultiply(double d)
Returns the result multiplying each entry of this by d. |
void |
setColumn(int column,
double[] array)
Sets the entries in column number column
as a column matrix. |
void |
setColumnMatrix(int column,
RealMatrix matrix)
Sets the entries in column number column
as a column matrix. |
void |
setColumnVector(int column,
RealVector vector)
Sets the entries in column number column
as a vector. |
void |
setEntry(int row,
int column,
double value)
Set the entry in the specified row and column. |
void |
setRow(int row,
double[] array)
Sets the entries in row number row
as a row matrix. |
void |
setRowMatrix(int row,
BlockRealMatrix matrix)
Sets the entries in row number row
as a row matrix. |
void |
setRowMatrix(int row,
RealMatrix matrix)
Sets the entries in row number row
as a row matrix. |
void |
setRowVector(int row,
RealVector vector)
Sets the entries in row number row
as a vector. |
void |
setSubMatrix(double[][] subMatrix,
int row,
int column)
Replace the submatrix starting at row, column using data in
the input subMatrix array. |
BlockRealMatrix |
subtract(BlockRealMatrix m)
Compute this minus m. |
BlockRealMatrix |
subtract(RealMatrix m)
Compute this minus m. |
static double[][] |
toBlocksLayout(double[][] rawData)
Convert a data array from raw layout to blocks layout. |
BlockRealMatrix |
transpose()
Returns the transpose of this matrix. |
double |
walkInOptimizedOrder(RealMatrixChangingVisitor visitor)
Visit (and possibly change) all matrix entries using the fastest possible order. |
double |
walkInOptimizedOrder(RealMatrixChangingVisitor visitor,
int startRow,
int endRow,
int startColumn,
int endColumn)
Visit (and possibly change) some matrix entries using the fastest possible order. |
double |
walkInOptimizedOrder(RealMatrixPreservingVisitor visitor)
Visit (but don't change) all matrix entries using the fastest possible order. |
double |
walkInOptimizedOrder(RealMatrixPreservingVisitor visitor,
int startRow,
int endRow,
int startColumn,
int endColumn)
Visit (but don't change) some matrix entries using the fastest possible order. |
double |
walkInRowOrder(RealMatrixChangingVisitor visitor)
Visit (and possibly change) all matrix entries in row order. |
double |
walkInRowOrder(RealMatrixChangingVisitor visitor,
int startRow,
int endRow,
int startColumn,
int endColumn)
Visit (and possibly change) some matrix entries in row order. |
double |
walkInRowOrder(RealMatrixPreservingVisitor visitor)
Visit (but don't change) all matrix entries in row order. |
double |
walkInRowOrder(RealMatrixPreservingVisitor 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.AbstractRealMatrix |
|---|
copySubMatrix, copySubMatrix, equals, getDeterminant, getSubMatrix, getTrace, hashCode, inverse, isSingular, isSquare, luDecompose, operate, preMultiply, preMultiply, solve, solve, 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 BlockRealMatrix(int rows,
int columns)
throws IllegalArgumentException
rows - 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 BlockRealMatrix(double[][] rawData)
throws IllegalArgumentException
The input array must already be in raw layout.
Calling this constructor is equivalent to call:
matrix = new BlockRealMatrix(rawData.length, rawData[0].length,
toBlocksLayout(rawData), false);
rawData - data for new matrix, in raw layout
IllegalArgumentException - if blockData shape is
inconsistent with block layoutBlockRealMatrix(int, int, double[][], boolean)
public BlockRealMatrix(int rows,
int columns,
double[][] 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(int, int),
toBlocksLayout(double[][]),
BlockRealMatrix(double[][])| Method Detail |
|---|
public static double[][] toBlocksLayout(double[][] 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 BlockRealMatrix 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 BlockRealMatrix(int, int, double[][], boolean) constructor.
rawData - data array in raw layout
IllegalArgumentException - if rawData is not rectangular
(not all rows have the same length)createBlocksLayout(int, int),
BlockRealMatrix(int, int, double[][], boolean)
public static double[][] createBlocksLayout(int rows,
int columns)
This method can be used to create the array argument of the BlockRealMatrix(int, int, double[][], boolean) constructor.
rows - the number of rows in the new matrixcolumns - the number of columns in the new matrix
toBlocksLayout(double[][]),
BlockRealMatrix(int, int, double[][], boolean)
public BlockRealMatrix createMatrix(int rowDimension,
int columnDimension)
throws IllegalArgumentException
createMatrix in interface RealMatrixcreateMatrix in class AbstractRealMatrixrowDimension - 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 BlockRealMatrix copy()
copy in interface RealMatrixcopy in class AbstractRealMatrix
public BlockRealMatrix add(RealMatrix m)
throws IllegalArgumentException
add in interface RealMatrixadd in class AbstractRealMatrixm - matrix to be added
IllegalArgumentException - if m is not the same size as this
public BlockRealMatrix add(BlockRealMatrix m)
throws IllegalArgumentException
m.
m - matrix to be added
IllegalArgumentException - if m is not the same size as this
public BlockRealMatrix subtract(RealMatrix m)
throws IllegalArgumentException
subtract in interface RealMatrixsubtract in class AbstractRealMatrixm - matrix to be subtracted
IllegalArgumentException - if m is not the same size as this
public BlockRealMatrix subtract(BlockRealMatrix m)
throws IllegalArgumentException
m.
m - matrix to be subtracted
IllegalArgumentException - if m is not the same size as this
public BlockRealMatrix scalarAdd(double d)
throws IllegalArgumentException
scalarAdd in interface RealMatrixscalarAdd in class AbstractRealMatrixd - value to be added to each entry
IllegalArgumentException
public RealMatrix scalarMultiply(double d)
throws IllegalArgumentException
scalarMultiply in interface RealMatrixscalarMultiply in class AbstractRealMatrixd - value to multiply all entries by
IllegalArgumentException
public BlockRealMatrix multiply(RealMatrix m)
throws IllegalArgumentException
multiply in interface RealMatrixmultiply in class AbstractRealMatrixm - matrix to postmultiply by
IllegalArgumentException - if columnDimension(this) != rowDimension(m)
public BlockRealMatrix multiply(BlockRealMatrix m)
throws IllegalArgumentException
m - matrix to postmultiply by
IllegalArgumentException - if columnDimension(this) != rowDimension(m)public double[][] getData()
getData in interface RealMatrixgetData in class AbstractRealMatrixpublic double getNorm()
getNorm in interface RealMatrixgetNorm in class AbstractRealMatrixpublic double getFrobeniusNorm()
getFrobeniusNorm in interface RealMatrixgetFrobeniusNorm in class AbstractRealMatrix
public BlockRealMatrix getSubMatrix(int startRow,
int endRow,
int startColumn,
int endColumn)
throws MatrixIndexException
getSubMatrix in interface RealMatrixgetSubMatrix in class AbstractRealMatrixstartRow - 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(double[][] 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 RealMatrixsetSubMatrix in class AbstractRealMatrixsubMatrix - 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 BlockRealMatrix getRowMatrix(int row)
throws MatrixIndexException
row
as a row matrix. Row indices start at 0.
getRowMatrix in interface RealMatrixgetRowMatrix in class AbstractRealMatrixrow - the row to be fetched
MatrixIndexException - if the specified row index is invalid
public void setRowMatrix(int row,
RealMatrix matrix)
throws MatrixIndexException,
InvalidMatrixException
row
as a row matrix. Row indices start at 0.
setRowMatrix in interface RealMatrixsetRowMatrix in class AbstractRealMatrixrow - 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,
BlockRealMatrix 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 BlockRealMatrix getColumnMatrix(int column)
throws MatrixIndexException
column
as a column matrix. Column indices start at 0.
getColumnMatrix in interface RealMatrixgetColumnMatrix in class AbstractRealMatrixcolumn - the column to be fetched
MatrixIndexException - if the specified column index is invalid
public void setColumnMatrix(int column,
RealMatrix matrix)
throws MatrixIndexException,
InvalidMatrixException
column
as a column matrix. Column indices start at 0.
setColumnMatrix in interface RealMatrixsetColumnMatrix in class AbstractRealMatrixcolumn - 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 RealVector getRowVector(int row)
throws MatrixIndexException
row
as a vector. Row indices start at 0.
getRowVector in interface RealMatrixgetRowVector in class AbstractRealMatrixrow - the row to be fetched
MatrixIndexException - if the specified row index is invalid
public void setRowVector(int row,
RealVector vector)
throws MatrixIndexException,
InvalidMatrixException
row
as a vector. Row indices start at 0.
setRowVector in interface RealMatrixsetRowVector in class AbstractRealMatrixrow - 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 RealVector getColumnVector(int column)
throws MatrixIndexException
column
as a vector. Column indices start at 0.
getColumnVector in interface RealMatrixgetColumnVector in class AbstractRealMatrixcolumn - the column to be fetched
MatrixIndexException - if the specified column index is invalid
public void setColumnVector(int column,
RealVector vector)
throws MatrixIndexException,
InvalidMatrixException
column
as a vector. Column indices start at 0.
setColumnVector in interface RealMatrixsetColumnVector in class AbstractRealMatrixcolumn - 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 double[] 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 RealMatrixgetRow in class AbstractRealMatrixrow - the row to be fetched
MatrixIndexException - if the specified row index is not valid
public void setRow(int row,
double[] array)
throws MatrixIndexException,
InvalidMatrixException
row
as a row matrix. Row indices start at 0.
setRow in interface RealMatrixsetRow in class AbstractRealMatrixrow - 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 double[] 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 RealMatrixgetColumn in class AbstractRealMatrixcolumn - the column to be fetched
MatrixIndexException - if the specified column index is not valid
public void setColumn(int column,
double[] array)
throws MatrixIndexException,
InvalidMatrixException
column
as a column matrix. Column indices start at 0.
setColumn in interface RealMatrixsetColumn in class AbstractRealMatrixcolumn - 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 double 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 RealMatrixgetEntry in class AbstractRealMatrixrow - 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,
double value)
throws MatrixIndexException
Row and column indices start at 0 and must satisfy
0 <= row < rowDimension 0 <= column < columnDimensionMatrixIndexException is thrown.
setEntry in interface RealMatrixsetEntry in class AbstractRealMatrixrow - 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,
double increment)
throws MatrixIndexException
Row and column indices start at 0 and must satisfy
0 <= row < rowDimension 0 <= column < columnDimensionMatrixIndexException is thrown.
addToEntry in interface RealMatrixaddToEntry in class AbstractRealMatrixrow - 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,
double factor)
throws MatrixIndexException
Row and column indices start at 0 and must satisfy
0 <= row < rowDimension 0 <= column < columnDimensionMatrixIndexException is thrown.
multiplyEntry in interface RealMatrixmultiplyEntry in class AbstractRealMatrixrow - 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 BlockRealMatrix transpose()
transpose in interface RealMatrixtranspose in class AbstractRealMatrixpublic int getRowDimension()
getRowDimension in interface AnyMatrixgetRowDimension in class AbstractRealMatrixpublic int getColumnDimension()
getColumnDimension in interface AnyMatrixgetColumnDimension in class AbstractRealMatrix
public double[] operate(double[] v)
throws IllegalArgumentException
v.
operate in interface RealMatrixoperate in class AbstractRealMatrixv - the vector to operate on
IllegalArgumentException - if columnDimension != v.size()
public double[] preMultiply(double[] v)
throws IllegalArgumentException
v.
preMultiply in interface RealMatrixpreMultiply in class AbstractRealMatrixv - the row vector to premultiply by
IllegalArgumentException - if rowDimension != v.size()
public double walkInRowOrder(RealMatrixChangingVisitor 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 RealMatrixwalkInRowOrder in class AbstractRealMatrixvisitor - visitor used to process all matrix entries
RealMatrixChangingVisitor.end() at the end
of the walk
MatrixVisitorException - if the visitor cannot process an entryRealMatrix.walkInRowOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
public double walkInRowOrder(RealMatrixPreservingVisitor 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 RealMatrixwalkInRowOrder in class AbstractRealMatrixvisitor - visitor used to process all matrix entries
RealMatrixPreservingVisitor.end() at the end
of the walk
MatrixVisitorException - if the visitor cannot process an entryRealMatrix.walkInRowOrder(RealMatrixChangingVisitor),
RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
public double walkInRowOrder(RealMatrixChangingVisitor 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 RealMatrixwalkInRowOrder in class AbstractRealMatrixvisitor - visitor used to process all matrix entriesstartRow - Initial row indexendRow - Final row index (inclusive)startColumn - Initial column indexendColumn - Final column index
RealMatrixChangingVisitor.end() at the end
of the walk
MatrixIndexException - if the indices are not valid
MatrixVisitorException - if the visitor cannot process an entryRealMatrix.walkInRowOrder(RealMatrixChangingVisitor),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
public double walkInRowOrder(RealMatrixPreservingVisitor 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 RealMatrixwalkInRowOrder in class AbstractRealMatrixvisitor - visitor used to process all matrix entriesstartRow - Initial row indexendRow - Final row index (inclusive)startColumn - Initial column indexendColumn - Final column index
RealMatrixPreservingVisitor.end() at the end
of the walk
MatrixIndexException - if the indices are not valid
MatrixVisitorException - if the visitor cannot process an entryRealMatrix.walkInRowOrder(RealMatrixChangingVisitor),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
public double walkInOptimizedOrder(RealMatrixChangingVisitor 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 RealMatrixwalkInOptimizedOrder in class AbstractRealMatrixvisitor - visitor used to process all matrix entries
RealMatrixChangingVisitor.end() at the end
of the walk
MatrixVisitorException - if the visitor cannot process an entryRealMatrix.walkInRowOrder(RealMatrixChangingVisitor),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
public double walkInOptimizedOrder(RealMatrixPreservingVisitor 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 RealMatrixwalkInOptimizedOrder in class AbstractRealMatrixvisitor - visitor used to process all matrix entries
RealMatrixPreservingVisitor.end() at the end
of the walk
MatrixVisitorException - if the visitor cannot process an entryRealMatrix.walkInRowOrder(RealMatrixChangingVisitor),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
public double walkInOptimizedOrder(RealMatrixChangingVisitor 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 RealMatrixwalkInOptimizedOrder in class AbstractRealMatrixvisitor - visitor used to process all matrix entriesstartRow - Initial row indexendRow - Final row index (inclusive)startColumn - Initial column indexendColumn - Final column index (inclusive)
RealMatrixChangingVisitor.end() at the end
of the walk
MatrixIndexException - if the indices are not valid
MatrixVisitorException - if the visitor cannot process an entryRealMatrix.walkInRowOrder(RealMatrixChangingVisitor),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
public double walkInOptimizedOrder(RealMatrixPreservingVisitor 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 RealMatrixwalkInOptimizedOrder in class AbstractRealMatrixvisitor - visitor used to process all matrix entriesstartRow - Initial row indexendRow - Final row index (inclusive)startColumn - Initial column indexendColumn - Final column index (inclusive)
RealMatrixPreservingVisitor.end() at the end
of the walk
MatrixIndexException - if the indices are not valid
MatrixVisitorException - if the visitor cannot process an entryRealMatrix.walkInRowOrder(RealMatrixChangingVisitor),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int),
RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor),
RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||