org.sharedx.fftw

Class Plan

java.lang.Object

org.sharedx.fftw.PlanKey

org.sharedx.fftw.Plan

public class Plan
extends PlanKey

The Java peer to FFTW3 plan structures.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BACKWARD Complex-to-complex backward (IFFT).
static int	C_TO_R Half-complex-to-real (RIFFT).
static int	FFTW_ESTIMATE FFTW execution flag.
static int	FFTW_EXHAUSTIVE FFTW execution flag.
static int	FFTW_MEASURE FFTW execution flag.
static int	FFTW_PATIENT FFTW execution flag.
static int	FORWARD Complex-to-complex forward (FFT).
static int	R_TO_C Real-to-half-complex (RFFT).

Constructor Summary

Constructors

Constructor and Description
Plan(int type, int[] dims, int mode) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected byte[]	create(int type, int[] dims, int mode) Creates a pointer to the native peer.
protected void	destroy() Destroys the native peer.
static String	exportWisdom() Exports learned wisdom to a string.
static void	importWisdom(String wisdom) Imports wisdom from a string.
String	toString() Creates a human-readable representation of this plan.
void	transform(double[] in, double[] out) Performs an out-of-place transform.

Methods inherited from class org.sharedx.fftw.PlanKey

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

R_TO_C

public static final int R_TO_C

Real-to-half-complex (RFFT).

See Also:

Constant Field Values

C_TO_R

public static final int C_TO_R

Half-complex-to-real (RIFFT).

See Also:

Constant Field Values

FORWARD

public static final int FORWARD

Complex-to-complex forward (FFT).

See Also:

Constant Field Values

BACKWARD

public static final int BACKWARD

Complex-to-complex backward (IFFT).

See Also:

Constant Field Values

FFTW_ESTIMATE

public static final int FFTW_ESTIMATE

FFTW execution flag. No precomputation.

See Also:

Constant Field Values

FFTW_MEASURE

public static final int FFTW_MEASURE

FFTW execution flag. A little bit of precomputation.

See Also:

Constant Field Values

FFTW_PATIENT

public static final int FFTW_PATIENT

FFTW execution flag. Heavy precomputation.

See Also:

Constant Field Values

FFTW_EXHAUSTIVE

public static final int FFTW_EXHAUSTIVE

FFTW execution flag. Extreme precomputation.

See Also:

Constant Field Values

Constructor Detail

Plan

public Plan(int type,
    int[] dims,
    int mode)

Default constructor.

Parameters:

type - the transform type.

dims - the logical dimensions of the transform.

mode - the mode of the transform.

Method Detail

toString

public String toString()

Creates a human-readable representation of this plan.

Overrides:

toString in class Object

exportWisdom

public static final String exportWisdom()

Exports learned wisdom to a string.

Returns:

the wisdom.

importWisdom

public static final void importWisdom(String wisdom)

Imports wisdom from a string.

Parameters:

wisdom - the source of wisdom.

transform

public final void transform(double[] in,
             double[] out)

Performs an out-of-place transform.

Parameters:

in - the input array.

out - the output array.

create

protected final byte[] create(int type,
            int[] dims,
            int mode)

Creates a pointer to the native peer.

Parameters:

type - the transform type.

dims - the dimensions.

mode - the transform mode.

Returns:

a pointer to the native peer.

destroy

protected final void destroy()

Destroys the native peer.