/*
* Geotoolkit.org - An Open Source Java GIS Toolkit
* http://www.geotoolkit.org
*
* (C) 2001-2012, Open Source Geospatial Foundation (OSGeo)
* (C) 2009-2012, Geomatys
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.geotoolkit.referencing.operation.matrix;
import java.text.FieldPosition;
import java.text.NumberFormat;
import javax.vecmath.GMatrix;
import org.opengis.referencing.cs.AxisDirection;
import org.opengis.referencing.operation.Matrix;
import org.opengis.geometry.Envelope;
import org.opengis.geometry.MismatchedDimensionException;
import org.apache.sis.util.CharSequences;
import org.apache.sis.math.Statistics;
import org.geotoolkit.resources.Errors;
import org.apache.sis.internal.metadata.AxisDirections;
import org.apache.sis.referencing.operation.matrix.Matrices;
/**
* A two dimensional array of numbers. Row and column numbering begins with zero.
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Simone Giannecchini (Geosolutions)
* @version 3.20
*
* @see javax.vecmath.GMatrix
* @see java.awt.geom.AffineTransform
* @see javax.media.jai.PerspectiveTransform
* @see javax.media.j3d.Transform3D
* @see <A HREF="http://math.nist.gov/javanumerics/jama/">Jama matrix</A>
* @see <A HREF="http://jcp.org/jsr/detail/83.jsp">JSR-83 Multiarray package</A>
*
* @since 1.2
* @module
*
* @deprecated Moved to Apache SIS as {@link org.apache.sis.referencing.operation.matrix.Matrices#createDiagonal(int, int)}.
*/
@Deprecated
public class GeneralMatrix extends GMatrix implements Matrix {
/**
* Serial number for inter-operability with different versions.
*/
private static final long serialVersionUID = 8447482612423035360L;
/**
* Constructs a square identity matrix of size {@code size} × {@code size}.
*
* @param size The number of rows and columns.
*/
public GeneralMatrix(final int size) {
super(size, size);
}
/**
* Creates a matrix of size {@code numRow} × {@code numCol}.
* Elements on the diagonal (<var>j</var> == <var>i</var>) are set to 1.
*
* @param numRow Number of rows.
* @param numCol Number of columns.
*/
public GeneralMatrix(final int numRow, final int numCol) {
super(numRow, numCol);
}
/**
* Constructs a new matrix from a two-dimensional array of doubles.
*
* @param matrix Array of rows. Each row must have the same length.
* @throws IllegalArgumentException if the specified matrix is not regular
* (i.e. if all rows doesn't have the same length).
*/
public GeneralMatrix(final double[]... matrix) throws IllegalArgumentException {
super(matrix.length, (matrix.length!=0) ? matrix[0].length : 0);
final int numRow = getNumRow();
final int numCol = getNumCol();
for (int j=0; j<numRow; j++) {
if (matrix[j].length != numCol) {
throw new IllegalArgumentException(Errors.format(Errors.Keys.MatrixNotRegular));
}
setRow(j, matrix[j]);
}
}
/**
* Constructs a transform that maps a source region to a destination region.
* Axis order and direction are left unchanged.
* <p>
* If the source dimension is equal to the destination dimension,
* then the transform is affine. However, the following special cases
* are also handled:
* <p>
* <ul>
* <li>If the target dimension is smaller than the source dimension,
* then extra dimensions are dropped.</li>
* <li>If the target dimension is greater than the source dimension,
* then the coordinates in the new dimensions are set to 0.</li>
* </ul>
*
* @param srcRegion The source region.
* @param dstRegion The destination region.
*/
public GeneralMatrix(final Envelope srcRegion,
final Envelope dstRegion)
{
super(dstRegion.getDimension()+1, srcRegion.getDimension()+1);
// Next lines should be first if only Sun could fix RFE #4093999 (sigh...)
final int srcDim = srcRegion.getDimension();
final int dstDim = dstRegion.getDimension();
for (int i=Math.min(srcDim, dstDim); --i>=0;) {
double scale = dstRegion.getSpan(i) / srcRegion.getSpan(i);
double translate = dstRegion.getMinimum(i) - srcRegion.getMinimum(i)*scale;
setElement(i, i, scale);
setElement(i, srcDim, translate);
}
setElement(dstDim, srcDim, 1);
assert (srcDim != dstDim) || isAffine() : this;
}
/**
* Constructs a transform mapping a source region to a destination region.
* Axis order and/or direction can be changed during the process.
* For example, the transform may convert (NORTH,WEST) coordinates
* into (EAST,NORTH). Axis direction can be inverted only. For example,
* it is illegal to transform (NORTH,WEST) coordinates into (NORTH,DOWN).
* <p>
* If the source dimension is equal to the destination dimension,
* then the transform is affine. However, the following special cases
* are also handled:
* <p>
* <ul>
* <li>If the target dimension is smaller than the source dimension,
* extra axis are dropped. An exception is thrown if the target
* contains some axis not found in the source.</li>
* </ul>
*
* @param srcRegion The source region.
* @param srcAxis Axis direction for each dimension of the source region.
* @param dstRegion The destination region.
* @param dstAxis Axis direction for each dimension of the destination region.
* @throws MismatchedDimensionException if the envelope dimension doesn't
* matches the axis direction array length.
* @throws IllegalArgumentException If {@code dstAxis} contains some axis
* not found in {@code srcAxis}, or if some colinear axis were found.
*/
public GeneralMatrix(final Envelope srcRegion, final AxisDirection[] srcAxis,
final Envelope dstRegion, final AxisDirection[] dstAxis)
{
this(srcRegion, srcAxis, dstRegion, dstAxis, true);
}
/**
* Implementation of constructors expecting envelope and/or axis directions.
*
* @param validRegions {@code true} if source and destination regions must
* be taken in account. If {@code false}, then source and destination
* regions will be ignored and may be null.
*/
private GeneralMatrix(final Envelope srcRegion, final AxisDirection[] srcAxis,
final Envelope dstRegion, final AxisDirection[] dstAxis,
final boolean validRegions)
{
super(dstAxis.length+1, srcAxis.length+1);
if (validRegions) {
ensureDimensionMatch("srcRegion", srcRegion, srcAxis.length);
ensureDimensionMatch("dstRegion", dstRegion, dstAxis.length);
}
/*
* Maps source axis to destination axis. If no axis is moved (for example if the user
* want to transform (NORTH,EAST) to (SOUTH,EAST)), then source and destination index
* will be equal. If some axis are moved (for example if the user want to transform
* (NORTH,EAST) to (EAST,NORTH)), then ordinates at index {@code srcIndex} will have
* to be moved at index {@code dstIndex}.
*/
setZero();
for (int dstIndex=0; dstIndex<dstAxis.length; dstIndex++) {
boolean hasFound = false;
final AxisDirection dstAxe = dstAxis[dstIndex];
final AxisDirection search = AxisDirections.absolute(dstAxe);
for (int srcIndex=0; srcIndex<srcAxis.length; srcIndex++) {
final AxisDirection srcAxe = srcAxis[srcIndex];
if (search.equals(AxisDirections.absolute(srcAxe))) {
if (hasFound) {
throw new IllegalArgumentException(Errors.format(
Errors.Keys.ColinearAxis_2, srcAxe.name(), dstAxe.name()));
}
hasFound = true;
/*
* Set the matrix elements. Some matrix elements will never
* be set. They will be left to zero, which is their wanted
* value.
*/
final boolean normal = srcAxe.equals(dstAxe);
double scale = (normal) ? +1 : -1;
double translate = 0;
if (validRegions) {
translate = (normal) ? dstRegion.getMinimum(dstIndex)
: dstRegion.getMaximum(dstIndex);
scale *= dstRegion.getSpan(dstIndex) /
srcRegion.getSpan(srcIndex);
translate -= srcRegion.getMinimum(srcIndex) * scale;
}
setElement(dstIndex, srcIndex, scale);
setElement(dstIndex, srcAxis.length, translate);
}
}
if (!hasFound) {
throw new IllegalArgumentException(Errors.format(
Errors.Keys.NoSourceAxis_1, dstAxis[dstIndex].name()));
}
}
setElement(dstAxis.length, srcAxis.length, 1);
assert (srcAxis.length != dstAxis.length) || isAffine() : this;
}
/**
* Convenience method for checking object dimension validity.
* This method is usually invoked for argument checking.
*
* @param name The name of the argument to check.
* @param envelope The envelope to check.
* @param dimension The expected dimension for the object.
* @throws MismatchedDimensionException if the envelope doesn't have the expected dimension.
*/
private static void ensureDimensionMatch(final String name, final Envelope envelope,
final int dimension) throws MismatchedDimensionException
{
final int dim = envelope.getDimension();
if (dimension != dim) {
throw new MismatchedDimensionException(Errors.format(
Errors.Keys.MismatchedDimension_3, name, dim, dimension));
}
}
/**
* {@inheritDoc}
*/
public final boolean isAffine() {
int dimension = getNumRow();
if (dimension != getNumCol()) {
return false;
}
dimension--;
for (int i=0; i<=dimension; i++) {
if (getElement(dimension, i) != (i==dimension ? 1 : 0)) {
return false;
}
}
return true;
}
/**
* Returns {@code true} if this matrix is an identity matrix.
*/
@Override
public final boolean isIdentity() {
final int numRow = getNumRow();
final int numCol = getNumCol();
if (numRow != numCol) {
return false;
}
for (int j=0; j<numRow; j++) {
for (int i=0; i<numCol; i++) {
if (getElement(j,i) != (i==j ? 1 : 0)) {
return false;
}
}
}
assert isAffine() : this;
return true;
}
/**
* {@inheritDoc}
*/
public boolean equals(final Matrix matrix, final double tolerance) {
return Matrices.equals(this, matrix, tolerance, false);
}
/**
* Returns a string representation of this matrix. The returned string is implementation
* dependent. It is usually provided for debugging purposes only.
*/
@Override
public String toString() {
return toString(this);
}
/**
* Returns a string representation of the specified matrix. The returned string is
* implementation dependent. It is usually provided for debugging purposes only.
*/
private static String toString(final Matrix matrix) {
/*
* Chooses a NumberFormat (more specifically the number of fraction digits)
* based on the element values (their range, mean and standard deviation).
*/
final int numRow = matrix.getNumRow();
final int numCol = matrix.getNumCol();
final Statistics statistics = new Statistics(null);
for (int j=0; j<numRow; j++) {
for (int i=0; i<numCol; i++) {
statistics.accept(matrix.getElement(j,i));
}
}
final NumberFormat format = NumberFormat.getNumberInstance();
format.setGroupingUsed(false);
final int columnWidth = format.getMaximumFractionDigits() + 6;
final FieldPosition dummy = new FieldPosition(0);
/*
* Formats the element values like usual matrix representation (including the brackets).
*/
final String lineSeparator = System.lineSeparator();
final CharSequence whiteline = CharSequences.spaces(numCol*columnWidth + 1);
StringBuffer buffer = new StringBuffer();
buffer.append('\u250C').append(whiteline).append('\u2510').append(lineSeparator);
for (int j=0; j<numRow; j++) {
buffer.append('\u2502');
for (int i=0; i<numCol; i++) {
final int position = buffer.length();
buffer = format.format(matrix.getElement(j,i), buffer, dummy);
final int spaces = Math.max(columnWidth - (buffer.length() - position), 1);
buffer.insert(position, CharSequences.spaces(spaces));
}
buffer.append(" \u2502").append(lineSeparator);
}
return buffer.append('\u2514').append(whiteline).append('\u2518').append(lineSeparator).toString();
}
/**
* Returns a clone of this matrix.
*/
@Override
public GeneralMatrix clone() {
return (GeneralMatrix) super.clone();
}
}