Interface RealMatrix
- All Superinterfaces:
AnyMatrix
,Blendable<RealMatrix>
- All Known Subinterfaces:
SparseRealMatrix
- All Known Implementing Classes:
AbstractRealMatrix
,Array2DRowRealMatrix
,BlockRealMatrix
,DiagonalMatrix
,OpenMapRealMatrix
Matrix element indexing is 0-based -- e.g., getEntry(0, 0)
returns the element in the first row, first column of the matrix.
-
Method Summary
Modifier and TypeMethodDescriptionadd
(RealMatrix m) Returns the sum ofthis
andm
.void
addToEntry
(int row, int column, double increment) Adds (in place) the specified value to the specified entry ofthis
matrix.default RealMatrix
blendArithmeticallyWith
(RealMatrix other, double blendingValue) Blend arithmetically this instance with another one.copy()
Returns a (deep) copy of this.void
copySubMatrix
(int[] selectedRows, int[] selectedColumns, double[][] destination) Copy a submatrix.void
copySubMatrix
(int startRow, int endRow, int startColumn, int endColumn, double[][] destination) Copy a submatrix.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) Get the entries at the given column index as an array.getColumnMatrix
(int column) Get the entries at the given column index as a column matrix.getColumnVector
(int column) Get the entries at the given column index as a vector.double[][]
getData()
Returns matrix entries as a two-dimensional array.double
getEntry
(int row, int column) Get the entry in the specified row and column.double
Returns the Frobenius norm of the matrix.default double
getNorm1()
Returns the maximum absolute column sum norm (L1) of the matrix.default double
Returns the maximum absolute row sum norm (L∞) of the matrix.double[]
getRow
(int row) Get the entries at the given row index.getRowMatrix
(int row) Get the entries at the given row index as a row matrix.getRowVector
(int row) Returns the entries in row numberrow
as a vector.getSubMatrix
(int[] selectedRows, int[] selectedColumns) Gets a submatrix.getSubMatrix
(int startRow, int endRow, int startColumn, int endColumn) Gets a submatrix.double
getTrace()
Returns the trace of the matrix (the sum of the elements on the main diagonal).default RealMatrix
map
(UnivariateFunction function) Acts as if implemented as:default RealMatrix
mapToSelf
(UnivariateFunction function) Replace each entry by the result of applying the function to it.Returns the result of postmultiplyingthis
bym
.void
multiplyEntry
(int row, int column, double factor) Multiplies (in place) the specified entry ofthis
matrix by the specified value.default RealMatrix
Returns the result of postmultiplyingthis
bym^T
.double[]
operate
(double[] v) Returns the result of multiplying this by the vectorv
.Returns the result of multiplying this by the vectorv
.power
(int p) Returns the result of multiplyingthis
with itselfp
times.double[]
preMultiply
(double[] v) Returns the (row) vector result of premultiplying this by the vectorv
.Returns the result of premultiplyingthis
bym
.Returns the (row) vector result of premultiplying this by the vectorv
.scalarAdd
(double d) Returns the result of addingd
to each entry ofthis
.scalarMultiply
(double d) Returns the result of multiplying each entry ofthis
byd
.void
setColumn
(int column, double[] array) Sets the specifiedcolumn
ofthis
matrix to the entries of the specifiedarray
.void
setColumnMatrix
(int column, RealMatrix matrix) Sets the specifiedcolumn
ofthis
matrix to the entries of the specified columnmatrix
.void
setColumnVector
(int column, RealVector vector) Sets the specifiedcolumn
ofthis
matrix to the entries of the specifiedvector
.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 specifiedrow
ofthis
matrix to the entries of the specifiedarray
.void
setRowMatrix
(int row, RealMatrix matrix) Sets the specifiedrow
ofthis
matrix to the entries of the specified rowmatrix
.void
setRowVector
(int row, RealVector vector) Sets the specifiedrow
ofthis
matrix to the entries of the specifiedvector
.void
setSubMatrix
(double[][] subMatrix, int row, int column) Replace the submatrix starting atrow, column
using data in the inputsubMatrix
array.Returnsthis
minusm
.Returns the transpose of this matrix.default RealMatrix
Returns the result of postmultiplyingthis^T
bym
.double
Visit (and possibly change) all matrix entries in column order.double
walkInColumnOrder
(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (and possibly change) some matrix entries in column order.double
Visit (but don't change) all matrix entries in column order.double
walkInColumnOrder
(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (but don't change) some matrix entries in column order.double
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
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
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 interface org.hipparchus.linear.AnyMatrix
getColumnDimension, getRowDimension, isSquare
-
Method Details
-
createMatrix
Create a new RealMatrix of the same type as the instance with the supplied row and column dimensions.- Parameters:
rowDimension
- the number of rows in the new matrixcolumnDimension
- the number of columns in the new matrix- Returns:
- a new matrix of the same type as the instance
- Throws:
MathIllegalArgumentException
- if row or column dimension is not positive.
-
copy
RealMatrix copy()Returns a (deep) copy of this.- Returns:
- matrix copy
-
add
Returns the sum ofthis
andm
.- Parameters:
m
- matrix to be added- Returns:
this + m
- Throws:
MathIllegalArgumentException
- ifm
is not the same size asthis
.
-
subtract
Returnsthis
minusm
.- Parameters:
m
- matrix to be subtracted- Returns:
this - m
- Throws:
MathIllegalArgumentException
- ifm
is not the same size asthis
.
-
scalarAdd
Returns the result of addingd
to each entry ofthis
.- Parameters:
d
- value to be added to each entry- Returns:
d + this
-
scalarMultiply
Returns the result of multiplying each entry ofthis
byd
.- Parameters:
d
- value to multiply all entries by- Returns:
d * this
-
multiply
Returns the result of postmultiplyingthis
bym
.- Parameters:
m
- matrix to postmultiply by- Returns:
this * m
- Throws:
MathIllegalArgumentException
- ifcolumnDimension(this) != rowDimension(m)
-
multiplyTransposed
Returns the result of postmultiplyingthis
bym^T
.This is equivalent to call
multiply
(m.transpose()
), but some implementations may avoid building the intermediate transposed matrix.- Parameters:
m
- matrix to first transpose and second postmultiply by- Returns:
this * m^T
- Throws:
MathIllegalArgumentException
- ifcolumnDimension(this) != columnDimension(m)
- Since:
- 1.3
-
transposeMultiply
Returns the result of postmultiplyingthis^T
bym
.This is equivalent to call
transpose()
.multiply(m)
, but some implementations may avoid building the intermediate transposed matrix.- Parameters:
m
- matrix to postmultiply by- Returns:
this^T * m
- Throws:
MathIllegalArgumentException
- ifcolumnDimension(this) != columnDimension(m)
- Since:
- 1.3
-
preMultiply
Returns the result of premultiplyingthis
bym
.- Parameters:
m
- matrix to premultiply by- Returns:
m * this
- Throws:
MathIllegalArgumentException
- ifrowDimension(this) != columnDimension(m)
-
power
Returns the result of multiplyingthis
with itselfp
times. Depending on the underlying storage, instability for high powers might occur.- Parameters:
p
- raisethis
to powerp
- Returns:
this^p
- Throws:
MathIllegalArgumentException
- ifp < 0
MathIllegalArgumentException
- if the matrix is not square
-
blendArithmeticallyWith
Blend arithmetically this instance with another one.- Specified by:
blendArithmeticallyWith
in interfaceBlendable<RealMatrix>
- Parameters:
other
- other instance to blend arithmetically withblendingValue
- value from smoothstep function B(x). It is expected to be between [0:1] and will throw an exception otherwise.- Returns:
- this * (1 - B(x)) + other * B(x)
-
getData
double[][] getData()Returns matrix entries as a two-dimensional array.- Returns:
- 2-dimensional array of entries
-
getNorm1
default double getNorm1()Returns the maximum absolute column sum norm (L1) of the matrix.- Returns:
- norm
-
getNormInfty
default double getNormInfty()Returns the maximum absolute row sum norm (L∞) of the matrix.- Returns:
- norm
-
getFrobeniusNorm
double getFrobeniusNorm()Returns the Frobenius norm of the matrix.- Returns:
- norm
-
getSubMatrix
RealMatrix getSubMatrix(int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Gets a submatrix. Rows and columns are indicated counting from 0 to n-1.- Parameters:
startRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)- Returns:
- The subMatrix containing the data of the specified rows and columns.
- Throws:
MathIllegalArgumentException
- if the indices are not valid.MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.
-
getSubMatrix
RealMatrix getSubMatrix(int[] selectedRows, int[] selectedColumns) throws MathIllegalArgumentException, NullArgumentException Gets a submatrix. Rows and columns are indicated counting from 0 to n-1.- Parameters:
selectedRows
- Array of row indices.selectedColumns
- Array of column indices.- Returns:
- The subMatrix containing the data in the specified rows and columns
- Throws:
NullArgumentException
- if the row or column selections arenull
MathIllegalArgumentException
- if the row or column selections are empty (zero length).MathIllegalArgumentException
- if the indices are not valid.
-
copySubMatrix
void copySubMatrix(int startRow, int endRow, int startColumn, int endColumn, double[][] destination) throws MathIllegalArgumentException Copy a submatrix. Rows and columns are indicated counting from 0 to n-1.- Parameters:
startRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)destination
- The arrays where the submatrix data should be copied (if larger than rows/columns counts, only the upper-left part will be used)- Throws:
MathIllegalArgumentException
- if the indices are not valid.MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.MathIllegalArgumentException
- if the destination array is too small.
-
copySubMatrix
void copySubMatrix(int[] selectedRows, int[] selectedColumns, double[][] destination) throws MathIllegalArgumentException, NullArgumentException Copy a submatrix. Rows and columns are indicated counting from 0 to n-1.- Parameters:
selectedRows
- Array of row indices.selectedColumns
- Array of column indices.destination
- The arrays where the submatrix data should be copied (if larger than rows/columns counts, only the upper-left part will be used)- Throws:
NullArgumentException
- if the row or column selections arenull
MathIllegalArgumentException
- if the row or column selections are empty (zero length).MathIllegalArgumentException
- if the indices are not valid.MathIllegalArgumentException
- if the destination array is too small.
-
setSubMatrix
void setSubMatrix(double[][] subMatrix, int row, int column) throws MathIllegalArgumentException, NullArgumentException Replace the submatrix starting atrow, column
using data in the inputsubMatrix
array. Indexes are 0-based.Example:
Starting with1 2 3 4 5 6 7 8 9 0 1 2
and
subMatrix = {{3, 4} {5,6}}
, invokingsetSubMatrix(subMatrix,1,1))
will result in1 2 3 4 5 3 4 8 9 5 6 2
- Parameters:
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- Throws:
MathIllegalArgumentException
- ifsubMatrix
is empty.MathIllegalArgumentException
- ifsubMatrix
does not fit into this matrix from element in(row, column)
.MathIllegalArgumentException
- ifsubMatrix
is not rectangular (not all rows have the same length) or empty.NullArgumentException
- ifsubMatrix
isnull
.
-
getRowMatrix
Get the entries at the given row index as a row matrix. Row indices start at 0.- Parameters:
row
- Row to be fetched.- Returns:
- row Matrix.
- Throws:
MathIllegalArgumentException
- if the specified row index is invalid.
-
setRowMatrix
Sets the specifiedrow
ofthis
matrix to the entries of the specified rowmatrix
. Row indices start at 0.- Parameters:
row
- Row to be set.matrix
- Row matrix to be copied (must have one row and the same number of columns as the instance).- Throws:
MathIllegalArgumentException
- if the specified row index is invalid.MathIllegalArgumentException
- if the row dimension of thematrix
is not1
, or the column dimensions ofthis
andmatrix
do not match.
-
getColumnMatrix
Get the entries at the given column index as a column matrix. Column indices start at 0.- Parameters:
column
- Column to be fetched.- Returns:
- column Matrix.
- Throws:
MathIllegalArgumentException
- if the specified column index is invalid.
-
setColumnMatrix
Sets the specifiedcolumn
ofthis
matrix to the entries of the specified columnmatrix
. Column indices start at 0.- Parameters:
column
- Column to be set.matrix
- Column matrix to be copied (must have one column and the same number of rows as the instance).- Throws:
MathIllegalArgumentException
- if the specified column index is invalid.MathIllegalArgumentException
- if the column dimension of thematrix
is not1
, or the row dimensions ofthis
andmatrix
do not match.
-
getRowVector
Returns the entries in row numberrow
as a vector. Row indices start at 0.- Parameters:
row
- Row to be fetched.- Returns:
- a row vector.
- Throws:
MathIllegalArgumentException
- if the specified row index is invalid.
-
setRowVector
Sets the specifiedrow
ofthis
matrix to the entries of the specifiedvector
. Row indices start at 0.- Parameters:
row
- Row to be set.vector
- row vector to be copied (must have the same number of column as the instance).- Throws:
MathIllegalArgumentException
- if the specified row index is invalid.MathIllegalArgumentException
- if thevector
dimension does not match the column dimension ofthis
matrix.
-
getColumnVector
Get the entries at the given column index as a vector. Column indices start at 0.- Parameters:
column
- Column to be fetched.- Returns:
- a column vector.
- Throws:
MathIllegalArgumentException
- if the specified column index is invalid
-
setColumnVector
Sets the specifiedcolumn
ofthis
matrix to the entries of the specifiedvector
. Column indices start at 0.- Parameters:
column
- Column to be set.vector
- column vector to be copied (must have the same number of rows as the instance).- Throws:
MathIllegalArgumentException
- if the specified column index is invalid.MathIllegalArgumentException
- if thevector
dimension does not match the row dimension ofthis
matrix.
-
getRow
Get the entries at the given row index. Row indices start at 0.- Parameters:
row
- Row to be fetched.- Returns:
- the array of entries in the row.
- Throws:
MathIllegalArgumentException
- if the specified row index is not valid.
-
setRow
Sets the specifiedrow
ofthis
matrix to the entries of the specifiedarray
. Row indices start at 0.- Parameters:
row
- Row to be set.array
- Row matrix to be copied (must have the same number of columns as the instance)- Throws:
MathIllegalArgumentException
- if the specified row index is invalid.MathIllegalArgumentException
- if thearray
length does not match the column dimension ofthis
matrix.
-
getColumn
Get the entries at the given column index as an array. Column indices start at 0.- Parameters:
column
- Column to be fetched.- Returns:
- the array of entries in the column.
- Throws:
MathIllegalArgumentException
- if the specified column index is not valid.
-
setColumn
Sets the specifiedcolumn
ofthis
matrix to the entries of the specifiedarray
. Column indices start at 0.- Parameters:
column
- Column to be set.array
- Column array to be copied (must have the same number of rows as the instance).- Throws:
MathIllegalArgumentException
- if the specified column index is invalid.MathIllegalArgumentException
- if thearray
length does not match the row dimension ofthis
matrix.
-
getEntry
Get the entry in the specified row and column. Row and column indices start at 0.- Parameters:
row
- Row index of entry to be fetched.column
- Column index of entry to be fetched.- Returns:
- the matrix entry at
(row, column)
. - Throws:
MathIllegalArgumentException
- if the row or column index is not valid.
-
setEntry
Set the entry in the specified row and column. Row and column indices start at 0.- Parameters:
row
- Row index of entry to be set.column
- Column index of entry to be set.value
- the new value of the entry.- Throws:
MathIllegalArgumentException
- if the row or column index is not valid
-
addToEntry
Adds (in place) the specified value to the specified entry ofthis
matrix. Row and column indices start at 0.- Parameters:
row
- Row index of the entry to be modified.column
- Column index of the entry to be modified.increment
- value to add to the matrix entry.- Throws:
MathIllegalArgumentException
- if the row or column index is not valid.
-
multiplyEntry
Multiplies (in place) the specified entry ofthis
matrix by the specified value. Row and column indices start at 0.- Parameters:
row
- Row index of the entry to be modified.column
- Column index of the entry to be modified.factor
- Multiplication factor for the matrix entry.- Throws:
MathIllegalArgumentException
- if the row or column index is not valid.
-
transpose
RealMatrix transpose()Returns the transpose of this matrix.- Returns:
- transpose matrix
-
getTrace
Returns the trace of the matrix (the sum of the elements on the main diagonal).- Returns:
- the trace.
- Throws:
MathIllegalArgumentException
- if the matrix is not square.
-
operate
Returns the result of multiplying this by the vectorv
.- Parameters:
v
- the vector to operate on- Returns:
this * v
- Throws:
MathIllegalArgumentException
- if the length ofv
does not match the column dimension ofthis
.
-
operate
Returns the result of multiplying this by the vectorv
.- Parameters:
v
- the vector to operate on- Returns:
this * v
- Throws:
MathIllegalArgumentException
- if the dimension ofv
does not match the column dimension ofthis
.
-
preMultiply
Returns the (row) vector result of premultiplying this by the vectorv
.- Parameters:
v
- the row vector to premultiply by- Returns:
v * this
- Throws:
MathIllegalArgumentException
- if the length ofv
does not match the row dimension ofthis
.
-
preMultiply
Returns the (row) vector result of premultiplying this by the vectorv
.- Parameters:
v
- the row vector to premultiply by- Returns:
v * this
- Throws:
MathIllegalArgumentException
- if the dimension ofv
does not match the row dimension ofthis
.
-
walkInRowOrder
Visit (and possibly change) all matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixChangingVisitor.end()
at the end of the walk - See Also:
-
walkInRowOrder(RealMatrixPreservingVisitor)
walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixChangingVisitor)
walkInColumnOrder(RealMatrixPreservingVisitor)
walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixChangingVisitor)
walkInOptimizedOrder(RealMatrixPreservingVisitor)
walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInRowOrder
Visit (but don't change) all matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixPreservingVisitor.end()
at the end of the walk - See Also:
-
walkInRowOrder(RealMatrixChangingVisitor)
walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixChangingVisitor)
walkInColumnOrder(RealMatrixPreservingVisitor)
walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixChangingVisitor)
walkInOptimizedOrder(RealMatrixPreservingVisitor)
walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInRowOrder
double walkInRowOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Visit (and possibly change) some matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Parameters:
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index- Returns:
- the value returned by
RealMatrixChangingVisitor.end()
at the end of the walk - Throws:
MathIllegalArgumentException
- if the indices are not valid.MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
walkInRowOrder(RealMatrixChangingVisitor)
walkInRowOrder(RealMatrixPreservingVisitor)
walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixChangingVisitor)
walkInColumnOrder(RealMatrixPreservingVisitor)
walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixChangingVisitor)
walkInOptimizedOrder(RealMatrixPreservingVisitor)
walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInRowOrder
double walkInRowOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Visit (but don't change) some matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Parameters:
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index- Returns:
- the value returned by
RealMatrixPreservingVisitor.end()
at the end of the walk - Throws:
MathIllegalArgumentException
- if the indices are not valid.MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
walkInRowOrder(RealMatrixChangingVisitor)
walkInRowOrder(RealMatrixPreservingVisitor)
walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixChangingVisitor)
walkInColumnOrder(RealMatrixPreservingVisitor)
walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixChangingVisitor)
walkInOptimizedOrder(RealMatrixPreservingVisitor)
walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInColumnOrder
Visit (and possibly change) all matrix entries in column order.Column order starts at upper left and iterating through all elements of a column from top to bottom before going to the topmost element of the next column.
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixChangingVisitor.end()
at the end of the walk - See Also:
-
walkInRowOrder(RealMatrixChangingVisitor)
walkInRowOrder(RealMatrixPreservingVisitor)
walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixPreservingVisitor)
walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixChangingVisitor)
walkInOptimizedOrder(RealMatrixPreservingVisitor)
walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInColumnOrder
Visit (but don't change) all matrix entries in column order.Column order starts at upper left and iterating through all elements of a column from top to bottom before going to the topmost element of the next column.
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixPreservingVisitor.end()
at the end of the walk - See Also:
-
walkInRowOrder(RealMatrixChangingVisitor)
walkInRowOrder(RealMatrixPreservingVisitor)
walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixChangingVisitor)
walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixChangingVisitor)
walkInOptimizedOrder(RealMatrixPreservingVisitor)
walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInColumnOrder
double walkInColumnOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Visit (and possibly change) some matrix entries in column order.Column order starts at upper left and iterating through all elements of a column from top to bottom before going to the topmost element of the next column.
- Parameters:
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index- Returns:
- the value returned by
RealMatrixChangingVisitor.end()
at the end of the walk - Throws:
MathIllegalArgumentException
- if the indices are not valid.MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
walkInRowOrder(RealMatrixChangingVisitor)
walkInRowOrder(RealMatrixPreservingVisitor)
walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixChangingVisitor)
walkInColumnOrder(RealMatrixPreservingVisitor)
walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixChangingVisitor)
walkInOptimizedOrder(RealMatrixPreservingVisitor)
walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInColumnOrder
double walkInColumnOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Visit (but don't change) some matrix entries in column order.Column order starts at upper left and iterating through all elements of a column from top to bottom before going to the topmost element of the next column.
- Parameters:
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index- Returns:
- the value returned by
RealMatrixPreservingVisitor.end()
at the end of the walk - Throws:
MathIllegalArgumentException
- if the indices are not valid.MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
walkInRowOrder(RealMatrixChangingVisitor)
walkInRowOrder(RealMatrixPreservingVisitor)
walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixChangingVisitor)
walkInColumnOrder(RealMatrixPreservingVisitor)
walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixChangingVisitor)
walkInOptimizedOrder(RealMatrixPreservingVisitor)
walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInOptimizedOrder
Visit (and possibly change) all matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixChangingVisitor.end()
at the end of the walk - See Also:
-
walkInRowOrder(RealMatrixChangingVisitor)
walkInRowOrder(RealMatrixPreservingVisitor)
walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixChangingVisitor)
walkInColumnOrder(RealMatrixPreservingVisitor)
walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixPreservingVisitor)
walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInOptimizedOrder
Visit (but don't change) all matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixPreservingVisitor.end()
at the end of the walk - See Also:
-
walkInRowOrder(RealMatrixChangingVisitor)
walkInRowOrder(RealMatrixPreservingVisitor)
walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixChangingVisitor)
walkInColumnOrder(RealMatrixPreservingVisitor)
walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixChangingVisitor)
walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInOptimizedOrder
double walkInOptimizedOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Visit (and possibly change) some matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Parameters:
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)- Returns:
- the value returned by
RealMatrixChangingVisitor.end()
at the end of the walk - Throws:
MathIllegalArgumentException
- if the indices are not valid.MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
walkInRowOrder(RealMatrixChangingVisitor)
walkInRowOrder(RealMatrixPreservingVisitor)
walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixChangingVisitor)
walkInColumnOrder(RealMatrixPreservingVisitor)
walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixChangingVisitor)
walkInOptimizedOrder(RealMatrixPreservingVisitor)
walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInOptimizedOrder
double walkInOptimizedOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Visit (but don't change) some matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Parameters:
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)- Returns:
- the value returned by
RealMatrixPreservingVisitor.end()
at the end of the walk - Throws:
MathIllegalArgumentException
- if the indices are not valid.MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
walkInRowOrder(RealMatrixChangingVisitor)
walkInRowOrder(RealMatrixPreservingVisitor)
walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixChangingVisitor)
walkInColumnOrder(RealMatrixPreservingVisitor)
walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(RealMatrixChangingVisitor)
walkInOptimizedOrder(RealMatrixPreservingVisitor)
walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)
-
map
Acts as if implemented as:return copy().mapToSelf(function);
Returns a new matrix. Does not change instance data.- Parameters:
function
- Function to apply to each entry.- Returns:
- a new matrix.
- Since:
- 1.7
-
mapToSelf
Replace each entry by the result of applying the function to it.- Parameters:
function
- Function to apply to each entry.- Returns:
- a reference to this matrix.
- Since:
- 1.7
-