java.lang.Object
- org.apache.commons.math.transform.FastSineTransformer

All Implemented Interfaces:

RealTransformer
```
public class FastSineTransformer
extends java.lang.Object
implements RealTransformer
```
Implements the Fast Sine Transform for transformation of one-dimensional data sets. For reference, see Fast Fourier Transforms, ISBN 0849371635, chapter 3.
FST is its own inverse, up to a multiplier depending on conventions. The equations are listed in the comments of the corresponding methods.

Similar to FFT, we also require the length of data set to be power of 2. In addition, the first element must be 0 and it's enforced in function transformation after sampling.

As of version 2.0 this no longer implements Serializable

Since:

1.2

Version:

$Revision: 1070725 $ $Date: 2011-02-15 02:31:12 +0100 (mar. 15 févr. 2011) $

Constructor Summary

Constructors
Constructor Description

FastSineTransformer()
Construct a default transformer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected double[]`	`fst(double[] f)`	Perform the FST algorithm (including inverse).
`double[]`	`inversetransform(double[] f)`	Inversely transform the given real data set.
`double[]`	`inversetransform(UnivariateRealFunction f, double min, double max, int n)`	Inversely transform the given real function, sampled on the given interval.
`double[]`	`inversetransform2(double[] f)`	Inversely transform the given real data set.
`double[]`	`inversetransform2(UnivariateRealFunction f, double min, double max, int n)`	Inversely transform the given real function, sampled on the given interval.
`double[]`	`transform(double[] f)`	Transform the given real data set.
`double[]`	`transform(UnivariateRealFunction f, double min, double max, int n)`	Transform the given real function, sampled on the given interval.
`double[]`	`transform2(double[] f)`	Transform the given real data set.
`double[]`	`transform2(UnivariateRealFunction f, double min, double max, int n)`	Transform the given real function, sampled on the given interval.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FastSineTransformer
```
public FastSineTransformer()
```
    Construct a default transformer.
- Method Detail
  - transform
```
public double[] transform(double[] f)
                   throws java.lang.IllegalArgumentException
```
    Transform the given real data set.
    The formula is F_n = ∑_k=0^N-1 f_k sin(π nk/N)
    
    Specified by:
    
    transform in interface RealTransformer
    
    Parameters:
    
    f - the real data array to be transformed
    
    Returns:
    
    the real transformed array
    
    Throws:
    
    java.lang.IllegalArgumentException - if any parameters are invalid
  - transform
```
public double[] transform(UnivariateRealFunction f,
                          double min,
                          double max,
                          int n)
                   throws FunctionEvaluationException,
                          java.lang.IllegalArgumentException
```
    Transform the given real function, sampled on the given interval.
    The formula is F_n = ∑_k=0^N-1 f_k sin(π nk/N)
    
    Specified by:
    
    transform in interface RealTransformer
    
    Parameters:
    
    f - the function to be sampled and transformed
    
    min - the lower bound for the interval
    
    max - the upper bound for the interval
    
    n - the number of sample points
    
    Returns:
    
    the real transformed array
    
    Throws:
    
    FunctionEvaluationException - if function cannot be evaluated at some point
    
    java.lang.IllegalArgumentException - if any parameters are invalid
  - transform2
```
public double[] transform2(double[] f)
                    throws java.lang.IllegalArgumentException
```
    Transform the given real data set.
    The formula is F_n = √(2/N) ∑_k=0^N-1 f_k sin(π nk/N)
    
    Parameters:
    
    f - the real data array to be transformed
    
    Returns:
    
    the real transformed array
    
    Throws:
    
    java.lang.IllegalArgumentException - if any parameters are invalid
  - transform2
```
public double[] transform2(UnivariateRealFunction f,
                           double min,
                           double max,
                           int n)
                    throws FunctionEvaluationException,
                           java.lang.IllegalArgumentException
```
    Transform the given real function, sampled on the given interval.
    The formula is F_n = √(2/N) ∑_k=0^N-1 f_k sin(π nk/N)
    
    Parameters:
    
    f - the function to be sampled and transformed
    
    min - the lower bound for the interval
    
    max - the upper bound for the interval
    
    n - the number of sample points
    
    Returns:
    
    the real transformed array
    
    Throws:
    
    FunctionEvaluationException - if function cannot be evaluated at some point
    
    java.lang.IllegalArgumentException - if any parameters are invalid
  - inversetransform
```
public double[] inversetransform(double[] f)
                          throws java.lang.IllegalArgumentException
```
    Inversely transform the given real data set.
    The formula is f_k = (2/N) ∑_n=0^N-1 F_n sin(π nk/N)
    
    Specified by:
    
    inversetransform in interface RealTransformer
    
    Parameters:
    
    f - the real data array to be inversely transformed
    
    Returns:
    
    the real inversely transformed array
    
    Throws:
    
    java.lang.IllegalArgumentException - if any parameters are invalid
  - inversetransform
```
public double[] inversetransform(UnivariateRealFunction f,
                                 double min,
                                 double max,
                                 int n)
                          throws FunctionEvaluationException,
                                 java.lang.IllegalArgumentException
```
    Inversely transform the given real function, sampled on the given interval.
    The formula is f_k = (2/N) ∑_n=0^N-1 F_n sin(π nk/N)
    
    Specified by:
    
    inversetransform in interface RealTransformer
    
    Parameters:
    
    f - the function to be sampled and inversely transformed
    
    min - the lower bound for the interval
    
    max - the upper bound for the interval
    
    n - the number of sample points
    
    Returns:
    
    the real inversely transformed array
    
    Throws:
    
    FunctionEvaluationException - if function cannot be evaluated at some point
    
    java.lang.IllegalArgumentException - if any parameters are invalid
  - inversetransform2
```
public double[] inversetransform2(double[] f)
                           throws java.lang.IllegalArgumentException
```
    Inversely transform the given real data set.
    The formula is f_k = √(2/N) ∑_n=0^N-1 F_n sin(π nk/N)
    
    Parameters:
    
    f - the real data array to be inversely transformed
    
    Returns:
    
    the real inversely transformed array
    
    Throws:
    
    java.lang.IllegalArgumentException - if any parameters are invalid
  - inversetransform2
```
public double[] inversetransform2(UnivariateRealFunction f,
                                  double min,
                                  double max,
                                  int n)
                           throws FunctionEvaluationException,
                                  java.lang.IllegalArgumentException
```
    Inversely transform the given real function, sampled on the given interval.
    The formula is f_k = √(2/N) ∑_n=0^N-1 F_n sin(π nk/N)
    
    Parameters:
    
    f - the function to be sampled and inversely transformed
    
    min - the lower bound for the interval
    
    max - the upper bound for the interval
    
    n - the number of sample points
    
    Returns:
    
    the real inversely transformed array
    
    Throws:
    
    FunctionEvaluationException - if function cannot be evaluated at some point
    
    java.lang.IllegalArgumentException - if any parameters are invalid
  - fst
```
protected double[] fst(double[] f)
                throws java.lang.IllegalArgumentException
```
    Perform the FST algorithm (including inverse).
    
    Parameters:
    
    f - the real data array to be transformed
    
    Returns:
    
    the real transformed array
    
    Throws:
    
    java.lang.IllegalArgumentException - if any parameters are invalid

Class FastSineTransformer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FastSineTransformer

Method Detail

transform

transform

transform2

transform2

inversetransform

inversetransform

inversetransform2

inversetransform2

fst