org.opengis.referencing.operation
Interface Matrix


@UML(identifier="PT_Matrix",
     specification=OGC_01009)
public interface Matrix

A two dimensional array of numbers. Row and column numbering begins with zero. The API for this interface matches closely the API in various matrix implementations available in Java3D, which should enable straightforward implementations. Java3D provides matrix for the general case and optimized versions for 3×3 and 4×4 cases, which are quite common in a transformation package.

Since:
GeoAPI 1.0
See Also:
Matrix3d, Matrix4d, GMatrix, AffineTransform, PerspectiveTransform, Transform3D, Jama matrix, JSR-83 Multiarray package

Method Summary
 Matrix clone()
          Returns a clone of this matrix.
 double getElement(int row, int column)
          Retrieves the value at the specified row and column of this matrix.
 int getNumCol()
          Returns the number of columns in this matrix.
 int getNumRow()
          Returns the number of rows in this matrix.
 boolean isIdentity()
          Returns true if this matrix is an identity matrix.
 void setElement(int row, int column, double value)
          Modifies the value at the specified row and column of this matrix.
 

Method Detail

getNumRow

int getNumRow()
Returns the number of rows in this matrix.

Returns:
The number of rows in this matrix.
Departure from OGC/ISO specification:
Needed for making the matrix usable. The method signature matches the one of GMatrix in the vecmath package, for straightforward implementation.

getNumCol

int getNumCol()
Returns the number of columns in this matrix.

Returns:
The number of columns in this matrix.
Departure from OGC/ISO specification:
Needed for making the matrix usable. The method signature matches the one of GMatrix in the vecmath package, for straightforward implementation.

getElement

double getElement(int row,
                  int column)
Retrieves the value at the specified row and column of this matrix.

Parameters:
row - The row number to be retrieved (zero indexed).
column - The column number to be retrieved (zero indexed).
Returns:
The value at the indexed element.
Departure from OGC/ISO specification:
Needed for making the matrix usable. The method signature matches the one of GMatrix in the vecmath package, for straightforward implementation.

setElement

void setElement(int row,
                int column,
                double value)
Modifies the value at the specified row and column of this matrix.

Parameters:
row - The row number to be retrieved (zero indexed).
column - The column number to be retrieved (zero indexed).
value - The new matrix element value.
Departure from OGC/ISO specification:
Needed for making the matrix usable. The method signature matches the one of GMatrix in the vecmath package, for straightforward implementation.

isIdentity

boolean isIdentity()
Returns true if this matrix is an identity matrix.

Returns:
true if this matrix is an identity matrix.
Departure from OGC/ISO specification:
Added as a convenience for a frequently requested operation.

clone

Matrix clone()
Returns a clone of this matrix.

Returns:
A clone of this matrix.


Copyright © 1994-2011 Open Geospatial Consortium. All Rights Reserved.