Enum AcademicFFT.InputDataType

java.lang.Object
  extended by java.lang.Enum<AcademicFFT.InputDataType>
      extended by AcademicFFT.InputDataType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AcademicFFT.InputDataType>
Enclosing class:
AcademicFFT

public static enum AcademicFFT.InputDataType
extends java.lang.Enum<AcademicFFT.InputDataType>

This enumeration provides the constants that describe the type of input (complex or real) of a Fourier transform.

See Also:
AcademicFFT.makeHermitian(double[],double[],double[],double[]), AcademicFFT.makeHermitian(float[],float[],float[],float[])

Enum Constant Summary
COMPLEXINPUT
           The input of the Fourier transform is complex, made of a real and an imaginary part.
REALINPUT
           The input of the Fourier transform is real, although the storage for the imaginary part must still be provided to receive the output of the Fourier transform.
 
Method Summary
static AcademicFFT.InputDataType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AcademicFFT.InputDataType[] 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

COMPLEXINPUT

public static final AcademicFFT.InputDataType COMPLEXINPUT

The input of the Fourier transform is complex, made of a real and an imaginary part. The two parts must be of equal length; moreover, this length must match the length inferred at creation time of this object.


REALINPUT

public static final AcademicFFT.InputDataType REALINPUT

The input of the Fourier transform is real, although the storage for the imaginary part must still be provided to receive the output of the Fourier transform. The two parts must be of equal length; moreover, this length must match the length inferred at creation time of this object.

Method Detail

values

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

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

valueOf

public static AcademicFFT.InputDataType valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null