Class AbstractRealMatrix
- java.lang.Object
-
- org.apache.commons.math.linear.AbstractRealMatrix
-
- All Implemented Interfaces:
AnyMatrix,RealMatrix
- Direct Known Subclasses:
Array2DRowRealMatrix,BlockRealMatrix,OpenMapRealMatrix,RealMatrixImpl
public abstract class AbstractRealMatrix extends java.lang.Object 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
- Version:
- $Revision: 1073158 $ $Date: 2011-02-21 22:46:52 +0100 (lun. 21 févr. 2011) $
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractRealMatrix()Creates a matrix with no dataprotectedAbstractRealMatrix(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 Deprecated Methods Modifier and Type Method Description RealMatrixadd(RealMatrix m)Compute the sum of this and m.abstract voidaddToEntry(int row, int column, double increment)Change an entry in the specified row and column.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(java.lang.Object object)Returns true iffobjectis aRealMatrixinstance with the same dimensions as this and all corresponding matrix entries are equal.double[]getColumn(int column)Returns the entries in column numbercolas an array.abstract intgetColumnDimension()Returns the number of columns in the matrix.RealMatrixgetColumnMatrix(int column)Returns the entries in column numbercolumnas a column matrix.RealVectorgetColumnVector(int column)Returns the entries in column numbercolumnas a vector.double[][]getData()Returns matrix entries as a two-dimensional array.doublegetDeterminant()Deprecated.abstract doublegetEntry(int row, int column)Returns 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)Returns the entries in row numberrowas an array.abstract intgetRowDimension()Returns the number of rows in the matrix.RealMatrixgetRowMatrix(int row)Returns the entries in row numberrowas 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.RealMatrixinverse()Deprecated.booleanisSingular()Deprecated.booleanisSquare()Is this a square matrix?voidluDecompose()Deprecated.as of release 2.0, replaced byLUDecompositionRealMatrixmultiply(RealMatrix m)Returns the result of postmultiplying this by m.abstract voidmultiplyEntry(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 vectorv.RealVectoroperate(RealVector v)Returns the result of multiplying this by the vectorv.double[]preMultiply(double[] v)Returns the (row) vector result of premultiplying this by the vectorv.RealMatrixpreMultiply(RealMatrix m)Returns the result premultiplying this bym.RealVectorpreMultiply(RealVector v)Returns the (row) vector result of premultiplying this by the vectorv.RealMatrixscalarAdd(double d)Returns the result of adding d to each entry of this.RealMatrixscalarMultiply(double d)Returns the result multiplying each entry of this by d.voidsetColumn(int column, double[] array)Sets the entries in column numbercolumnas a column matrix.voidsetColumnMatrix(int column, RealMatrix matrix)Sets the entries in column numbercolumnas a column matrix.voidsetColumnVector(int column, RealVector vector)Sets the entries in column numbercolumnas a vector.abstract voidsetEntry(int row, int column, double value)Set the entry in the specified row and column.voidsetRow(int row, double[] array)Sets the entries in row numberrowas a row matrix.voidsetRowMatrix(int row, RealMatrix matrix)Sets the entries in row numberrowas a row matrix.voidsetRowVector(int row, RealVector vector)Sets the entries in row numberrowas a vector.voidsetSubMatrix(double[][] subMatrix, int row, int column)Replace the submatrix starting atrow, columnusing data in the inputsubMatrixarray.double[]solve(double[] b)Deprecated.RealMatrixsolve(RealMatrix b)Deprecated.RealMatrixsubtract(RealMatrix m)Compute this minus m.java.lang.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.
-
-
-
Constructor Detail
-
AbstractRealMatrix
protected AbstractRealMatrix()
Creates a matrix with no data
-
AbstractRealMatrix
protected AbstractRealMatrix(int rowDimension, int columnDimension) throws java.lang.IllegalArgumentExceptionCreate 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:
java.lang.IllegalArgumentException- if row or column dimension is not positive
-
-
Method Detail
-
createMatrix
public abstract RealMatrix createMatrix(int rowDimension, int columnDimension) throws java.lang.IllegalArgumentException
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:
java.lang.IllegalArgumentException- 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
-
add
public RealMatrix add(RealMatrix m) throws java.lang.IllegalArgumentException
Compute the sum of this and m.- Specified by:
addin interfaceRealMatrix- Parameters:
m- matrix to be added- Returns:
- this + m
- Throws:
java.lang.IllegalArgumentException- if m is not the same size as this
-
subtract
public RealMatrix subtract(RealMatrix m) throws java.lang.IllegalArgumentException
Compute this minus m.- Specified by:
subtractin interfaceRealMatrix- Parameters:
m- matrix to be subtracted- Returns:
- this - m
- Throws:
java.lang.IllegalArgumentException- if m is not the same size as this
-
scalarAdd
public RealMatrix scalarAdd(double d)
Returns the result of adding d to each entry of this.- 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 multiplying each entry of this by d.- Specified by:
scalarMultiplyin interfaceRealMatrix- Parameters:
d- value to multiply all entries by- Returns:
- d * this
-
multiply
public RealMatrix multiply(RealMatrix m) throws java.lang.IllegalArgumentException
Returns the result of postmultiplying this by m.- Specified by:
multiplyin interfaceRealMatrix- Parameters:
m- matrix to postmultiply by- Returns:
- this * m
- Throws:
java.lang.IllegalArgumentException- if columnDimension(this) != rowDimension(m)
-
preMultiply
public RealMatrix preMultiply(RealMatrix m) throws java.lang.IllegalArgumentException
Returns the result premultiplying this bym.- Specified by:
preMultiplyin interfaceRealMatrix- Parameters:
m- matrix to premultiply by- Returns:
- m * this
- Throws:
java.lang.IllegalArgumentException- if rowDimension(this) != columnDimension(m)
-
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 MatrixIndexException
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:
MatrixIndexException- if the indices are not valid
-
getSubMatrix
public RealMatrix getSubMatrix(int[] selectedRows, int[] selectedColumns) throws MatrixIndexException
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:
MatrixIndexException- if row or column selections are not valid
-
copySubMatrix
public void copySubMatrix(int startRow, int endRow, int startColumn, int endColumn, double[][] destination) throws MatrixIndexException, java.lang.IllegalArgumentExceptionCopy 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:
MatrixIndexException- if the indices are not validjava.lang.IllegalArgumentException- if the destination array is too small
-
copySubMatrix
public void copySubMatrix(int[] selectedRows, int[] selectedColumns, double[][] destination) throws MatrixIndexException, java.lang.IllegalArgumentExceptionCopy 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:
MatrixIndexException- if the indices are not validjava.lang.IllegalArgumentException- if the destination array is too small
-
setSubMatrix
public void setSubMatrix(double[][] subMatrix, int row, int column) throws MatrixIndexExceptionReplace 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:
MatrixIndexException- if subMatrix does not fit into this matrix from element in (row, column)
-
getRowMatrix
public RealMatrix getRowMatrix(int row) throws MatrixIndexException
Returns the entries in row numberrowas a row matrix. Row indices start at 0.- Specified by:
getRowMatrixin interfaceRealMatrix- Parameters:
row- the row to be fetched- Returns:
- row matrix
- Throws:
MatrixIndexException- if the specified row index is invalid
-
setRowMatrix
public void setRowMatrix(int row, RealMatrix matrix) throws MatrixIndexException, InvalidMatrixExceptionSets the entries in row numberrowas a row matrix. Row indices start at 0.- Specified by:
setRowMatrixin interfaceRealMatrix- Parameters:
row- the row to be setmatrix- row matrix (must have one row and the same number of columns as the instance)- Throws:
MatrixIndexException- if the specified row index is invalidInvalidMatrixException- if the matrix dimensions do not match one instance row
-
getColumnMatrix
public RealMatrix getColumnMatrix(int column) throws MatrixIndexException
Returns the entries in column numbercolumnas a column matrix. Column indices start at 0.- Specified by:
getColumnMatrixin interfaceRealMatrix- Parameters:
column- the column to be fetched- Returns:
- column matrix
- Throws:
MatrixIndexException- if the specified column index is invalid
-
setColumnMatrix
public void setColumnMatrix(int column, RealMatrix matrix) throws MatrixIndexException, InvalidMatrixExceptionSets the entries in column numbercolumnas a column matrix. Column indices start at 0.- Specified by:
setColumnMatrixin interfaceRealMatrix- Parameters:
column- the column to be setmatrix- column matrix (must have one column and the same number of rows as the instance)- Throws:
MatrixIndexException- if the specified column index is invalidInvalidMatrixException- if the matrix dimensions do not match one instance column
-
getRowVector
public RealVector getRowVector(int row) throws MatrixIndexException
Returns the entries in row numberrowas a vector. Row indices start at 0.- Specified by:
getRowVectorin interfaceRealMatrix- Parameters:
row- the row to be fetched- Returns:
- row vector
- Throws:
MatrixIndexException- if the specified row index is invalid
-
setRowVector
public void setRowVector(int row, RealVector vector) throws MatrixIndexException, InvalidMatrixExceptionSets the entries in row numberrowas a vector. Row indices start at 0.- Specified by:
setRowVectorin interfaceRealMatrix- Parameters:
row- the row to be setvector- row vector (must have the same number of columns as the instance)- Throws:
MatrixIndexException- if the specified row index is invalidInvalidMatrixException- if the vector dimension does not match one instance row
-
getColumnVector
public RealVector getColumnVector(int column) throws MatrixIndexException
Returns the entries in column numbercolumnas a vector. Column indices start at 0.- Specified by:
getColumnVectorin interfaceRealMatrix- Parameters:
column- the column to be fetched- Returns:
- column vector
- Throws:
MatrixIndexException- if the specified column index is invalid
-
setColumnVector
public void setColumnVector(int column, RealVector vector) throws MatrixIndexException, InvalidMatrixExceptionSets the entries in column numbercolumnas a vector. Column indices start at 0.- Specified by:
setColumnVectorin interfaceRealMatrix- Parameters:
column- the column to be setvector- column vector (must have the same number of rows as the instance)- Throws:
MatrixIndexException- if the specified column index is invalidInvalidMatrixException- if the vector dimension does not match one instance column
-
getRow
public double[] getRow(int row) throws MatrixIndexExceptionReturns the entries in row numberrowas an array.Row indices start at 0. A
MatrixIndexExceptionis thrown unless0 <= row < rowDimension.- Specified by:
getRowin interfaceRealMatrix- Parameters:
row- the row to be fetched- Returns:
- array of entries in the row
- Throws:
MatrixIndexException- if the specified row index is not valid
-
setRow
public void setRow(int row, double[] array) throws MatrixIndexException, InvalidMatrixExceptionSets the entries in row numberrowas a row matrix. Row indices start at 0.- Specified by:
setRowin interfaceRealMatrix- Parameters:
row- the row to be setarray- row matrix (must have the same number of columns as the instance)- Throws:
MatrixIndexException- if the specified row index is invalidInvalidMatrixException- if the array size does not match one instance row
-
getColumn
public double[] getColumn(int column) throws MatrixIndexExceptionReturns the entries in column numbercolas an array.Column indices start at 0. A
MatrixIndexExceptionis thrown unless0 <= column < columnDimension.- Specified by:
getColumnin interfaceRealMatrix- Parameters:
column- the column to be fetched- Returns:
- array of entries in the column
- Throws:
MatrixIndexException- if the specified column index is not valid
-
setColumn
public void setColumn(int column, double[] array) throws MatrixIndexException, InvalidMatrixExceptionSets the entries in column numbercolumnas a column matrix. Column indices start at 0.- Specified by:
setColumnin interfaceRealMatrix- Parameters:
column- the column to be setarray- column array (must have the same number of rows as the instance)- Throws:
MatrixIndexException- if the specified column index is invalidInvalidMatrixException- if the array size does not match one instance column
-
getEntry
public abstract double getEntry(int row, int column) throws MatrixIndexExceptionReturns the entry in the specified row and column.Row and column indices start at 0 and must satisfy
0 <= row < rowDimension0 <= column < columnDimension
MatrixIndexExceptionis thrown.- Specified by:
getEntryin interfaceRealMatrix- Parameters:
row- row location of entry to be fetchedcolumn- column location of entry to be fetched- Returns:
- matrix entry in row,column
- Throws:
MatrixIndexException- if the row or column index is not valid
-
setEntry
public abstract void setEntry(int row, int column, double value) throws MatrixIndexExceptionSet the entry in the specified row and column.Row and column indices start at 0 and must satisfy
0 <= row < rowDimension0 <= column < columnDimension
MatrixIndexExceptionis thrown.- Specified by:
setEntryin interfaceRealMatrix- Parameters:
row- row location of entry to be setcolumn- column location of entry to be setvalue- matrix entry to be set in row,column- Throws:
MatrixIndexException- if the row or column index is not valid
-
addToEntry
public abstract void addToEntry(int row, int column, double increment) throws MatrixIndexExceptionChange an entry in the specified row and column.Row and column indices start at 0 and must satisfy
0 <= row < rowDimension0 <= column < columnDimension
MatrixIndexExceptionis thrown.- Specified by:
addToEntryin interfaceRealMatrix- Parameters:
row- row location of entry to be setcolumn- column location of entry to be setincrement- value to add to the current matrix entry in row,column- Throws:
MatrixIndexException- if the row or column index is not valid
-
multiplyEntry
public abstract void multiplyEntry(int row, int column, double factor) throws MatrixIndexExceptionChange an entry in the specified row and column.Row and column indices start at 0 and must satisfy
0 <= row < rowDimension0 <= column < columnDimension
MatrixIndexExceptionis thrown.- Specified by:
multiplyEntryin interfaceRealMatrix- Parameters:
row- row location of entry to be setcolumn- column location of entry to be setfactor- multiplication factor for the current matrix entry in row,column- Throws:
MatrixIndexException- 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
-
inverse
@Deprecated public RealMatrix inverse() throws InvalidMatrixException
Deprecated.Returns the inverse of this matrix.- Specified by:
inversein interfaceRealMatrix- Returns:
- inverse matrix
- Throws:
InvalidMatrixException- if this is not invertible
-
getDeterminant
@Deprecated public double getDeterminant() throws InvalidMatrixExceptionDeprecated.Returns the determinant of this matrix.- Specified by:
getDeterminantin interfaceRealMatrix- Returns:
- determinant
- Throws:
InvalidMatrixException
-
isSquare
public boolean isSquare()
Is this a square matrix?
-
isSingular
@Deprecated public boolean isSingular()
Deprecated.Is this a singular matrix?- Specified by:
isSingularin interfaceRealMatrix- Returns:
- true if the matrix is singular
-
getRowDimension
public abstract int getRowDimension()
Returns the number of rows in the matrix.- Specified by:
getRowDimensionin interfaceAnyMatrix- Returns:
- rowDimension
-
getColumnDimension
public abstract int getColumnDimension()
Returns the number of columns in the matrix.- Specified by:
getColumnDimensionin interfaceAnyMatrix- Returns:
- columnDimension
-
getTrace
public double getTrace() throws NonSquareMatrixExceptionReturns the trace of the matrix (the sum of the elements on the main diagonal).- Specified by:
getTracein interfaceRealMatrix- Returns:
- trace
- Throws:
NonSquareMatrixException- if the matrix is not square
-
operate
public double[] operate(double[] v) throws java.lang.IllegalArgumentExceptionReturns the result of multiplying this by the vectorv.- Specified by:
operatein interfaceRealMatrix- Parameters:
v- the vector to operate on- Returns:
- this*v
- Throws:
java.lang.IllegalArgumentException- if columnDimension != v.size()
-
operate
public RealVector operate(RealVector v) throws java.lang.IllegalArgumentException
Returns the result of multiplying this by the vectorv.- Specified by:
operatein interfaceRealMatrix- Parameters:
v- the vector to operate on- Returns:
- this*v
- Throws:
java.lang.IllegalArgumentException- if columnDimension != v.size()
-
preMultiply
public double[] preMultiply(double[] v) throws java.lang.IllegalArgumentExceptionReturns 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:
java.lang.IllegalArgumentException- if rowDimension != v.size()
-
preMultiply
public RealVector preMultiply(RealVector v) throws java.lang.IllegalArgumentException
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:
java.lang.IllegalArgumentException- if rowDimension != v.size()
-
walkInRowOrder
public double walkInRowOrder(RealMatrixChangingVisitor visitor) throws MatrixVisitorException
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 - Throws:
MatrixVisitorException- if the visitor cannot process an entry- 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) throws MatrixVisitorException
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 - Throws:
MatrixVisitorException- if the visitor cannot process an entry- 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 MatrixIndexException, MatrixVisitorException
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:
MatrixIndexException- if the indices are not validMatrixVisitorException- if the visitor cannot process an entry- 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 MatrixIndexException, MatrixVisitorException
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:
MatrixIndexException- if the indices are not validMatrixVisitorException- if the visitor cannot process an entry- 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) throws MatrixVisitorException
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 - Throws:
MatrixVisitorException- if the visitor cannot process an entry- 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) throws MatrixVisitorException
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 - Throws:
MatrixVisitorException- if the visitor cannot process an entry- 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 MatrixIndexException, MatrixVisitorException
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:
MatrixIndexException- if the indices are not validMatrixVisitorException- if the visitor cannot process an entry- 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 MatrixIndexException, MatrixVisitorException
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:
MatrixIndexException- if the indices are not validMatrixVisitorException- if the visitor cannot process an entry- 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) throws MatrixVisitorException
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 - Throws:
MatrixVisitorException- if the visitor cannot process an entry- 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) throws MatrixVisitorException
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 - Throws:
MatrixVisitorException- if the visitor cannot process an entry- 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 MatrixIndexException, MatrixVisitorException
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:
MatrixIndexException- if the indices are not validMatrixVisitorException- if the visitor cannot process an entry- 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 MatrixIndexException, MatrixVisitorException
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:
MatrixIndexException- if the indices are not validMatrixVisitorException- if the visitor cannot process an entry- 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)
-
solve
@Deprecated public double[] solve(double[] b) throws java.lang.IllegalArgumentException, InvalidMatrixExceptionDeprecated.Returns the solution vector for a linear system with coefficient matrix = this and constant vector =b.- Specified by:
solvein interfaceRealMatrix- Parameters:
b- constant vector- Returns:
- vector of solution values to AX = b, where A is *this
- Throws:
java.lang.IllegalArgumentException- if this.rowDimension != b.lengthInvalidMatrixException- if this matrix is not square or is singular
-
solve
@Deprecated public RealMatrix solve(RealMatrix b) throws java.lang.IllegalArgumentException, InvalidMatrixException
Deprecated.Returns a matrix of (column) solution vectors for linear systems with coefficient matrix = this and constant vectors = columns ofb.- Specified by:
solvein interfaceRealMatrix- Parameters:
b- matrix of constant vectors forming RHS of linear systems to to solve- Returns:
- matrix of solution vectors
- Throws:
java.lang.IllegalArgumentException- if this.rowDimension != row dimensionInvalidMatrixException- if this matrix is not square or is singular
-
luDecompose
@Deprecated public void luDecompose() throws InvalidMatrixExceptionDeprecated.as of release 2.0, replaced byLUDecompositionComputes a new LU decomposition for this matrix, storing the result for use by other methods.Implementation Note:
Uses Crout's algorithm, with partial pivoting.Usage Note:
This method should rarely be invoked directly. Its only use is to force recomputation of the LU decomposition when changes have been made to the underlying data using direct array references. Changes made using setXxx methods will trigger recomputation when needed automatically.- Throws:
InvalidMatrixException- if the matrix is non-square or singular.
-
toString
public java.lang.String toString()
Get a string representation for this matrix.- Overrides:
toStringin classjava.lang.Object- Returns:
- a string representation for this matrix
-
equals
public boolean equals(java.lang.Object object)
Returns true iffobjectis aRealMatrixinstance with the same dimensions as this and all corresponding matrix entries are equal.- Overrides:
equalsin classjava.lang.Object- Parameters:
object- the object to test equality against.- Returns:
- true if object equals this
-
hashCode
public int hashCode()
Computes a hashcode for the matrix.- Overrides:
hashCodein classjava.lang.Object- Returns:
- hashcode for matrix
-
-