Author: celestin
Date: Mon Dec 12 06:46:22 2011
New Revision: 1213151
URL: http://svn.apache.org/viewvc?rev=1213151&view=rev
Log:
Improvements to the Javadoc of transform.RealTransformer (MATH-677).
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/transform/RealTransformer.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/transform/RealTransformer.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/transform/RealTransformer.java?rev=1213151&r1=1213150&r2=1213151&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/transform/RealTransformer.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/transform/RealTransformer.java
Mon Dec 12 06:46:22 2011
@@ -19,21 +19,23 @@ package org.apache.commons.math.transfor
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
