/*
 * #%L
 * ImgLib2: a general-purpose, multidimensional image processing library.
 * %%
 * Copyright (C) 2009 - 2016 Tobias Pietzsch, Stephan Preibisch, Stephan Saalfeld,
 * John Bogovic, Albert Cardona, Barry DeZonia, Christian Dietz, Jan Funke,
 * Aivar Grislis, Jonathan Hale, Grant Harris, Stefan Helfrich, Mark Hiner,
 * Martin Horn, Steffen Jaensch, Lee Kamentsky, Larry Lindsey, Melissa Linkert,
 * Mark Longair, Brian Northan, Nick Perry, Curtis Rueden, Johannes Schindelin,
 * Jean-Yves Tinevez and Michael Zinsmaier.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */
/**
 * 
 */
package net.imglib2.transform.integer.shear;

import net.imglib2.Localizable;
import net.imglib2.Positionable;
import net.imglib2.transform.InvertibleTransform;
import net.imglib2.transform.integer.BoundingBoxTransform;

/**
 * 
 * Most simple case of a shear transform that just implements
 * for a integer valued coordinate:
 * coordinate[ shearDimension ] += coordinate[ referenceDimension ] (forward)
 * coordinate[ shearDimension ] -= coordinate[ referenceDimension ] (backward)
 * 
 * This abstract class holds the inverse and implements applyInverse in
 * terms of inverse.apply
 * 
 * @author Philipp Hanslovsky
 *
 */
public abstract class AbstractShearTransform implements InvertibleTransform, BoundingBoxTransform
{
	
	
	protected final int nDim;
	protected final int shearDimension;
	protected final int referenceDimension;
	
	protected AbstractShearTransform inverse;
	
	
	protected AbstractShearTransform(
			int nDim,
			int shearDimension,
			int referenceDimension )
	{
		this( nDim, shearDimension, referenceDimension, null );
	}
	
	
	protected AbstractShearTransform(
			int nDim,
			int shearDimension,
			int referenceDimension,
			AbstractShearTransform inverse )
	{
		this.nDim               = nDim;
		this.shearDimension     = shearDimension;
		this.referenceDimension = referenceDimension;
		this.inverse            = inverse;
	}
	
	
	public int getReferenceDimension() {
		return referenceDimension;
	}


	@Override
	public int numSourceDimensions() 
	{
		return this.numDimensions();
	}
	

	@Override
	public int numTargetDimensions() 
	{
		return this.numDimensions();
	}
	
	
	public int numDimensions() 
	{
		return nDim;
	}
	
	
	public int getShearDimension()
	{
		return this.shearDimension;
	}
	

	@Override
	public void applyInverse( long[] source, long[] target ) 
	{
		// for inverse, source and target need to be switched
		this.inverse.apply( target, source );
	}
	

	@Override
	public void applyInverse(int[] source, int[] target) 
	{
		// for inverse, source and target need to be switched
		this.inverse.apply( target, source );
	}
	

	@Override
	public void applyInverse( Positionable source, Localizable target ) 
	{
		// for inverse, source and target need to be switched
		this.inverse.apply( target, source );
	}
	

	@Override
	public AbstractShearTransform inverse() 
	{
		return this.inverse;
	}
	
	
	public abstract long[] getShear();

	
	public abstract AbstractShearTransform copy();
	
	
}
