C06 Chapter Contents
C06 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentC06REF

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

C06REF computes the discrete Fourier sine transforms of $m$ sequences of real data values. The elements of each sequence and its transform are stored contiguously.

## 2  Specification

 SUBROUTINE C06REF ( M, N, X, IFAIL)
 INTEGER M, N, IFAIL REAL (KIND=nag_wp) X(N-1,M)

## 3  Description

Given $m$ sequences of $n-1$ real data values ${x}_{\mathit{j}}^{\mathit{p}}$, for $\mathit{j}=1,2,\dots ,n-1$ and $\mathit{p}=1,2,\dots ,m$, C06REF simultaneously calculates the Fourier sine transforms of all the sequences defined by
 $x^ k p = 2n ∑ j=1 n-1 xjp × sin jk πn , k= 1, 2, …, n-1 ​ and ​ p= 1, 2, …, m .$
(Note the scale factor $\sqrt{\frac{2}{n}}$ in this definition.)
This transform is also known as type-I DST.
Since the Fourier sine transform defined above is its own inverse, two consecutive calls of C06REF will restore the original data.
The transform calculated by this routine can be used to solve Poisson's equation when the solution is specified at both left and right boundaries (see Swarztrauber (1977)).
The routine uses a variant of the fast Fourier transform (FFT) algorithm (see Brigham (1974)) known as the Stockham self-sorting algorithm, described in Temperton (1983), together with pre- and post-processing stages described in Swarztrauber (1982). Special coding is provided for the factors $2$, $3$, $4$ and $5$.

## 4  References

Brigham E O (1974) The Fast Fourier Transform Prentice–Hall
Swarztrauber P N (1977) The methods of cyclic reduction, Fourier analysis and the FACR algorithm for the discrete solution of Poisson's equation on a rectangle SIAM Rev. 19(3) 490–501
Swarztrauber P N (1982) Vectorizing the FFT's Parallel Computation (ed G Rodrique) 51–83 Academic Press
Temperton C (1983) Fast mixed-radix real Fourier transforms J. Comput. Phys. 52 340–350

## 5  Arguments

1:     $\mathrm{M}$ – INTEGERInput
On entry: $m$, the number of sequences to be transformed.
Constraint: ${\mathbf{M}}\ge 1$.
2:     $\mathrm{N}$ – INTEGERInput
On entry: one more than the number of real values in each sequence, i.e., the number of values in each sequence is $n-1$.
Constraint: ${\mathbf{N}}\ge 1$.
3:     $\mathrm{X}\left({\mathbf{N}}-1,{\mathbf{M}}\right)$ – REAL (KIND=nag_wp) arrayInput/Output
On entry: the data values of the $\mathit{p}$th sequence to be transformed, denoted by ${x}_{\mathit{j}}^{\mathit{p}}$, for $\mathit{j}=1,2,\dots ,n-1$ and $\mathit{p}=1,2,\dots ,m$, must be stored in ${\mathbf{X}}\left(j,p\right)$.
On exit: the $\left(n-1\right)$ components of the $\mathit{p}$th Fourier sine transform, denoted by ${\stackrel{^}{x}}_{\mathit{k}}^{\mathit{p}}$, for $\mathit{k}=1,2,\dots ,n-1$ and $\mathit{p}=1,2,\dots ,m$, are stored in ${\mathbf{X}}\left(k,p\right)$, overwriting the corresponding original values.
4:     $\mathrm{IFAIL}$ – INTEGERInput/Output
On entry: IFAIL must be set to $0$, $-1\text{​ 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\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 argument, 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}}=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:
${\mathbf{IFAIL}}=1$
On entry, ${\mathbf{M}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{M}}\ge 1$.
${\mathbf{IFAIL}}=2$
On entry, ${\mathbf{N}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{N}}\ge 1$.
${\mathbf{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.
${\mathbf{IFAIL}}=-99$
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
${\mathbf{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.
${\mathbf{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

C06REF is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
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.

The time taken by C06REF is approximately proportional to $nm\mathrm{log}\left(n\right)$, but also depends on the factors of $n$. C06REF 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. Workspace of order $\mathit{O}\left(n\right)$ is internally allocated by this routine.

## 10  Example

This example reads in sequences of real data values and prints their Fourier sine transforms (as computed by C06REF). It then calls C06REF again and prints the results which may be compared with the original sequence.

### 10.1  Program Text

Program Text (c06refe.f90)

### 10.2  Program Data

Program Data (c06refe.d)

### 10.3  Program Results

Program Results (c06refe.r)