1: $x (n)$ – Real (Kind=nag_wp) array Input/Output: On entry: if x is declared with bounds $(0 : n - 1)$ in the subroutine from which c06faf is called, $x (j)$ must contain $x_{j}$ , for $j = 0, 1, \dots, n - 1$ .

On exit: the discrete Fourier transform stored in Hermitian form. If the components of the transform ${\hat{z}}_{k}$ are written as $a_{k} + i b_{k}$ , and if x is declared with bounds $(0 : n - 1)$ in the subroutine from which c06faf is called, then for $0 \leq k \leq n / 2$ , $a_{k}$ is contained in $x (k)$ , and for $1 \leq k \leq (n - 1) / 2$ , $b_{k}$ is contained in $x (n - k)$ . (See also Section 2.1.2 in the C06 Chapter Introduction and Section 10.)
2: $n$ – Integer Input: On entry: $n$ , the number of data values.

Constraint: $n > 1$ .
3: $work (n)$ – Real (Kind=nag_wp) array Workspace
4: $ifail$ – Integer Input/Output: On entry: ifail must be set to $0$ , $- 1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $- 1$ means that an error message is printed while a value of $1$ means that it is not.

If halting is not appropriate, the value $- 1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $- 1$ or $1$ is used it is essential to test the value of ifail on exit.

On exit: $ifail = 0$ unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

ifail = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 3$: On entry, $n = 〈value〉$ .
Constraint: $n > 1$ .

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface 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

c06faf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

c06faf 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 routine. 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)

, but also depends on the factorization of

n

. c06faf is faster if the only prime factors of

n

are

2

3

5

; and fastest of all if

n

is a power of

2

10 Example

This example reads in a sequence of real data values and prints their discrete Fourier transform (as computed by c06faf), after expanding it from Hermitian form into a full complex sequence. It then performs an inverse transform using c06fbf and conjugation, and prints the sequence so obtained alongside the original data values.

c06fa: FL CL CPP AD

NAG FL Interfacec06faf (fft_​real_​1d_​rfmt)

▸▿ 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

NAG FL Interface
c06faf (fft_real_1d_rfmt)