Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improvements to the Javadoc of transform.RealTransformer (MATH-677). 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1213151 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Sebastien Brisard 2011-12-12 06:46:22 +00:00
parent fe1b30b589
commit 69992a098e
1 changed files with 21 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/main/java/org/apache/commons/math/transform/RealTransformer.java
View File

@ -19,21 +19,23 @@ package org.apache.commons.math.transform;
import org.apache.commons.math.analysis.UnivariateFunction;
/**
* Interface for one-dimensional data sets transformations producing real results.
* <p>Interface for one-dimensional data sets transformations producing real
* results.</p>
* <p>Such transforms include {@link FastSineTransformer sine transform},
* {@link FastCosineTransformer cosine transform} or {@link
* FastHadamardTransformer Hadamard transform}. {@link FastFourierTransformer
* Fourier transform} is of a different kind and does not implement this
* interface since it produces {@link org.apache.commons.math.complex.Complex complex}
* results instead of real ones.
* </p>
* interface since it produces {@link org.apache.commons.math.complex.Complex}
* results instead of real ones.</p>
*
* @version $Id$
* @since 2.0
*/
public interface RealTransformer {
/**
* Transform the given real data set.
* Returns the forward transform of the specified real data set.
*
* @param f the real data array to be transformed (signal)
* @return the real transformed array (spectrum)
* @throws IllegalArgumentException if any parameters are invalid
@ -42,10 +44,12 @@ public interface RealTransformer {
throws IllegalArgumentException;
/**
* Transform the given real function, sampled on the given interval.
* Returns the forward transform of the specified real function, sampled on
* the specified interval.
*
* @param f the function to be sampled and transformed
* @param min the lower bound for the interval
* @param max the upper bound for the interval
* @param min the (inclusive) lower bound for the interval
* @param max the (exclusive) upper bound for the interval
* @param n the number of sample points
* @return the real transformed array
* @throws IllegalArgumentException if any parameters are invalid
@ -54,19 +58,22 @@ public interface RealTransformer {
throws IllegalArgumentException;
/**
* Inversely transform the given real data set.
* @param f the real data array to be inversely transformed (spectrum)
* @return the real inversely transformed array (signal)
* Returns the inverse transform of the specified real data set.
*
* @param f the real data array to be inversely transformed
* @return the real inversely transformed array
* @throws IllegalArgumentException if any parameters are invalid
*/
double[] inverseTransform(double[] f)
throws IllegalArgumentException;
/**
* Inversely transform the given real function, sampled on the given interval.
* Returns the inverse transform of the specified real function, sampled
* on the given interval.
*
* @param f the function to be sampled and inversely transformed
* @param min the lower bound for the interval
* @param max the upper bound for the interval
* @param min the (inclusive) lower bound for the interval
* @param max the (exclusive) upper bound for the interval
* @param n the number of sample points
* @return the real inversely transformed array
* @throws IllegalArgumentException if any parameters are invalid