Class AbstractRealMatrix
- java.lang.Object
-
- org.apache.commons.math4.legacy.linear.RealLinearOperator
-
- org.apache.commons.math4.legacy.linear.AbstractRealMatrix
-
- All Implemented Interfaces:
AnyMatrix,RealMatrix
- Direct Known Subclasses:
Array2DRowRealMatrix,BlockRealMatrix,DiagonalMatrix,OpenMapRealMatrix
public abstract class AbstractRealMatrix extends RealLinearOperator implements RealMatrix
Basic implementation of RealMatrix methods regardless of the underlying storage.All the methods implemented here use
getEntry(int, int)to access matrix elements. Derived class can provide faster implementations.- Since:
- 2.0
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractRealMatrix()Creates a matrix with no data.protectedAbstractRealMatrix(int rowDimension, int columnDimension)Create a new RealMatrix with the supplied row and column dimensions.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description RealMatrixadd(RealMatrix m)Returns the sum ofthisandm.voidaddToEntry(int row, int column, double increment)Adds (in place) the specified value to the specified entry ofthismatrix.abstract RealMatrixcopy()Returns a (deep) copy of this.voidcopySubMatrix(int[] selectedRows, int[] selectedColumns, double[][] destination)Copy a submatrix.voidcopySubMatrix(int startRow, int endRow, int startColumn, int endColumn, double[][] destination)Copy a submatrix.abstract RealMatrixcreateMatrix(int rowDimension, int columnDimension)Create a new RealMatrix of the same type as the instance with the supplied row and column dimensions.booleanequals(Object object)Returns true iffobjectis aRealMatrixinstance with the same dimensions as this and all corresponding matrix entries are equal.double[]getColumn(int column)Get the entries at the given column index as an array.RealMatrixgetColumnMatrix(int column)Get the entries at the given column index as a column matrix.RealVectorgetColumnVector(int column)Get the entries at the given column index as a vector.double[][]getData()Returns matrix entries as a two-dimensional array.abstract doublegetEntry(int row, int column)Get the entry in the specified row and column.doublegetFrobeniusNorm()Returns the Frobenius norm of the matrix.doublegetNorm()Returns the maximum absolute row sum norm of the matrix.double[]getRow(int row)Get the entries at the given row index.RealMatrixgetRowMatrix(int row)Get the entries at the given row index as a row matrix.RealVectorgetRowVector(int row)Returns the entries in row numberrowas a vector.RealMatrixgetSubMatrix(int[] selectedRows, int[] selectedColumns)Gets a submatrix.RealMatrixgetSubMatrix(int startRow, int endRow, int startColumn, int endColumn)Gets a submatrix.doublegetTrace()Returns the trace of the matrix (the sum of the elements on the main diagonal).inthashCode()Computes a hashcode for the matrix.RealMatrixmultiply(RealMatrix m)Returns the result of postmultiplyingthisbym.voidmultiplyEntry(int row, int column, double factor)Multiplies (in place) the specified entry ofthismatrix by the specified value.double[]operate(double[] v)Returns the result of multiplying this by the vectorv.RealVectoroperate(RealVector v)Returns the result of multiplyingthisby the vectorx.RealMatrixpower(int p)Returns the result of multiplyingthiswith itselfptimes.double[]preMultiply(double[] v)Returns the (row) vector result of premultiplying this by the vectorv.RealMatrixpreMultiply(RealMatrix m)Returns the result of premultiplyingthisbym.RealVectorpreMultiply(RealVector v)Returns the (row) vector result of premultiplying this by the vectorv.RealMatrixscalarAdd(double d)Returns the result of addingdto each entry ofthis.RealMatrixscalarMultiply(double d)Returns the result of multiplying each entry ofthisbyd.voidsetColumn(int column, double[] array)Sets the specifiedcolumnofthismatrix to the entries of the specifiedarray.voidsetColumnMatrix(int column, RealMatrix matrix)Sets the specifiedcolumnofthismatrix to the entries of the specified columnmatrix.voidsetColumnVector(int column, RealVector vector)Sets the specifiedcolumnofthismatrix to the entries of the specifiedvector.abstract voidsetEntry(int row, int column, double value)Set the entry in the specified row and column.voidsetRow(int row, double[] array)Sets the specifiedrowofthismatrix to the entries of the specifiedarray.voidsetRowMatrix(int row, RealMatrix matrix)Sets the specifiedrowofthismatrix to the entries of the specified rowmatrix.voidsetRowVector(int row, RealVector vector)Sets the specifiedrowofthismatrix to the entries of the specifiedvector.voidsetSubMatrix(double[][] subMatrix, int row, int column)Replace the submatrix starting atrow, columnusing data in the inputsubMatrixarray.RealMatrixsubtract(RealMatrix m)Returnsthisminusm.StringtoString()Get a string representation for this matrix.RealMatrixtranspose()Returns the transpose of this matrix.doublewalkInColumnOrder(RealMatrixChangingVisitor visitor)Visit (and possibly change) all matrix entries in column order.doublewalkInColumnOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn)Visit (and possibly change) some matrix entries in column order.doublewalkInColumnOrder(RealMatrixPreservingVisitor visitor)Visit (but don't change) all matrix entries in column order.doublewalkInColumnOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn)Visit (but don't change) some matrix entries in column order.doublewalkInOptimizedOrder(RealMatrixChangingVisitor visitor)Visit (and possibly change) all matrix entries using the fastest possible order.doublewalkInOptimizedOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn)Visit (and possibly change) some matrix entries using the fastest possible order.doublewalkInOptimizedOrder(RealMatrixPreservingVisitor visitor)Visit (but don't change) all matrix entries using the fastest possible order.doublewalkInOptimizedOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn)Visit (but don't change) some matrix entries using the fastest possible order.doublewalkInRowOrder(RealMatrixChangingVisitor visitor)Visit (and possibly change) all matrix entries in row order.doublewalkInRowOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn)Visit (and possibly change) some matrix entries in row order.doublewalkInRowOrder(RealMatrixPreservingVisitor visitor)Visit (but don't change) all matrix entries in row order.doublewalkInRowOrder(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.math4.legacy.linear.RealLinearOperator
getColumnDimension, getRowDimension, isTransposable, operateTranspose
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.commons.math4.legacy.linear.AnyMatrix
canAdd, canMultiply, checkAdd, checkMultiply, getColumnDimension, getRowDimension, isSquare
-
-
-
-
Constructor Detail
-
AbstractRealMatrix
protected AbstractRealMatrix()
Creates a matrix with no data.
-
AbstractRealMatrix
protected AbstractRealMatrix(int rowDimension, int columnDimension) throws NotStrictlyPositiveException
Create a new RealMatrix 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- Throws:
NotStrictlyPositiveException- if row or column dimension is not positive
-
-
Method Detail
-
add
public RealMatrix add(RealMatrix m) throws MatrixDimensionMismatchException
Returns the sum ofthisandm.- Specified by:
addin interfaceRealMatrix- Parameters:
m- matrix to be added- Returns:
this + m- Throws:
MatrixDimensionMismatchException- ifmis not the same size asthis.
-
subtract
public RealMatrix subtract(RealMatrix m) throws MatrixDimensionMismatchException
Returnsthisminusm.- Specified by:
subtractin interfaceRealMatrix- Parameters:
m- matrix to be subtracted- Returns:
this - m- Throws:
MatrixDimensionMismatchException- ifmis not the same size asthis.
-
scalarAdd
public RealMatrix scalarAdd(double d)
Returns the result of addingdto each entry ofthis.- Specified by:
scalarAddin interfaceRealMatrix- Parameters:
d- value to be added to each entry- Returns:
d + this
-
scalarMultiply
public RealMatrix scalarMultiply(double d)
Returns the result of multiplying each entry ofthisbyd.- Specified by:
scalarMultiplyin interfaceRealMatrix- Parameters:
d- value to multiply all entries by- Returns:
d * this
-
multiply
public RealMatrix multiply(RealMatrix m) throws DimensionMismatchException
Returns the result of postmultiplyingthisbym.- Specified by:
multiplyin interfaceRealMatrix- Parameters:
m- matrix to postmultiply by- Returns:
this * m- Throws:
DimensionMismatchException- ifcolumnDimension(this) != rowDimension(m)
-
preMultiply
public RealMatrix preMultiply(RealMatrix m) throws DimensionMismatchException
Returns the result of premultiplyingthisbym.- Specified by:
preMultiplyin interfaceRealMatrix- Parameters:
m- matrix to premultiply by- Returns:
m * this- Throws:
DimensionMismatchException- ifrowDimension(this) != columnDimension(m)
-
power
public RealMatrix power(int p) throws NotPositiveException, NonSquareMatrixException
Returns the result of multiplyingthiswith itselfptimes. Depending on the underlying storage, instability for high powers might occur.- Specified by:
powerin interfaceRealMatrix- Parameters:
p- raisethisto powerp- Returns:
this^p- Throws:
NotPositiveException- ifp < 0NonSquareMatrixException- if the matrix is not square
-
getData
public double[][] getData()
Returns matrix entries as a two-dimensional array.- Specified by:
getDatain interfaceRealMatrix- Returns:
- 2-dimensional array of entries
-
getNorm
public double getNorm()
Returns the maximum absolute row sum norm of the matrix.- Specified by:
getNormin interfaceRealMatrix- Returns:
- norm
-
getFrobeniusNorm
public double getFrobeniusNorm()
Returns the Frobenius norm of the matrix.- Specified by:
getFrobeniusNormin interfaceRealMatrix- Returns:
- norm
-
getSubMatrix
public RealMatrix getSubMatrix(int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException
Gets a submatrix. Rows and columns are indicated counting from 0 to n-1.- Specified by:
getSubMatrixin interfaceRealMatrix- 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:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.
-
getSubMatrix
public RealMatrix getSubMatrix(int[] selectedRows, int[] selectedColumns) throws NullArgumentException, NoDataException, OutOfRangeException
Gets a submatrix. Rows and columns are indicated counting from 0 to n-1.- Specified by:
getSubMatrixin interfaceRealMatrix- 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 arenullNoDataException- if the row or column selections are empty (zero length).OutOfRangeException- if the indices are not valid.
-
copySubMatrix
public void copySubMatrix(int startRow, int endRow, int startColumn, int endColumn, double[][] destination) throws OutOfRangeException, NumberIsTooSmallException, MatrixDimensionMismatchException
Copy a submatrix. Rows and columns are indicated counting from 0 to n-1.- Specified by:
copySubMatrixin interfaceRealMatrix- 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:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.MatrixDimensionMismatchException- if the destination array is too small.
-
copySubMatrix
public void copySubMatrix(int[] selectedRows, int[] selectedColumns, double[][] destination) throws OutOfRangeException, NullArgumentException, NoDataException, MatrixDimensionMismatchException
Copy a submatrix. Rows and columns are indicated counting from 0 to n-1.- Specified by:
copySubMatrixin interfaceRealMatrix- 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:
OutOfRangeException- if the indices are not valid.NullArgumentException- if the row or column selections arenullNoDataException- if the row or column selections are empty (zero length).MatrixDimensionMismatchException- if the destination array is too small.
-
setSubMatrix
public void setSubMatrix(double[][] subMatrix, int row, int column) throws NoDataException, OutOfRangeException, DimensionMismatchException, NullArgumentException
Replace the submatrix starting atrow, columnusing data in the inputsubMatrixarray. Indexes are 0-based.Example:
Starting with1 2 3 4 5 6 7 8 9 0 1 2
andsubMatrix = {{3, 4} {5,6}}, invokingsetSubMatrix(subMatrix,1,1))will result in1 2 3 4 5 3 4 8 9 5 6 2
- Specified by:
setSubMatrixin interfaceRealMatrix- 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:
NoDataException- ifsubMatrixis empty.OutOfRangeException- ifsubMatrixdoes not fit into this matrix from element in(row, column).DimensionMismatchException- ifsubMatrixis not rectangular (not all rows have the same length) or empty.NullArgumentException- ifsubMatrixisnull.
-
getRowMatrix
public RealMatrix getRowMatrix(int row) throws OutOfRangeException
Get the entries at the given row index as a row matrix. Row indices start at 0.- Specified by:
getRowMatrixin interfaceRealMatrix- Parameters:
row- Row to be fetched.- Returns:
- row Matrix.
- Throws:
OutOfRangeException- if the specified row index is invalid.
-
setRowMatrix
public void setRowMatrix(int row, RealMatrix matrix) throws OutOfRangeException, MatrixDimensionMismatchException
Sets the specifiedrowofthismatrix to the entries of the specified rowmatrix. Row indices start at 0.- Specified by:
setRowMatrixin interfaceRealMatrix- 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:
OutOfRangeException- if the specified row index is invalid.MatrixDimensionMismatchException- if the row dimension of thematrixis not1, or the column dimensions ofthisandmatrixdo not match.
-
getColumnMatrix
public RealMatrix getColumnMatrix(int column) throws OutOfRangeException
Get the entries at the given column index as a column matrix. Column indices start at 0.- Specified by:
getColumnMatrixin interfaceRealMatrix- Parameters:
column- Column to be fetched.- Returns:
- column Matrix.
- Throws:
OutOfRangeException- if the specified column index is invalid.
-
setColumnMatrix
public void setColumnMatrix(int column, RealMatrix matrix) throws OutOfRangeException, MatrixDimensionMismatchException
Sets the specifiedcolumnofthismatrix to the entries of the specified columnmatrix. Column indices start at 0.- Specified by:
setColumnMatrixin interfaceRealMatrix- 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:
OutOfRangeException- if the specified column index is invalid.MatrixDimensionMismatchException- if the column dimension of thematrixis not1, or the row dimensions ofthisandmatrixdo not match.
-
getRowVector
public RealVector getRowVector(int row) throws OutOfRangeException
Returns the entries in row numberrowas a vector. Row indices start at 0.- Specified by:
getRowVectorin interfaceRealMatrix- Parameters:
row- Row to be fetched.- Returns:
- a row vector.
- Throws:
OutOfRangeException- if the specified row index is invalid.
-
setRowVector
public void setRowVector(int row, RealVector vector) throws OutOfRangeException, MatrixDimensionMismatchException
Sets the specifiedrowofthismatrix to the entries of the specifiedvector. Row indices start at 0.- Specified by:
setRowVectorin interfaceRealMatrix- Parameters:
row- Row to be set.vector- row vector to be copied (must have the same number of column as the instance).- Throws:
OutOfRangeException- if the specified row index is invalid.MatrixDimensionMismatchException- if thevectordimension does not match the column dimension ofthismatrix.
-
getColumnVector
public RealVector getColumnVector(int column) throws OutOfRangeException
Get the entries at the given column index as a vector. Column indices start at 0.- Specified by:
getColumnVectorin interfaceRealMatrix- Parameters:
column- Column to be fetched.- Returns:
- a column vector.
- Throws:
OutOfRangeException- if the specified column index is invalid
-
setColumnVector
public void setColumnVector(int column, RealVector vector) throws OutOfRangeException, MatrixDimensionMismatchException
Sets the specifiedcolumnofthismatrix to the entries of the specifiedvector. Column indices start at 0.- Specified by:
setColumnVectorin interfaceRealMatrix- Parameters:
column- Column to be set.vector- column vector to be copied (must have the same number of rows as the instance).- Throws:
OutOfRangeException- if the specified column index is invalid.MatrixDimensionMismatchException- if thevectordimension does not match the row dimension ofthismatrix.
-
getRow
public double[] getRow(int row) throws OutOfRangeException
Get the entries at the given row index. Row indices start at 0.- Specified by:
getRowin interfaceRealMatrix- Parameters:
row- Row to be fetched.- Returns:
- the array of entries in the row.
- Throws:
OutOfRangeException- if the specified row index is not valid.
-
setRow
public void setRow(int row, double[] array) throws OutOfRangeException, MatrixDimensionMismatchException
Sets the specifiedrowofthismatrix to the entries of the specifiedarray. Row indices start at 0.- Specified by:
setRowin interfaceRealMatrix- Parameters:
row- Row to be set.array- Row matrix to be copied (must have the same number of columns as the instance)- Throws:
OutOfRangeException- if the specified row index is invalid.MatrixDimensionMismatchException- if thearraylength does not match the column dimension ofthismatrix.
-
getColumn
public double[] getColumn(int column) throws OutOfRangeException
Get the entries at the given column index as an array. Column indices start at 0.- Specified by:
getColumnin interfaceRealMatrix- Parameters:
column- Column to be fetched.- Returns:
- the array of entries in the column.
- Throws:
OutOfRangeException- if the specified column index is not valid.
-
setColumn
public void setColumn(int column, double[] array) throws OutOfRangeException, MatrixDimensionMismatchException
Sets the specifiedcolumnofthismatrix to the entries of the specifiedarray. Column indices start at 0.- Specified by:
setColumnin interfaceRealMatrix- Parameters:
column- Column to be set.array- Column array to be copied (must have the same number of rows as the instance).- Throws:
OutOfRangeException- if the specified column index is invalid.MatrixDimensionMismatchException- if thearraylength does not match the row dimension ofthismatrix.
-
addToEntry
public void addToEntry(int row, int column, double increment) throws OutOfRangeException
Adds (in place) the specified value to the specified entry ofthismatrix. Row and column indices start at 0.- Specified by:
addToEntryin interfaceRealMatrix- 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:
OutOfRangeException- if the row or column index is not valid.
-
multiplyEntry
public void multiplyEntry(int row, int column, double factor) throws OutOfRangeException
Multiplies (in place) the specified entry ofthismatrix by the specified value. Row and column indices start at 0.- Specified by:
multiplyEntryin interfaceRealMatrix- 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:
OutOfRangeException- if the row or column index is not valid.
-
transpose
public RealMatrix transpose()
Returns the transpose of this matrix.- Specified by:
transposein interfaceRealMatrix- Returns:
- transpose matrix
-
getTrace
public double getTrace() throws NonSquareMatrixException
Returns the trace of the matrix (the sum of the elements on the main diagonal).- Specified by:
getTracein interfaceRealMatrix- Returns:
- the trace.
- Throws:
NonSquareMatrixException- if the matrix is not square.
-
operate
public double[] operate(double[] v) throws DimensionMismatchException
Returns the result of multiplying this by the vectorv.- Specified by:
operatein interfaceRealMatrix- Parameters:
v- the vector to operate on- Returns:
this * v- Throws:
DimensionMismatchException- if the length ofvdoes not match the column dimension ofthis.
-
operate
public RealVector operate(RealVector v) throws DimensionMismatchException
Returns the result of multiplyingthisby the vectorx.- Specified by:
operatein interfaceRealMatrix- Specified by:
operatein classRealLinearOperator- Parameters:
v- the vector to operate on- Returns:
- the product of
thisinstance withx - Throws:
DimensionMismatchException- if the column dimension does not match the size ofx
-
preMultiply
public double[] preMultiply(double[] v) throws DimensionMismatchException
Returns the (row) vector result of premultiplying this by the vectorv.- Specified by:
preMultiplyin interfaceRealMatrix- Parameters:
v- the row vector to premultiply by- Returns:
v * this- Throws:
DimensionMismatchException- if the length ofvdoes not match the row dimension ofthis.
-
preMultiply
public RealVector preMultiply(RealVector v) throws DimensionMismatchException
Returns the (row) vector result of premultiplying this by the vectorv.- Specified by:
preMultiplyin interfaceRealMatrix- Parameters:
v- the row vector to premultiply by- Returns:
v * this- Throws:
DimensionMismatchException- if the dimension ofvdoes not match the row dimension ofthis.
-
walkInRowOrder
public double walkInRowOrder(RealMatrixChangingVisitor visitor)
Visit (and possibly change) all matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Specified by:
walkInRowOrderin interfaceRealMatrix- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixChangingVisitor.end()at the end of the walk - See Also:
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),RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInRowOrder
public double walkInRowOrder(RealMatrixPreservingVisitor visitor)
Visit (but don't change) all matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Specified by:
walkInRowOrderin interfaceRealMatrix- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixPreservingVisitor.end()at the end of the walk - See Also:
RealMatrix.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)
-
walkInRowOrder
public double walkInRowOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException
Visit (and possibly change) some matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Specified by:
walkInRowOrderin interfaceRealMatrix- 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:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
RealMatrix.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)
-
walkInRowOrder
public double walkInRowOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException
Visit (but don't change) some matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Specified by:
walkInRowOrderin interfaceRealMatrix- 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:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
RealMatrix.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)
-
walkInColumnOrder
public double walkInColumnOrder(RealMatrixChangingVisitor visitor)
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.
- Specified by:
walkInColumnOrderin interfaceRealMatrix- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixChangingVisitor.end()at the end of the walk - See Also:
RealMatrix.walkInRowOrder(RealMatrixChangingVisitor),RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor),RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int),RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int),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)
-
walkInColumnOrder
public double walkInColumnOrder(RealMatrixPreservingVisitor visitor)
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.
- Specified by:
walkInColumnOrderin interfaceRealMatrix- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixPreservingVisitor.end()at the end of the walk - See Also:
RealMatrix.walkInRowOrder(RealMatrixChangingVisitor),RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor),RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int),RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int),RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor),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)
-
walkInColumnOrder
public double walkInColumnOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException
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.
- Specified by:
walkInColumnOrderin interfaceRealMatrix- 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:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
RealMatrix.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(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)
-
walkInColumnOrder
public double walkInColumnOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException
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.
- Specified by:
walkInColumnOrderin interfaceRealMatrix- 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:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
RealMatrix.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.walkInOptimizedOrder(RealMatrixChangingVisitor),RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor),RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int),RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)
-
walkInOptimizedOrder
public double walkInOptimizedOrder(RealMatrixChangingVisitor visitor)
Visit (and possibly change) all matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Specified by:
walkInOptimizedOrderin interfaceRealMatrix- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixChangingVisitor.end()at the end of the walk - See Also:
RealMatrix.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)
-
walkInOptimizedOrder
public double walkInOptimizedOrder(RealMatrixPreservingVisitor visitor)
Visit (but don't change) all matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Specified by:
walkInOptimizedOrderin interfaceRealMatrix- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixPreservingVisitor.end()at the end of the walk - See Also:
RealMatrix.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)
-
walkInOptimizedOrder
public double walkInOptimizedOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException
Visit (and possibly change) some matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Specified by:
walkInOptimizedOrderin interfaceRealMatrix- 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:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
RealMatrix.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)
-
walkInOptimizedOrder
public double walkInOptimizedOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException
Visit (but don't change) some matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Specified by:
walkInOptimizedOrderin interfaceRealMatrix- 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:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
RealMatrix.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)
-
equals
public boolean equals(Object object)
Returns true iffobjectis aRealMatrixinstance with the same dimensions as this and all corresponding matrix entries are equal.
-
hashCode
public int hashCode()
Computes a hashcode for the matrix.
-
createMatrix
public abstract RealMatrix createMatrix(int rowDimension, int columnDimension) throws NotStrictlyPositiveException
Create a new RealMatrix of the same type as the instance with the supplied row and column dimensions.- Specified by:
createMatrixin interfaceRealMatrix- 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:
NotStrictlyPositiveException- if row or column dimension is not positive.
-
copy
public abstract RealMatrix copy()
Returns a (deep) copy of this.- Specified by:
copyin interfaceRealMatrix- Returns:
- matrix copy
-
getEntry
public abstract double getEntry(int row, int column) throws OutOfRangeException
Get the entry in the specified row and column. Row and column indices start at 0.- Specified by:
getEntryin interfaceRealMatrix- 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:
OutOfRangeException- if the row or column index is not valid.
-
setEntry
public abstract void setEntry(int row, int column, double value) throws OutOfRangeException
Set the entry in the specified row and column. Row and column indices start at 0.- Specified by:
setEntryin interfaceRealMatrix- 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:
OutOfRangeException- if the row or column index is not valid
-
-