Class Array2DRowFieldMatrix<T extends FieldElement<T>>
- Type Parameters:
T- the type of the field elements
- All Implemented Interfaces:
Serializable,AnyMatrix,FieldMatrix<T>
FieldElement[][] array to store entries.
As specified in the FieldMatrix interface, matrix element indexing
is 0-based -- e.g., getEntry(0, 0)
returns the element in the first row, first column of the matrix.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionArray2DRowFieldMatrix(Field<T> field) Creates a matrix with no dataArray2DRowFieldMatrix(Field<T> field, int rowDimension, int columnDimension) Create a newFieldMatrix<T>with the supplied row and column dimensions.Array2DRowFieldMatrix(Field<T> field, T[] v) Create a new (column)FieldMatrix<T>usingvas the data for the unique column of the created matrix.Array2DRowFieldMatrix(Field<T> field, T[][] d) Create a newFieldMatrix<T>using the input array as the underlying data array.Array2DRowFieldMatrix(Field<T> field, T[][] d, boolean copyArray) Create a newFieldMatrix<T>using the input array as the underlying data array.Array2DRowFieldMatrix(T[] v) Create a new (column)FieldMatrix<T>usingvas the data for the unique column of the created matrix.Array2DRowFieldMatrix(T[][] d) Create a newFieldMatrix<T>using the input array as the underlying data array.Array2DRowFieldMatrix(T[][] d, boolean copyArray) Create a newFieldMatrix<T>using the input array as the underlying data array. -
Method Summary
Modifier and TypeMethodDescriptionAddmto this matrix.voidaddToEntry(int row, int column, T increment) Change an entry in the specified row and column.copy()Make a (deep) copy of this.createMatrix(int rowDimension, int columnDimension) Create a new FieldMatrixof the same type as the instance with the supplied row and column dimensions. intReturns the number of columns in the matrix.T[][]getData()Returns matrix entries as a two-dimensional array.T[][]Get a reference to the underlying data array.getEntry(int row, int column) Returns the entry in the specified row and column.intReturns the number of rows in the matrix.Postmultiplying this matrix bym.voidmultiplyEntry(int row, int column, T factor) Change an entry in the specified row and column.T[]Returns the result of multiplying this by the vectorv.T[]preMultiply(T[] v) Returns the (row) vector result of premultiplying this by the vectorv.voidSet the entry in the specified row and column.voidsetSubMatrix(T[][] subMatrix, int row, int column) Replace the submatrix starting at(row, column)using data in the inputsubMatrixarray.Subtractmfrom this matrix.walkInColumnOrder(FieldMatrixChangingVisitor<T> visitor) Visit (and possibly change) all matrix entries in column order.walkInColumnOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (and possibly change) some matrix entries in column order.walkInColumnOrder(FieldMatrixPreservingVisitor<T> visitor) Visit (but don't change) all matrix entries in column order.walkInColumnOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (but don't change) some matrix entries in column order.walkInRowOrder(FieldMatrixChangingVisitor<T> visitor) Visit (and possibly change) all matrix entries in row order.walkInRowOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (and possibly change) some matrix entries in row order.walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor) Visit (but don't change) all matrix entries in row order.walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (but don't change) some matrix entries in row order.Methods inherited from class org.apache.commons.math3.linear.AbstractFieldMatrix
add, buildArray, buildArray, checkAdditionCompatible, checkColumnIndex, checkMultiplicationCompatible, checkRowIndex, checkSubMatrixIndex, checkSubMatrixIndex, checkSubtractionCompatible, copySubMatrix, copySubMatrix, equals, extractField, extractField, getColumn, getColumnMatrix, getColumnVector, getField, getRow, getRowMatrix, getRowVector, getSubMatrix, getSubMatrix, getTrace, hashCode, isSquare, multiply, operate, power, preMultiply, preMultiply, scalarAdd, scalarMultiply, setColumn, setColumnMatrix, setColumnVector, setRow, setRowMatrix, setRowVector, subtract, toString, transpose, walkInOptimizedOrder, walkInOptimizedOrder, walkInOptimizedOrder, walkInOptimizedOrder
-
Constructor Details
-
Array2DRowFieldMatrix
Creates a matrix with no data- Parameters:
field- field to which the elements belong
-
Array2DRowFieldMatrix
public Array2DRowFieldMatrix(Field<T> field, int rowDimension, int columnDimension) throws NotStrictlyPositiveException Create a newFieldMatrix<T>with the supplied row and column dimensions.- Parameters:
field- Field to which the elements belong.rowDimension- Number of rows in the new matrix.columnDimension- Number of columns in the new matrix.- Throws:
NotStrictlyPositiveException- if row or column dimension is not positive.
-
Array2DRowFieldMatrix
public Array2DRowFieldMatrix(T[][] d) throws DimensionMismatchException, NullArgumentException, NoDataException Create a newFieldMatrix<T>using the input array as the underlying data array.The input array is copied, not referenced. This constructor has the same effect as calling
Array2DRowFieldMatrix(FieldElement[][], boolean)with the second argument set totrue.- Parameters:
d- Data for the new matrix.- Throws:
DimensionMismatchException- ifdis not rectangular.NullArgumentException- ifdisnull.NoDataException- if there are not at least one row and one column.- See Also:
-
Array2DRowFieldMatrix
public Array2DRowFieldMatrix(Field<T> field, T[][] d) throws DimensionMismatchException, NullArgumentException, NoDataException Create a newFieldMatrix<T>using the input array as the underlying data array.The input array is copied, not referenced. This constructor has the same effect as calling
Array2DRowFieldMatrix(FieldElement[][], boolean)with the second argument set totrue.- Parameters:
field- Field to which the elements belong.d- Data for the new matrix.- Throws:
DimensionMismatchException- ifdis not rectangular.NullArgumentException- ifdisnull.NoDataException- if there are not at least one row and one column.- See Also:
-
Array2DRowFieldMatrix
public Array2DRowFieldMatrix(T[][] d, boolean copyArray) throws DimensionMismatchException, NoDataException, NullArgumentException Create a newFieldMatrix<T>using the input array as the underlying data array.If an array is built specially in order to be embedded in a
FieldMatrix<T>and not used directly, thecopyArraymay be set tofalse. This will prevent the copying and improve performance as no new array will be built and no data will be copied.- Parameters:
d- Data for the new matrix.copyArray- Whether to copy or reference the input array.- Throws:
DimensionMismatchException- ifdis not rectangular.NoDataException- if there are not at least one row and one column.NullArgumentException- ifdisnull.- See Also:
-
Array2DRowFieldMatrix
public Array2DRowFieldMatrix(Field<T> field, T[][] d, boolean copyArray) throws DimensionMismatchException, NoDataException, NullArgumentException Create a newFieldMatrix<T>using the input array as the underlying data array.If an array is built specially in order to be embedded in a
FieldMatrix<T>and not used directly, thecopyArraymay be set tofalse. This will prevent the copying and improve performance as no new array will be built and no data will be copied.- Parameters:
field- Field to which the elements belong.d- Data for the new matrix.copyArray- Whether to copy or reference the input array.- Throws:
DimensionMismatchException- ifdis not rectangular.NoDataException- if there are not at least one row and one column.NullArgumentException- ifdisnull.- See Also:
-
Array2DRowFieldMatrix
Create a new (column)FieldMatrix<T>usingvas the data for the unique column of the created matrix. The input array is copied.- Parameters:
v- Column vector holding data for new matrix.- Throws:
NoDataException- if v is empty
-
Array2DRowFieldMatrix
Create a new (column)FieldMatrix<T>usingvas the data for the unique column of the created matrix. The input array is copied.- Parameters:
field- Field to which the elements belong.v- Column vector holding data for new matrix.
-
-
Method Details
-
createMatrix
public FieldMatrix<T> createMatrix(int rowDimension, int columnDimension) throws NotStrictlyPositiveException Create a new FieldMatrixof the same type as the instance with the supplied row and column dimensions. - Specified by:
createMatrixin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
createMatrixin classAbstractFieldMatrix<T extends FieldElement<T>>- 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
Make a (deep) copy of this.- Specified by:
copyin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
copyin classAbstractFieldMatrix<T extends FieldElement<T>>- Returns:
- a copy of this matrix.
-
add
public Array2DRowFieldMatrix<T> add(Array2DRowFieldMatrix<T> m) throws MatrixDimensionMismatchException Addmto this matrix.- Parameters:
m- Matrix to be added.- Returns:
this+ m.- Throws:
MatrixDimensionMismatchException- ifmis not the same size as this matrix.
-
subtract
public Array2DRowFieldMatrix<T> subtract(Array2DRowFieldMatrix<T> m) throws MatrixDimensionMismatchException Subtractmfrom this matrix.- Parameters:
m- Matrix to be subtracted.- Returns:
this+ m.- Throws:
MatrixDimensionMismatchException- ifmis not the same size as this matrix.
-
multiply
public Array2DRowFieldMatrix<T> multiply(Array2DRowFieldMatrix<T> m) throws DimensionMismatchException Postmultiplying this matrix bym.- Parameters:
m- Matrix to postmultiply by.- Returns:
this* m.- Throws:
DimensionMismatchException- if the number of columns of this matrix is not equal to the number of rows ofm.
-
getData
Returns matrix entries as a two-dimensional array.- Specified by:
getDatain interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
getDatain classAbstractFieldMatrix<T extends FieldElement<T>>- Returns:
- a 2-dimensional array of entries.
-
getDataRef
Get a reference to the underlying data array. This methods returns internal data, not fresh copy of it.- Returns:
- the 2-dimensional array of entries.
-
setSubMatrix
public void setSubMatrix(T[][] subMatrix, int row, int column) throws OutOfRangeException, NullArgumentException, NoDataException, DimensionMismatchException Replace the submatrix starting at(row, column)using 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 interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
setSubMatrixin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
subMatrix- Array containing the submatrix replacement data.row- Row coordinate of the top-left element to be replaced.column- Column coordinate of the top-left element to be replaced.- Throws:
OutOfRangeException- ifsubMatrixdoes not fit into this matrix from element in(row, column).NullArgumentException- ifsubMatrixisnull.NoDataException- if a row or column ofsubMatrixis empty.DimensionMismatchException- ifsubMatrixis not rectangular (not all rows have the same length).
-
getEntry
Returns the entry in the specified row and column.- Specified by:
getEntryin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
getEntryin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- row location of entry to be fetchedcolumn- column location of entry to be fetched- Returns:
- matrix entry in row,column
- Throws:
OutOfRangeException- if the row or column index is not valid.
-
setEntry
Set the entry in the specified row and column.- Specified by:
setEntryin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
setEntryin classAbstractFieldMatrix<T extends FieldElement<T>>- 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:
OutOfRangeException- if the row or column index is not valid.
-
addToEntry
Change an entry in the specified row and column.- Specified by:
addToEntryin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
addToEntryin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- Row location of entry to be set.column- Column location of entry to be set.increment- Value to add to the current matrix entry in(row, column).- Throws:
OutOfRangeException- if the row or column index is not valid.
-
multiplyEntry
Change an entry in the specified row and column.- Specified by:
multiplyEntryin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
multiplyEntryin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- Row location of entry to be set.column- Column location of entry to be set.factor- Multiplication factor for the current matrix entry in(row,column)- Throws:
OutOfRangeException- if the row or column index is not valid.
-
getRowDimension
public int getRowDimension()Returns the number of rows in the matrix.- Specified by:
getRowDimensionin interfaceAnyMatrix- Specified by:
getRowDimensionin classAbstractFieldMatrix<T extends FieldElement<T>>- Returns:
- rowDimension
-
getColumnDimension
public int getColumnDimension()Returns the number of columns in the matrix.- Specified by:
getColumnDimensionin interfaceAnyMatrix- Specified by:
getColumnDimensionin classAbstractFieldMatrix<T extends FieldElement<T>>- Returns:
- columnDimension
-
operate
Returns the result of multiplying this by the vectorv.- Specified by:
operatein interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
operatein classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
v- the vector to operate on- Returns:
this * v- Throws:
DimensionMismatchException- if the number of columns ofthismatrix is not equal to the size of the vectorv.
-
preMultiply
Returns the (row) vector result of premultiplying this by the vectorv.- Specified by:
preMultiplyin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
preMultiplyin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
v- the row vector to premultiply by- Returns:
v * this- Throws:
DimensionMismatchException- if the number of rows ofthismatrix is not equal to the size of the vectorv
-
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.
- Specified by:
walkInRowOrderin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInRowOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()at the end of the walk - See Also:
-
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.
- Specified by:
walkInRowOrderin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInRowOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()at the end of the walk - See Also:
-
walkInRowOrder
public T walkInRowOrder(FieldMatrixChangingVisitor<T> 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 interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInRowOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- 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
FieldMatrixChangingVisitor.end()at the end of the walk - Throws:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
-
walkInRowOrder
public T walkInRowOrder(FieldMatrixPreservingVisitor<T> 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 interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInRowOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- 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
FieldMatrixPreservingVisitor.end()at the end of the walk - Throws:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
-
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.
- Specified by:
walkInColumnOrderin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInColumnOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()at the end of the walk - See Also:
-
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.
- Specified by:
walkInColumnOrderin interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInColumnOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
visitor- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()at the end of the walk - See Also:
-
walkInColumnOrder
public T walkInColumnOrder(FieldMatrixChangingVisitor<T> 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 interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInColumnOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- 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
FieldMatrixChangingVisitor.end()at the end of the walk - Throws:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
-
walkInColumnOrder
public T walkInColumnOrder(FieldMatrixPreservingVisitor<T> 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 interfaceFieldMatrix<T extends FieldElement<T>>- Overrides:
walkInColumnOrderin classAbstractFieldMatrix<T extends FieldElement<T>>- 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
FieldMatrixPreservingVisitor.end()at the end of the walk - Throws:
OutOfRangeException- if the indices are not valid.NumberIsTooSmallException- ifendRow < startRoworendColumn < startColumn.- See Also:
-