C06 Chapter Contents
C06 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentC06PPF

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.

## 1  Purpose

C06PPF computes the discrete Fourier transforms of $m$ sequences, each containing $n$ real data values or a Hermitian complex sequence stored in a complex storage format.

## 2  Specification

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

## 3  Description

Given $m$ sequences of $n$ real data values ${x}_{\mathit{j}}^{\mathit{p}}$, for $\mathit{j}=0,1,\dots ,n-1$ and $\mathit{p}=1,2,\dots ,m$, C06PPF simultaneously calculates the Fourier transforms of all the sequences defined by
 $z^ k p = 1n ∑ j=0 n-1 xjp × exp -i 2πjkn , k= 0, 1, …, n-1 ​ and ​ p= 1, 2, …, m.$
The transformed values ${\stackrel{^}{z}}_{k}^{p}$ are complex, but for each value of $p$ the ${\stackrel{^}{z}}_{k}^{p}$ form a Hermitian sequence (i.e., ${\stackrel{^}{z}}_{n-k}^{p}$ is the complex conjugate of ${\stackrel{^}{z}}_{k}^{p}$), so they are completely determined by $mn$ real numbers (since ${\stackrel{^}{z}}_{0}^{p}$ is real, as is ${\stackrel{^}{z}}_{n/2}^{p}$ for $n$ even).
Alternatively, given $m$ Hermitian sequences of $n$ complex data values ${z}_{j}^{p}$, this routine simultaneously calculates their inverse (backward) discrete Fourier transforms defined by
 $x^kp = 1n ∑ j=0 n-1 zjp × exp i 2πjkn , k=0,1,…,n-1 ​ and ​ p=1,2,…,m .$
The transformed values ${\stackrel{^}{x}}_{k}^{p}$ are real.
(Note the scale factor $\frac{1}{\sqrt{n}}$ in the above definition.)
A call of C06PPF with ${\mathbf{DIRECT}}=\text{'F'}$ followed by a call with ${\mathbf{DIRECT}}=\text{'B'}$ will restore the original data.
The routine 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). Special coding is provided for the factors $2$, $3$, $4$ and $5$.

## 4  References

Brigham E O (1974) The Fast Fourier Transform Prentice–Hall
Temperton C (1983) Fast mixed-radix real Fourier transforms J. Comput. Phys. 52 340–350

## 5  Parameters

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: ${\mathbf{DIRECT}}=\text{'F'}$ or $\text{'B'}$.
2:     M – INTEGERInput
On entry: $m$, the number of sequences to be transformed.
Constraint: ${\mathbf{M}}\ge 1$.
3:     N – INTEGERInput
On entry: $n$, the number of real or complex values in each sequence.
Constraint: ${\mathbf{N}}\ge 1$.
4:     X(${\mathbf{M}}×\left({\mathbf{N}}+2\right)$) – REAL (KIND=nag_wp) arrayInput/Output
On entry: the data must be stored in X as if in a two-dimensional array of dimension $\left(1:{\mathbf{M}},0:{\mathbf{N}}-1\right)$; each of the $m$ sequences is stored in a row of the array. In other words, if the data values of the $p$th sequence to be transformed are denoted by ${x}_{\mathit{j}}^{p}$, for $\mathit{j}=0,1,\dots ,n-1$, then:
• if ${\mathbf{DIRECT}}=\text{'F'}$, ${\mathbf{X}}\left(\mathit{j}×{\mathbf{M}}+\mathit{p}\right)$ must contain ${x}_{\mathit{j}}^{\mathit{p}}$, for $\mathit{j}=0,1,\dots ,n-1$ and $\mathit{p}=1,2,\dots ,m$;
• if ${\mathbf{DIRECT}}=\text{'B'}$, ${\mathbf{X}}\left(2×\mathit{k}×{\mathbf{M}}+\mathit{p}\right)$ and ${\mathbf{X}}\left(\left(2×\mathit{k}+1\right)×{\mathbf{M}}+\mathit{p}\right)$ must contain the real and imaginary parts respectively of ${\stackrel{^}{z}}_{k}^{p}$, for $\mathit{k}=0,1,\dots ,n/2$ and $\mathit{p}=1,2,\dots ,m$. (Note that for the sequence ${\stackrel{^}{z}}_{k}^{p}$ to be Hermitian, the imaginary part of ${\stackrel{^}{z}}_{0}^{p}$, and of ${\stackrel{^}{z}}_{n/2}^{p}$ for $n$ even, must be zero.)
On exit:
• if ${\mathbf{DIRECT}}=\text{'F'}$ and X is declared with bounds $\left(1:{\mathbf{M}},0:{\mathbf{N}}+1\right)$ then ${\mathbf{X}}\left(\mathit{p},2×\mathit{k}\right)$ and ${\mathbf{X}}\left(\mathit{p},2×\mathit{k}+1\right)$ will contain the real and imaginary parts respectively of ${\stackrel{^}{z}}_{\mathit{k}}^{\mathit{p}}$, for $\mathit{k}=0,1,\dots ,n/2$ and $\mathit{p}=1,2,\dots ,m$;
• if ${\mathbf{DIRECT}}=\text{'B'}$ and X is declared with bounds $\left(1:{\mathbf{M}},0:{\mathbf{N}}+1\right)$ then ${\mathbf{X}}\left(\mathit{p},\mathit{j}\right)$ will contain ${x}_{\mathit{j}}^{\mathit{p}}$, for $\mathit{j}=0,1,\dots ,n-1$ and $\mathit{p}=1,2,\dots ,m$.
5:     WORK($*$) – REAL (KIND=nag_wp) arrayWorkspace
Note: the dimension of the array WORK must be at least ${\mathbf{M}}×{\mathbf{N}}+2×{\mathbf{N}}+2×{\mathbf{M}}+15$.
The workspace requirements as documented for C06PPF may be an overestimate in some implementations.
On exit: ${\mathbf{WORK}}\left(1\right)$ contains the minimum workspace required for the current values of M and N with this implementation.
6:     IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to $0$, $-1\text{​ or ​}1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{​ 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 parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{​ or ​}\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.
On exit: ${\mathbf{IFAIL}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6  Error Indicators and Warnings

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{1}}$, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
${\mathbf{IFAIL}}=1$
 On entry, ${\mathbf{M}}<1$.
${\mathbf{IFAIL}}=2$
 On entry, ${\mathbf{N}}<1$.
${\mathbf{IFAIL}}=3$
 On entry, ${\mathbf{DIRECT}}\ne \text{'F'}$ or $\text{'B'}$.
${\mathbf{IFAIL}}=4$
An unexpected error has occurred in an internal call. Check all subroutine calls and array dimensions. Seek expert help.

## 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).

The time taken by C06PPF is approximately proportional to $nm\mathrm{log}n$, but also depends on the factors of $n$. C06PPF is fastest if the only prime factors of $n$ are $2$, $3$ and $5$, and is particularly slow if $n$ is a large prime, or has large prime factors.

## 9  Example

This example reads in sequences of real data values and prints their discrete Fourier transforms (as computed by C06PPF with ${\mathbf{DIRECT}}=\text{'F'}$), after expanding them from complex Hermitian form into a full complex sequences. Inverse transforms are then calculated by calling C06PPF with ${\mathbf{DIRECT}}=\text{'B'}$ showing that the original sequences are restored.

### 9.1  Program Text

Program Text (c06ppfe.f90)

### 9.2  Program Data

Program Data (c06ppfe.d)

### 9.3  Program Results

Program Results (c06ppfe.r)