/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.sis.referencing.operation.transform;

import org.opengis.referencing.operation.Matrix;
import org.opengis.referencing.operation.MathTransform;
import org.opengis.referencing.operation.TransformException;
import org.opengis.referencing.operation.NoninvertibleTransformException;


/**
 * A usually affine, or otherwise a projective transform, which convert coordinates using only linear equations.
 * A projective transform is capable of mapping an arbitrary quadrilateral into another arbitrary quadrilateral,
 * while preserving the straightness of lines. In the special case where the transform is affine, the parallelism
 * of lines in the source is preserved in the output.
 *
 * <p>Such a coordinate transformation can be represented by a matrix of arbitrary size, which is given by the
 * {@link #getMatrix()} method. The relationship between matrix size and transform dimensions is as below:</p>
 *
 * <ul>
 *   <li>The {@linkplain Matrix#getNumCol() number of columns} in the matrix is equal to
 *       the number of {@linkplain #getSourceDimensions() source dimensions} plus 1</li>
 *   <li>The {@linkplain Matrix#getNumRow() number of rows} in the matrix is equal to
 *       the number of {@linkplain #getTargetDimensions() target dimensions} plus 1.</li>
 * </ul>
 *
 * <div class="section">Affine transform</div>
 * In most cases the transform in affine. For such transforms, the last matrix row contains only zero values
 * except in the last column, which contains 1. For example a conversion from projected coordinates (metres)
 * to display coordinates (pixel) can be done as below:
 *
 * <div style="text-align:center">
 * <img src="../matrix/doc-files/AffineTransform.png" alt="Matrix representation of an affine transform">
 * </div>
 *
 * <div class="section">Projective transform</div>
 * If the last matrix row does not met the above constraints, then the transform is not affine.
 * A <cite>projective</cite> transform can be used as a generalization of affine transforms.
 * In such case the computation performed by SIS is similar to {@code PerspectiveTransform}
 * in <cite>Java Advanced Imaging</cite>.
 * For example a square matrix of size 4×4 is used for transforming three-dimensional coordinates.
 * The transformed points {@code (x',y',z')} are computed as below:
 *
 * <div style="text-align:center">{@include formulas.html#ProjectiveTransform}</div>
 *
 * <div class="section">Instantiation</div>
 * The easiest way to instantiate a {@code LinearTransform} is to use the {@link MathTransforms#linear(Matrix)}
 * convenience method.
 *
 * @author  Martin Desruisseaux (IRD, Geomatys)
 * @version 0.7
 *
 * @see org.apache.sis.referencing.operation.transform.MathTransforms#linear(Matrix)
 * @see org.apache.sis.referencing.operation.builder.LinearTransformBuilder
 * @see java.awt.geom.AffineTransform
 * @see <a href="http://mathworld.wolfram.com/AffineTransformation.html">Affine transformation on MathWorld</a>
 *
 * @since 0.4
 * @module
 */
public interface LinearTransform extends MathTransform {
    /**
     * Returns {@code true} if this transform is affine.
     * An affine transform preserves parallelism.
     *
     * @return {@code true} if this transform is affine.
     *
     * @see org.apache.sis.referencing.operation.matrix.MatrixSIS#isAffine()
     *
     * @since 0.6
     */
    boolean isAffine();

    /**
     * Returns the coefficients of this linear transform as a matrix.
     * Converting a coordinate with this {@code MathTransform} is equivalent to multiplying the
     * returned matrix by a vector containing the coordinate values with an additional 1 in the last row.
     * See {@link LinearTransform} class Javadoc for more details.
     *
     * @return the coefficients of this linear transform as a matrix.
     *
     * @see MathTransforms#getMatrix(MathTransform)
     */
    Matrix getMatrix();

    /**
     * Transforms an array of relative distance vectors.
     * Distance vectors are transformed without applying the translation components.
     * The supplied array of distance values will contain packed values.
     *
     * <div class="note"><b>Example:</b> if the source dimension is 3, then the values will be packed in this order:
     * (<var>Δx₀</var>,<var>Δy₀</var>,<var>Δz₀</var>,
     *  <var>Δx₁</var>,<var>Δy₁</var>,<var>Δz₁</var> …).
     * </div>
     *
     * @param  srcPts  the array containing the source vectors.
     * @param  srcOff  the offset to the first vector to be transformed in the source array.
     * @param  dstPts  the array into which the transformed vectors are returned. Can be the same than {@code srcPts}.
     * @param  dstOff  the offset to the location of the first transformed vector that is stored in the destination array.
     * @param  numPts  the number of vector objects to be transformed.
     * @throws TransformException if a vector can not be transformed.
     *
     * @see java.awt.geom.AffineTransform#deltaTransform(double[], int, double[], int, int)
     *
     * @since 0.7
     */
    void deltaTransform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts) throws TransformException;

    /**
     * Returns the inverse transform of this object, which shall also be linear.
     * The target of the inverse transform is the source of the original.
     * The source of the inverse transform is the target of the original.
     *
     * @return the inverse transform.
     * @throws NoninvertibleTransformException if the transform can not be inverted.
     *
     * @see java.awt.geom.AffineTransform#createInverse()
     *
     * @since 0.7
     */
    @Override
    LinearTransform inverse() throws NoninvertibleTransformException;
}
