DstNormalization (Apache Commons Math 4.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<DstNormalization>
- - org.apache.commons.math4.transform.DstNormalization

All Implemented Interfaces:

Serializable, Comparable<DstNormalization>
```
public enum DstNormalization
extends Enum<DstNormalization>
```
This enumeration defines the various types of normalizations that can be applied to discrete sine transforms (DST). The exact definition of these normalizations is detailed below.

Since:

3.0

See Also:
FastSineTransformer

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ORTHOGONAL_DST_I` Should be passed to the constructor of `FastSineTransformer` to use the orthogonal normalization convention.
`STANDARD_DST_I` Should be passed to the constructor of `FastSineTransformer` to use the standard normalization convention.

Method Summary

Methods
Modifier and Type	Method and Description
`static DstNormalization`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DstNormalization[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - STANDARD_DST_I
```
public static final DstNormalization STANDARD_DST_I
```
    Should be passed to the constructor of FastSineTransformer to use the standard normalization convention. The standard DST-I normalization convention is defined as follows
    - forward transform: y_n = ∑_k=0^N-1 x_k sin(π nk / N),
    - inverse transform: x_k = (2 / N) ∑_n=0^N-1 y_n sin(π nk / N),
    where N is the size of the data sample, and x₀ = 0.
  - ORTHOGONAL_DST_I
```
public static final DstNormalization ORTHOGONAL_DST_I
```
    Should be passed to the constructor of FastSineTransformer to use the orthogonal normalization convention. The orthogonal DCT-I normalization convention is defined as follows
    - Forward transform: y_n = √(2 / N) ∑_k=0^N-1 x_k sin(π nk / N),
    - Inverse transform: x_k = √(2 / N) ∑_n=0^N-1 y_n sin(π nk / N),
    which makes the transform orthogonal. N is the size of the data sample, and x₀ = 0.
- Method Detail
  - values
```
public static DstNormalization[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (DstNormalization c : DstNormalization.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DstNormalization valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum DstNormalization

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

STANDARD_DST_I

ORTHOGONAL_DST_I

Method Detail

values

valueOf