/*
* RapidMiner
*
* Copyright (C) 2001-2008 by Rapid-I and the contributors
*
* Complete list of developers available at our web site:
*
* http://rapid-i.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*/
package com.rapidminer.gui.plotter;
/**
* Transforms the given value, e.g. by just returning it (id) or applying a
* log function.
*
* @author Ingo Mierswa
* @version $Id: AxisTransformation.java,v 1.3 2008/05/09 19:22:51 ingomierswa Exp $
*/
public interface AxisTransformation {
/** Transforms the given value, e.g. by just returning it (id) or applying a
* log function. Please note that this method might throw an IllegalArgumentException
* if the number is not supported. */
public double transform(double value);
/** Returns the inverse transformation of the given value, e.g. just returning it (id) or applying a
* exponential function (for log transformation). Please note that this method might throw an
* IllegalArgumentException if the number is not supported. */
public double inverseTransform(double value);
/** Returns the formatted value. Might return null. The format number indicates the number of
* format calls done before. */
public String format(double value, int formatNumber);
/** Adapts the minimum corresponding to the given tic size. */
public double adaptTicsMin(double min, double ticSize);
/** Adapts the maximum corresponding to the given tic size. */
public double adaptTicsMax(double max, double ticSize);
}