C06 Chapter Contents
C06 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentC06FRF

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

C06FRF computes the discrete Fourier transforms of $m$ sequences, each containing $n$ complex data values. This routine is designed to be particularly efficient on vector processors.

## 2  Specification

 SUBROUTINE C06FRF ( M, N, X, Y, INIT, TRIG, WORK, IFAIL)
 INTEGER M, N, IFAIL REAL (KIND=nag_wp) X(M*N), Y(M*N), TRIG(2*N), WORK(2*M*N) CHARACTER(1) INIT

## 3  Description

Given $m$ sequences of $n$ complex data values ${z}_{\mathit{j}}^{\mathit{p}}$, for $\mathit{j}=0,1,\dots ,n-1$ and $\mathit{p}=1,2,\dots ,m$, C06FRF simultaneously calculates the Fourier transforms of all the sequences defined by
 $z^kp = 1n ∑ j=0 n-1 zjp × exp -i 2πjk n , k= 0, 1, …, n-1 ​ and ​ p= 1,2,…,m .$
(Note the scale factor $\frac{1}{\sqrt{n}}$ in this definition.)
The discrete Fourier transform is sometimes defined using a positive sign in the exponential term
 $z^kp = 1n ∑ j=0 n-1 zjp × exp +i 2πjk n .$
To compute this form, this routine should be preceded and followed by a call of C06GCF to form the complex conjugates of the ${z}_{j}^{p}$ and the ${\stackrel{^}{z}}_{k}^{p}$.
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 code is provided for the factors $2$, $3$, $4$, $5$ and $6$. This routine is designed to be particularly efficient on vector processors, and it becomes especially fast as $m$, the number of transforms to be computed in parallel, increases.

## 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  Parameters

1:     M – INTEGERInput
On entry: $m$, the number of sequences to be transformed.
Constraint: ${\mathbf{M}}\ge 1$.
2:     N – INTEGERInput
On entry: $n$, the number of complex values in each sequence.
Constraint: ${\mathbf{N}}\ge 1$.
3:     X(${\mathbf{M}}×{\mathbf{N}}$) – REAL (KIND=nag_wp) arrayInput/Output
4:     Y(${\mathbf{M}}×{\mathbf{N}}$) – REAL (KIND=nag_wp) arrayInput/Output
On entry: the real and imaginary parts of the complex data must be stored in X and Y respectively 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 each array. In other words, if the real parts of the $p$th sequence to be transformed are denoted by ${x}_{\mathit{j}}^{p}$, for $\mathit{j}=0,1,\dots ,n-1$, then the $mn$ elements of the array X must contain the values
 $x01 , x02 ,…, x0m , x11 , x12 ,…, x1m ,…, x n-1 1 , x n-1 2 ,…, x n-1 m .$
On exit: X and Y are overwritten by the real and imaginary parts of the complex transforms.
5:     INIT – CHARACTER(1)Input
On entry: indicates whether trigonometric coefficients are to be calculated.
${\mathbf{INIT}}=\text{'I'}$
Calculate the required trigonometric coefficients for the given value of $n$, and store in the array TRIG.
${\mathbf{INIT}}=\text{'S'}$ or $\text{'R'}$
The required trigonometric coefficients are assumed to have been calculated and stored in the array TRIG in a prior call to one of C06FPF, C06FQF or C06FRF. The routine performs a simple check that the current value of $n$ is consistent with the values stored in TRIG.
Constraint: ${\mathbf{INIT}}=\text{'I'}$, $\text{'S'}$ or $\text{'R'}$.
6:     TRIG($2×{\mathbf{N}}$) – REAL (KIND=nag_wp) arrayInput/Output
On entry: if ${\mathbf{INIT}}=\text{'S'}$ or $\text{'R'}$, TRIG must contain the required trigonometric coefficients that have been previously calculated. Otherwise TRIG need not be set.
On exit: contains the required coefficients (computed by the routine if ${\mathbf{INIT}}=\text{'I'}$).
7:     WORK($2×{\mathbf{M}}×{\mathbf{N}}$) – REAL (KIND=nag_wp) arrayWorkspace
8:     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{INIT}}\ne \text{'I'}$, $\text{'S'}$ or $\text{'R'}$.
${\mathbf{IFAIL}}=4$
Not used at this Mark.
${\mathbf{IFAIL}}=5$
 On entry, ${\mathbf{INIT}}=\text{'S'}$ or $\text{'R'}$, but the array TRIG and the current value of N are inconsistent.
${\mathbf{IFAIL}}=6$
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 C06FRF is approximately proportional to $nm\mathrm{log}n$, but also depends on the factors of $n$. C06FRF 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 complex data values and prints their discrete Fourier transforms (as computed by C06FRF). Inverse transforms are then calculated using C06FRF and C06GCF and printed out, showing that the original sequences are restored.

### 9.1  Program Text

Program Text (c06frfe.f90)

### 9.2  Program Data

Program Data (c06frfe.d)

### 9.3  Program Results

Program Results (c06frfe.r)