NAG Library Routine Document

C06PSF

1  Purpose

2  Specification

3  Description

4  References

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:     N – INTEGERInput

On entry: $n$, the number of complex values in each sequence.

Constraint: $\mathbf{N}\ge 1$.

3:     M – INTEGERInput

On entry: $m$, the number of sequences to be transformed.

Constraint: $\mathbf{M}\ge 1$.

4:     X($\mathbf{N}\times \mathbf{M}$) – COMPLEX (KIND=nag_wp) arrayInput/Output

On entry: the complex data values $z_{\mathit{j}}^p$ stored in $\mathbf{X}\left(\left(\mathit{p}-1\right)\times \mathbf{N}+\mathit{j}+1\right)$, for $\mathit{j}=1,2,\dots ,\mathbf{N}-1$ and $\mathit{p}=1,2,\dots ,\mathbf{M}$.

On exit: is overwritten by the complex transforms.

5:     WORK($*$) – COMPLEX (KIND=nag_wp) arrayWorkspace

Note: the dimension of the array WORK must be at least $\mathbf{N}\times \mathbf{M}+\mathbf{N}+15$.

The workspace requirements as documented for C06PSF may be an overestimate in some implementations.

On exit: the real part of $\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

$\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$

On entry,

N has more than $30$ prime factors.

$\mathbf{IFAIL}=5$

An unexpected error has occurred in an internal call. Check all subroutine calls and array dimensions. Seek expert help.

7  Accuracy

8  Further Comments

9  Example

9.1  Program Text

Program Text (c06psfe.f90)

9.2  Program Data

Program Data (c06psfe.d)

9.3  Program Results

Program Results (c06psfe.r)