Package org.apache.commons.math4.transform

Enum FastCosineTransform.Norm

java.lang.Object

java.lang.Enum<FastCosineTransform.Norm>

org.apache.commons.math4.transform.FastCosineTransform.Norm

All Implemented Interfaces:

Serializable, Comparable<FastCosineTransform.Norm>

Enclosing class:

FastCosineTransform

public static enum FastCosineTransform.Norm
extends Enum<FastCosineTransform.Norm>

Normalization types.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ORTHO	Should be passed to the constructor of FastCosineTransform to use the orthogonal normalization convention.
STD	Should be passed to the constructor of FastCosineTransform to use the standard normalization convention.

Method Summary

Modifier and Type	Method	Description
static FastCosineTransform.Norm	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FastCosineTransform.Norm[]	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

STD

public static final FastCosineTransform.Norm STD

Should be passed to the constructor of FastCosineTransform to use the standard normalization convention. The standard DCT-I normalization convention is defined as follows

• forward transform: y_n = (1/2) [x₀ + (-1)ⁿx_N-1] + ∑_k=1^N-2 x_k cos[π nk / (N - 1)],
• inverse transform: x_k = [1 / (N - 1)] [y₀ + (-1)^ky_N-1] + [2 / (N - 1)] ∑_n=1^N-2 y_n cos[π nk / (N - 1)],

where N is the size of the data sample.

ORTHO

public static final FastCosineTransform.Norm ORTHO

Should be passed to the constructor of FastCosineTransform to use the orthogonal normalization convention. The orthogonal DCT-I normalization convention is defined as follows

• forward transform: y_n = [2(N - 1)]^-1/2 [x₀ + (-1)ⁿx_N-1] + [2 / (N - 1)]^1/2 ∑_k=1^N-2 x_k cos[π nk / (N - 1)],
• inverse transform: x_k = [2(N - 1)]^-1/2 [y₀ + (-1)^ky_N-1] + [2 / (N - 1)]^1/2 ∑_n=1^N-2 y_n cos[π nk / (N - 1)],

which makes the transform orthogonal. N is the size of the data sample.

Method Detail

values

public static FastCosineTransform.Norm[] 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 (FastCosineTransform.Norm c : FastCosineTransform.Norm.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FastCosineTransform.Norm 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