Class Matrix1
Object
Matrix1
- All Implemented Interfaces:
Serializable
,Cloneable
,Matrix
,Cloneable
,XMatrix
A matrix of fixed 1×1 size. This trivial matrix is returned as a result of
MathTransform1D derivative computation.
- Since:
- 2.2
- Author:
- Martin Desruisseaux (IRD)
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(double scalar) Performs an in-place scalar addition.void
Set to the scalar addition ofscalar+matrix
void
Set to the matrix addition ofthis+matrix
.void
Set to the matrix addition ofmatrix1+matrix2
.clone()
Returns a clone of this matrix.double
Computes the determinantboolean
Returnstrue
if the specified object is of typeMatrix1
and all of the data members are equal to the corresponding data members in this matrix.boolean
Compares the element values.void
getColumn
(int column, double[] array) Extract col to provided array.final double
getElement
(int row, int col) Returns the element at the specified index.final int
Returns the number of colmuns in this matrix, which is always 1 in this implementation.final int
Returns the number of rows in this matrix, which is always 1 in this implementation.void
getRow
(int row, double[] array) Extract row to provided arrayint
hashCode()
Returns a hash code value based on the data values in this object.final void
invert()
Inverts this matrix in place.void
Set to the inverse of the provided matrix.final boolean
isAffine()
Returnstrue
if this matrix is an affine transform.final boolean
Returnstrue
if this matrix is an identity matrix.final boolean
isIdentity
(double tolerance) Returnstrue
if this matrix is an identity matrix using the provided tolerance.void
mul
(double scalar) Sets this matrix to the result of multiplying itself with the provided scalar.void
Sets the value of this matrix to the result of multiplying the provided scalar and matrix.void
Sets the value of this matrix to the result of multiplying itself with the specified matrix.void
Sets the value of this matrix to the result of multiplying matrix1 and matrix2.final void
Sets the value of this matrix to the result of multiplying itself with the specified matrix.final void
negate()
Negates the value of this matrix:this = -this
.void
Negates the value of this matrix:this = -matrix
.void
setColumn
(int column, double... values) Sets the value of the column using an array of values.final void
setElement
(int row, int col, double value) Modifies the value at the specified row and column of this matrix.final void
Sets this matrix to the identity matrix.void
setRow
(int row, double... values) Sets the value of the row using an array of values.final void
setZero()
Sets all the values in this matrix to zero.void
sub
(double scalar) In-place matrix subtraction:this - scalar
.void
Set to the difference ofscalar - matrix2
.void
In-place matrix subtraction:this - matrix
.void
Set to the difference ofmatrix1 - matrix2
.toString()
Returns a string representation of this matrix.final void
Sets the value of this matrix to its transpose.void
Set to the transpose of the provided matrix.
-
Field Details
-
m00
public double m00The only element in this matrix. -
SIZE
public static final int SIZEThe matrix size, which is 1.- See Also:
-
-
Constructor Details
-
Matrix1
public Matrix1()Creates a new identity matrix. -
Matrix1
public Matrix1(double m00) Creates a new matrix initialized to the specified value. -
Matrix1
-
-
Method Details
-
getNumRow
public final int getNumRow()Returns the number of rows in this matrix, which is always 1 in this implementation. -
getNumCol
public final int getNumCol()Returns the number of colmuns in this matrix, which is always 1 in this implementation. -
getElement
public final double getElement(int row, int col) Returns the element at the specified index.- Specified by:
getElement
in interfaceMatrix
- Specified by:
getElement
in interfaceXMatrix
- Parameters:
row
- The row number to be retrieved (zero indexed).col
- The column number to be retrieved (zero indexed).- Returns:
- The value at the indexed element.
-
setElement
public final void setElement(int row, int col, double value) Modifies the value at the specified row and column of this matrix.- Specified by:
setElement
in interfaceMatrix
- Parameters:
row
- The row number to be retrieved (zero indexed).col
- The column number to be retrieved (zero indexed).value
- The new matrix element value.
-
setZero
public final void setZero()Sets all the values in this matrix to zero. -
setIdentity
public final void setIdentity()Sets this matrix to the identity matrix.- Specified by:
setIdentity
in interfaceXMatrix
-
isIdentity
public final boolean isIdentity()Returnstrue
if this matrix is an identity matrix.- Specified by:
isIdentity
in interfaceMatrix
- Returns:
true
if this matrix is an identity matrix.
-
isIdentity
public final boolean isIdentity(double tolerance) Returnstrue
if this matrix is an identity matrix using the provided tolerance. This method is equivalent to computing the difference between this matrix and an identity matrix of identical size, and returningtrue
if and only if all differences are smaller than or equal totolerance
.- Specified by:
isIdentity
in interfaceXMatrix
- Parameters:
tolerance
- The tolerance value.- Returns:
true
if this matrix is close enough to the identity matrix given the tolerance value.
-
isAffine
public final boolean isAffine()Returnstrue
if this matrix is an affine transform. A transform is affine if the matrix is square and last row contains only zeros, except in the last column which contains 1. -
negate
public final void negate()Negates the value of this matrix:this = -this
. -
negate
Description copied from interface:XMatrix
Negates the value of this matrix:this = -matrix
. -
transpose
public final void transpose()Sets the value of this matrix to its transpose. -
transpose
Description copied from interface:XMatrix
Set to the transpose of the provided matrix. -
invert
public final void invert()Inverts this matrix in place. -
invert
Description copied from interface:XMatrix
Set to the inverse of the provided matrix.- Specified by:
invert
in interfaceXMatrix
- Parameters:
matrix
- The matrix that is to be inverted. Not modified.- Throws:
SingularMatrixException
- if this matrix is not invertible.
-
multiply
Sets the value of this matrix to the result of multiplying itself with the specified matrix. In other words, performsthis
=this
×matrix
. In the context of coordinate transformations, this is equivalent toAffineTransform.concatenate
: first transforms by the supplied transform and then transform the result by the original transform. -
equals
Compares the element values. -
equals
Returnstrue
if the specified object is of typeMatrix1
and all of the data members are equal to the corresponding data members in this matrix. -
hashCode
public int hashCode()Returns a hash code value based on the data values in this object. -
toString
Returns a string representation of this matrix. The returned string is implementation dependent. It is usually provided for debugging purposes only. -
clone
Returns a clone of this matrix. -
getRow
public void getRow(int row, double[] array) Description copied from interface:XMatrix
Extract row to provided array -
setRow
public void setRow(int row, double... values) Description copied from interface:XMatrix
Sets the value of the row using an array of values. -
getColumn
public void getColumn(int column, double[] array) Description copied from interface:XMatrix
Extract col to provided array. -
setColumn
public void setColumn(int column, double... values) Description copied from interface:XMatrix
Sets the value of the column using an array of values. -
add
public void add(double scalar) Description copied from interface:XMatrix
Performs an in-place scalar addition. -
add
Description copied from interface:XMatrix
Set to the scalar addition ofscalar+matrix
-
add
Description copied from interface:XMatrix
Set to the matrix addition ofthis+matrix
. -
add
Description copied from interface:XMatrix
Set to the matrix addition ofmatrix1+matrix2
. -
determinate
public double determinate()Description copied from interface:XMatrix
Computes the determinant- Specified by:
determinate
in interfaceXMatrix
-
mul
public void mul(double scalar) Description copied from interface:XMatrix
Sets this matrix to the result of multiplying itself with the provided scalar. -
mul
Description copied from interface:XMatrix
Sets the value of this matrix to the result of multiplying the provided scalar and matrix. -
mul
Description copied from interface:XMatrix
Sets the value of this matrix to the result of multiplying itself with the specified matrix. In other words, performsthis
=this
×matrix
. In the context of coordinate transformations, this is equivalent toAffineTransform.concatenate
: first transforms by the supplied transform and then transform the result by the original transform. -
mul
Description copied from interface:XMatrix
Sets the value of this matrix to the result of multiplying matrix1 and matrix2. -
sub
public void sub(double scalar) Description copied from interface:XMatrix
In-place matrix subtraction:this - scalar
. -
sub
Description copied from interface:XMatrix
In-place matrix subtraction:this - matrix
. -
sub
Description copied from interface:XMatrix
Set to the difference ofscalar - matrix2
. -
sub
Description copied from interface:XMatrix
Set to the difference ofmatrix1 - matrix2
.
-