NAG C Library Function Document

. The plus or minus sign in the argument of the exponential terms in the above definition determine the direction of the transform: a minus sign defines the forward direction and a plus sign defines the backward direction.

(Note the scale factor of

\frac{1}{\sqrt{n_{l}}}

in this definition.)

A call of nag_fft_multid_single (c06pfc) with

direct = Nag_ForwardTransform

followed by a call with

direct = Nag_BackwardTransform

will restore the original data.

The data values must be supplied in a one-dimensional complex array using column-major storage ordering of multidimensional data (i.e., with the first subscript

j_{1}

varying most rapidly).

This function uses a variant of the fast Fourier transform (FFT) algorithm (see Brigham (1974)) known as the Stockham self-sorting algorithm, which is described in Temperton (1983).

4

References

Brigham E O (1974) The Fast Fourier Transform Prentice–Hall

Temperton C (1983) Self-sorting mixed-radix fast Fourier transforms J. Comput. Phys. 52 1–23

5

Arguments

1: $direct$ – Nag_TransformDirectionInput: On entry: if the forward transform as defined in Section 3 is to be computed, direct must be set equal to $Nag_ForwardTransform$ .
If the backward transform is to be computed, direct must be set equal to $Nag_BackwardTransform$ .

Constraint: $direct = Nag_ForwardTransform$ or $Nag_BackwardTransform$ .
2: $ndim$ – IntegerInput: On entry: $m$ , the number of dimensions (or variables) in the multivariate data.

Constraint: $ndim \geq 1$ .
3: $l$ – IntegerInput: On entry: $l$ , the index of the variable (or dimension) on which the discrete Fourier transform is to be performed.

Constraint: $1 \leq l \leq ndim$ .
4: $nd [ndim]$ – const IntegerInput: On entry: the elements of nd must contain the dimensions of the ndim variables; that is, $nd [i - 1]$ must contain the dimension of the $i$ th variable.

Constraint: $nd [i - 1] \geq 1$ , for $i = 1, 2, \dots, ndim$ .
5: $n$ – IntegerInput: On entry: $n$ , the total number of data values.

Constraint: n must equal the product of the first ndim elements of the array nd.
6: $x [n]$ – ComplexInput/Output: On entry: the complex data values. Data values are stored in x using column-major ordering for storing multidimensional arrays; that is, $z_{j_{1} j_{2} \dots j_{m}}$ is stored in $x [j_{1} + n_{1} j_{2} + n_{1} n_{2} j_{3} + \dots]$ .

On exit: the corresponding elements of the computed transform.
7: $fail$ – NagError *Input/Output: The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6

Error Indicators and Warnings

NE_ALLOC_FAIL: Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
NE_BAD_PARAM: On entry, argument $〈value〉$ had an illegal value.
NE_INT: On entry, $l = 〈value〉$ .
Constraint: $1 \leq l \leq ndim$ .

On entry, $ndim = 〈value〉$ .
Constraint: $ndim \geq 1$ .
NE_INT_2: On entry, $n = 〈value〉$ , product of nd elements is $〈value〉$ .
Constraint: n must equal the product of the dimensions held in array nd.

On entry, $nd [〈value〉] = 〈value〉$ .
Constraint: $nd [i - 1] \geq 1$ , for all $i$ .
NE_INTERNAL_ERROR: An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
NE_NO_LICENCE: Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

Some indication of accuracy can be obtained by performing a subsequent inverse transform and comparing the results with the original sequence (in exact arithmetic they would be identical).

8

Parallelism and Performance

nag_fft_multid_single (c06pfc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

nag_fft_multid_single (c06pfc) makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

Please consult the x06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9

Further Comments

The time taken is approximately proportional to

n \times \log n_{l}

, but also depends on the factorization of

n_{l}

. nag_fft_multid_single (c06pfc) is faster if the only prime factors of

n_{l}

are

2

3

5

; and fastest of all if

n_{l}

is a power of

2

10

Example

This example reads in a bivariate sequence of complex data values and prints the discrete Fourier transform of the second variable. It then performs an inverse transform and prints the sequence so obtained, which may be compared with the original data values.

NAG C Library Function Document

nag_fft_multid_single (c06pfc)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1

Purpose

2

Specification

3

Description