Class MatrixSIS
Object
MatrixSIS
- All Implemented Interfaces:
- Serializable,- Cloneable,- LenientComparable,- Matrix
public abstract class MatrixSIS
extends Object
implements Matrix, LenientComparable, Cloneable, Serializable
A 
Matrix able to perform some operations of interest to Spatial Information Systems (SIS).
 This class completes the GeoAPI Matrix interface with some operations used by sis-referencing.
 It is not a MatrixSIS goal to provide all possible Matrix operations, as there is too many of them.
 This class focuses on:
 - Only the basic matrix operations needed for referencing by coordinates:
- Other operations which are not general-purpose matrix operations, but are needed in the context of referencing by coordinates:
- Since:
- 0.4
- See Also:
Defined in the sis-referencing module
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionstatic MatrixSIScastOrCopy(Matrix matrix) Casts or copies the given matrix to a SIS implementation.clone()Returns a clone of this matrix.voidconvertAfter(int tgtDim, Number scale, Number offset) Assuming that this matrix represents an affine transform, pre-concatenates a scale and a translation on the given dimension.voidconvertBefore(int srcDim, Number scale, Number offset) Assuming that this matrix represents an affine transform, concatenates a scale and a translation on the given dimension.booleanReturnstrueif the specified object is of the same class than this matrix and all of the data members are equal to the corresponding data members in this matrix.booleanequals(Object object, ComparisonMode mode) Compares this matrix with the given object for equality.booleanCompares the given matrices for equality, using the given absolute tolerance threshold.abstract doublegetElement(int row, int column) Retrieves the value at the specified row and column of this matrix.double[]Returns a copy of all matrix elements in a flat, row-major (column indices vary fastest) array.longgetInteger(int row, int column) Retrieves the value at the specified row and column of this matrix, rounded to nearest integer.getNumber(int row, int column) Retrieves the value at the specified row and column of this matrix, wrapped in aNumber.intReturns a hash code value based on the data values in this matrix.inverse()Returns the inverse of this matrix.booleanReturnstrueif this matrix represents an affine transform.abstract booleanReturnstrueif this matrix is an identity matrix.double[]multiply(double[] vector) Returns a new vector which is the result of multiplying this matrix with the specified vector.Returns a new matrix which is the result of multiplying this matrix with the specified one.Normalizes all columns in-place and returns their magnitudes as a row vector.removeColumns(int lower, int upper) Returns a new matrix with the same elements than this matrix except for the specified columns.removeRows(int lower, int upper) Returns a new matrix with the same elements than this matrix except for the specified rows.abstract voidsetElements(double[] elements) Sets all matrix elements from a flat, row-major (column indices vary fastest) array.voidsetMatrix(Matrix matrix) Sets this matrix to the values of another matrix.voidsetNumber(int row, int column, Number value) Modifies the value at the specified row and column of this matrix.Returns the value of U which solvesthis× U =matrix.Returns a unlocalized string representation of this matrix.voidtranslate(double[] vector) Multiplies this matrix by a translation matrix.abstract voidSets the value of this matrix to its transpose.Methods inherited from interface MatrixgetNumCol, getNumRow, setElement
- 
Constructor Details- 
MatrixSISprotected MatrixSIS()For sub-class constructors.
 
- 
- 
Method Details- 
castOrCopyCasts or copies the given matrix to a SIS implementation. Ifmatrixis already an instance ofMatrixSIS, then it is returned unchanged. Otherwise all elements are copied in a newMatrixSISobject.- Parameters:
- matrix- the matrix to cast or copy, or- null.
- Returns:
- the matrix argument if it can be safely casted (including nullargument), or a copy of the given matrix otherwise.
- See Also:
 
- 
getIntegerpublic long getInteger(int row, int column) Retrieves the value at the specified row and column of this matrix, rounded to nearest integer. This method may be more accurate thangetElement(int, int)in some implementations when the value is expected to be an integer (for example in conversions of pixel coordinates).- Parameters:
- row- the row index, from 0 inclusive to- Matrix.getNumRow()exclusive.
- column- the column index, from 0 inclusive to- Matrix.getNumCol()exclusive.
- Returns:
- the current value at the given row and column, rounded to nearest integer.
- Since:
- 1.3
 
- 
getNumberRetrieves the value at the specified row and column of this matrix, wrapped in aNumber. TheNumbertype depends on the matrix accuracy.- Parameters:
- row- the row index, from 0 inclusive to- Matrix.getNumRow()exclusive.
- column- the column index, from 0 inclusive to- Matrix.getNumCol()exclusive.
- Returns:
- the current value at the given row and column.
 
- 
setNumberModifies the value at the specified row and column of this matrix. This method is the converses ofgetNumber(int, int).- Parameters:
- row- the row index, from 0 inclusive to- Matrix.getNumRow()exclusive.
- column- the column index, from 0 inclusive to- Matrix.getNumCol()exclusive.
- value- the new matrix element value.
- Since:
- 0.8
- See Also:
 
- 
getElementpublic abstract double getElement(int row, int column) Retrieves the value at the specified row and column of this matrix.- Specified by:
- getElementin interface- Matrix
- Parameters:
- row- the row index, from 0 inclusive to- Matrix.getNumRow()exclusive.
- column- the column index, from 0 inclusive to- Matrix.getNumCol()exclusive.
- Returns:
- the current value at the given row and column.
 
- 
getElementspublic double[] getElements()Returns a copy of all matrix elements in a flat, row-major (column indices vary fastest) array. The array length isMatrix.getNumRow() * Matrix.getNumCol().- Returns:
- a copy of all current matrix elements in a row-major array.
 
- 
setElementspublic abstract void setElements(double[] elements) Sets all matrix elements from a flat, row-major (column indices vary fastest) array. The array length shall beMatrix.getNumRow() * Matrix.getNumCol().- Parameters:
- elements- The new matrix elements in a row-major array.
- Throws:
- IllegalArgumentException- if the given array does not have the expected length.
- UnsupportedOperationException- if this matrix is unmodifiable.
- See Also:
 
- 
setMatrixSets this matrix to the values of another matrix. The given matrix must have the same size.- Parameters:
- matrix- the matrix to copy.
- Throws:
- MismatchedMatrixSizeException- if the given matrix has a different size than this matrix.
- Since:
- 0.7
 
- 
isAffinepublic boolean isAffine()Returnstrueif this matrix represents an affine transform. A transform is affine if the matrix is square and its last row contains only zeros, except in the last column which contains 1.- Returns:
- trueif this matrix represents an affine transform.
- See Also:
 
- 
isIdentitypublic abstract boolean isIdentity()Returnstrueif this matrix is an identity matrix. This method is equivalent to the following code, except that it is potentially more efficient:return Matrices.isIdentity(this, 0.0); - Specified by:
- isIdentityin interface- Matrix
- Returns:
- trueif this matrix is an identity matrix.
- See Also:
 
- 
transposepublic abstract void transpose()Sets the value of this matrix to its transpose.- Throws:
- UnsupportedOperationException- if this matrix is unmodifiable.
 
- 
normalizeColumnsNormalizes all columns in-place and returns their magnitudes as a row vector. Each columns in this matrix is considered as a vector. For each column (vector), this method computes the magnitude (vector length) as the square root of the sum of all squared values. Then, all values in the column are divided by that magnitude.This method is useful when the matrix is a transform derivative. In such matrix, each column is a vector representing the displacement in target space when an coordinate in the source space is increased by one. Invoking this method turns those vectors into unitary vectors, which is useful for forming the basis of a new coordinate system. - Returns:
- the magnitude for each column in a matrix having only one row.
- Throws:
- UnsupportedOperationException- if this matrix is unmodifiable.
 
- 
convertBeforeAssuming that this matrix represents an affine transform, concatenates a scale and a translation on the given dimension. Converting a point with the resulting matrix is equivalent to first convert the point withcoordinates[srcDim] = coordinates[srcDim] * scale + offset, then apply the original matrix.Equivalence between this method and Java2DIf this matrix was an instance of Java2DAffineTransformmethodsAffineTransform, then invoking this method would be equivalent to invoking the followingAffineTransformmethods in the order shown below:Equivalence between this method and AffineTransform methods MatrixSISmethodAffineTransformmethodsconvertBefore(0, scale, offset)at.translate(offset, 0); at.scale(scale, 1);convertBefore(1, scale, offset)at.translate(0, offset); at.scale(1, scale);- Parameters:
- srcDim- the dimension of the coordinate to rescale in the source coordinates.
- scale- the amount by which to multiply the source coordinate value before to apply the transform, or- nullif none.
- offset- the amount by which to translate the source coordinate value before to apply the transform, or- nullif none.
- Throws:
- UnsupportedOperationException- if this matrix is unmodifiable.
- Since:
- 0.6
- See Also:
 
- 
convertAfterAssuming that this matrix represents an affine transform, pre-concatenates a scale and a translation on the given dimension. Converting a point with the resulting matrix is equivalent to first convert the point with the original matrix, then convert the result withcoordinates[tgtDim] = coordinates[tgtDim] * scale + offset.- Parameters:
- tgtDim- the dimension of the coordinate to rescale in the target coordinates.
- scale- the amount by which to multiply the target coordinate value after this transform, or- nullif none.
- offset- the amount by which to translate the target coordinate value after this transform, or- nullif none.
- Throws:
- UnsupportedOperationException- if this matrix is unmodifiable.
- Since:
- 0.6
- See Also:
 
- 
multiplyReturns a new matrix which is the result of multiplying this matrix with the specified one. In other words, returnsthis×matrix.Relationship with coordinate operationsIn the context of coordinate operations,Matrix.multiply(other)is equivalent toAffineTransform.concatenate(other): first transforms by theothertransform and then transform the result bythistransform.- Parameters:
- matrix- the matrix to multiply to this matrix.
- Returns:
- the result of this×matrix.
- Throws:
- MismatchedMatrixSizeException- if the number of rows in the given matrix is not equals to the number of columns in this matrix.
 
- 
multiplypublic double[] multiply(double[] vector) Returns a new vector which is the result of multiplying this matrix with the specified vector. In other words, returnsthis×vector. The length of the given vector must be equal to the number of columns in this matrix, and the length of the returned vector will be equal to the number of rows in this matrix.Relationship with coordinate operationsIn the context of coordinate operations,Matrix.multiply(vector)is related toAffineTransform.transform(…)except that the lastvectornumber is implicitly 1 inAffineTransformoperations. While thismultiply(double[])method could be used for coordinate transformation, it is not its purpose. This method is designed for occasional uses when accuracy is more important than performance.- Parameters:
- vector- the vector to multiply to this matrix.
- Returns:
- the result of this×vector.
- Throws:
- MismatchedMatrixSizeException- if the length of the given vector is not equals to the number of columns in this matrix.
- Since:
- 0.8
 
- 
translatepublic void translate(double[] vector) Multiplies this matrix by a translation matrix. Invoking this method is equivalent to invokingmultiply(T)where T is a matrix like below (size varies):
 The length of the given vector must be equal to the number of columns in this matrix. The last vector element is 1 for an affine transform, but other values are allowed. This matrix will be modified in-place.┌ ┐ │ 1 0 0 vector[0] │ T = │ 0 1 0 vector[1] │ │ 0 0 1 vector[2] │ │ 0 0 0 vector[3] │ └ ┘If this matrix is used for coordinate conversions, then converting a position with the resulting matrix is equivalent to first translating the point by the given vector, then applying the conversion represented by the original matrix. - Parameters:
- vector- a vector representing a translation to be applied before this matrix.
- Since:
- 1.0
- See Also:
 
- 
solvepublic MatrixSIS solve(Matrix matrix) throws MismatchedMatrixSizeException, NoninvertibleMatrixException Returns the value of U which solvesthis× U =matrix. This is equivalent to first computing the inverse ofthis, then multiplying the result by the given matrix.- Parameters:
- matrix- the matrix to solve.
- Returns:
- the U matrix that satisfies this× U =matrix.
- Throws:
- MismatchedMatrixSizeException- if the number of rows in the given matrix is not equals to the number of columns in this matrix.
- NoninvertibleMatrixException- if this matrix is not invertible.
 
- 
inverseReturns the inverse of this matrix.- Returns:
- the inverse of this matrix.
- Throws:
- NoninvertibleMatrixException- if this matrix is not invertible.
- See Also:
 
- 
removeRowsReturns a new matrix with the same elements than this matrix except for the specified rows. This method is useful for removing a range of target dimensions in an affine transform.- Parameters:
- lower- index of the first row to remove (inclusive).
- upper- index after the last row to remove (exclusive).
- Returns:
- a copy of this matrix with the specified rows removed.
- Since:
- 0.7
 
- 
removeColumnsReturns a new matrix with the same elements than this matrix except for the specified columns. This method is useful for removing a range of source dimensions in an affine transform. Coordinates will be converted as if the values in the removed dimensions were zeros.- Parameters:
- lower- index of the first column to remove (inclusive).
- upper- index after the last column to remove (exclusive).
- Returns:
- a copy of this matrix with the specified columns removed.
- Since:
- 0.7
 
- 
hashCodepublic int hashCode()Returns a hash code value based on the data values in this matrix.
- 
equalsReturnstrueif the specified object is of the same class than this matrix and all of the data members are equal to the corresponding data members in this matrix.- Specified by:
- equalsin interface- LenientComparable
- Overrides:
- equalsin class- Object
- Parameters:
- object- the object to compare with this matrix for equality.
- Returns:
- trueif the given object is equal to this matrix.
- See Also:
 
- 
equalsCompares the given matrices for equality, using the given absolute tolerance threshold. The given matrix does not need to be the same implementation class than this matrix.The matrix elements are compared as below: - Double.NaNvalues are considered equals to all other NaN values.
- Infinite values are considered equal to other infinite values of the same sign.
- All other values are considered equal if the absolute value of their difference is smaller than or equals to the given threshold.
 - Parameters:
- matrix- the matrix to compare.
- tolerance- the tolerance value.
- Returns:
- trueif this matrix is close enough to the given matrix given the tolerance value.
- See Also:
 
- 
equalsCompares this matrix with the given object for equality. To be considered equal, the two objects must met the following conditions, which depend on themodeargument:- STRICT: the two matrices must be of the same class, have the same size and the same element values.
- BY_CONTRACT: the two matrices must have the same size and the same element values, but are not required to be the same implementation class (any- Matrixis okay).
- IGNORE_METADATA: same as- BY_CONTRACT.
- APPROXIMATE: the two matrices must have the same size, but the element values can differ up to some threshold. The threshold value is determined empirically and may change in any future SIS versions.
 - Specified by:
- equalsin interface- LenientComparable
- Parameters:
- object- the object to compare to- this.
- mode- the strictness level of the comparison.
- Returns:
- trueif both objects are equal.
- See Also:
 
- 
cloneReturns a clone of this matrix.
- 
toStringReturns a unlocalized string representation of this matrix. For each column, the numbers are aligned on the decimal separator.
 
-