C06PAF (PDF version)
C06 Chapter Contents
C06 Chapter Introduction
NAG Library Manual

NAG Library Routine Document

C06PAF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

 Contents

    1  Purpose
    7  Accuracy

1  Purpose

C06PAF calculates the discrete Fourier transform of a sequence of n real data values or of a Hermitian sequence of n complex data values stored in compact form in a real array.

2  Specification

SUBROUTINE C06PAF ( DIRECT, X, N, WORK, IFAIL)
INTEGER  N, IFAIL
REAL (KIND=nag_wp)  X(N+2), WORK(*)
CHARACTER(1)  DIRECT

3  Description

Given a sequence of n real data values xj , for j=0,1,,n-1, C06PAF calculates their discrete Fourier transform (in the forward direction) defined by
z^k = 1n j=0 n-1 xj × exp -i 2πjk n ,   k= 0, 1, , n-1 .  
The transformed values z^k  are complex, but they form a Hermitian sequence (i.e., z^ n-k  is the complex conjugate of z^k ), so they are completely determined by n real numbers (since z^0  is real, as is z^ n/2  for n even).
Alternatively, given a Hermitian sequence of n complex data values zj , this routine calculates their inverse (backward) discrete Fourier transform defined by
x^k = 1n j=0 n-1 zj × exp i 2πjk n ,   k= 0, 1, , n-1 .  
The transformed values x^k  are real.
(Note the scale factor of 1n  in the above definitions.)
A call of C06PAF with DIRECT='F' followed by a call with DIRECT='B' will restore the original data.
C06PAF 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).
The same functionality is available using the forward and backward transform routine pair: C06PVF and C06PWF on setting N=1. This pair use a different storage solution; real data is stored in a real array, while Hermitian data (the first unconjugated half) is stored in a complex array.

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 – CHARACTER(1)Input
On entry: if the forward transform as defined in Section 3 is to be computed, then DIRECT must be set equal to 'F'.
If the backward transform is to be computed then DIRECT must be set equal to 'B'.
Constraint: DIRECT='F' or 'B'.
2:     X N+2 – REAL (KIND=nag_wp) arrayInput/Output
On entry: if X is declared with bounds 0:N+1 in the subroutine from which C06PAF is called, then:
  • if DIRECT='F', Xj must contain xj, for j=0,1,,n-1;
  • if DIRECT='B', X2×k and X2×k+1 must contain the real and imaginary parts respectively of zk, for k=0,1,,n/2. (Note that for the sequence zk to be Hermitian, the imaginary part of z0, and of zn/2  for n even, must be zero.)
On exit:
  • if DIRECT='F' and X is declared with bounds 0:N+1, X2×k and X2×k+1 will contain the real and imaginary parts respectively of z^k, for k=0,1,,n/2;
  • if DIRECT='B' and X is declared with bounds 0:N+1, Xj will contain x^j, for j=0,1,,n-1.
3:     N – INTEGERInput
On entry: n, the number of data values.
Constraint: N1.
4:     WORK* – REAL (KIND=nag_wp) arrayWorkspace
Note: the dimension of the array WORK must be at least 3 × N+100.
The workspace requirements as documented for C06PAF may be an overestimate in some implementations.
On exit: WORK1 contains the minimum workspace required for the current value of N with this implementation.
5:     IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to 0, -1​ or ​1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ or ​1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this argument, the recommended value is 0. 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 or -1, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
IFAIL=1
On entry, N=value.
Constraint: N1.
IFAIL=2
value is an invalid value of DIRECT.
IFAIL=3
An internal error has occurred in this routine. Check the routine call and any array sizes. If the call is correct then please contact NAG for assistance.
IFAIL=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
IFAIL=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
IFAIL=-999
Dynamic memory allocation failed.
See Section 3.7 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

C06PAF is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
C06PAF 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 × logn, but also depends on the factorization of n. C06PAF is faster if the only prime factors of n are 2, 3 or 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 C06PAF with DIRECT='F'), after expanding it from complex Hermitian form into a full complex sequence. It then performs an inverse transform using C06PAF with DIRECT='B', and prints the sequence so obtained alongside the original data values.

10.1  Program Text

Program Text (c06pafe.f90)

10.2  Program Data

Program Data (c06pafe.d)

10.3  Program Results

Program Results (c06pafe.r)


C06PAF (PDF version)
C06 Chapter Contents
C06 Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2016