Package ffx.numerics.fft

Enum Class DataLayout1D

java.lang.Object

java.lang.Enum<DataLayout1D>

ffx.numerics.fft.DataLayout1D

All Implemented Interfaces:

Serializable, Comparable<DataLayout1D>, Constable

public enum DataLayout1D
extends Enum<DataLayout1D>

The Complex FFT supports interleaved or blocked data.

For interleaved data, the complex data is stored in the following way:

 Re(d[i]) = data[offset + stride*i]
 Im(d[i]) = data[offset + stride*i + 1]
 

For blocked data, the complex data is stored in the following way:

 Re(d[i]) = data[offset + stride*i]
 Im(d[i]) = data[offset + stride*i + im]
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCKED	Blocked data layout.
INTERLEAVED	Interleaved data layout.

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INTERLEAVED

public static final DataLayout1D INTERLEAVED

Interleaved data layout.

BLOCKED

public static final DataLayout1D BLOCKED

Blocked data layout.

Method Details

values

public static DataLayout1D[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DataLayout1D valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null