NAG Library Routine Document

C06RGF

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

▸▿ 10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1 Purpose

C06RGF computes the discrete quarter-wave Fourier sine transforms of

m

sequences of real data values. The elements of each sequence and its transform are stored contiguously.

2 Specification

SUBROUTINE C06RGF (

IDIR, M, N, X, IFAIL)

INTEGER	IDIR, M, N, IFAIL
REAL (KIND=nag_wp)	X(N,M)

3 Description

Given

m

sequences of

n

real data values

x_{j}^{p}

, for

j = 1, 2, \dots, n

and

p = 1, 2, \dots, m

, C06RGF simultaneously calculates the quarter-wave Fourier sine transforms of all the sequences defined by

{\hat{x}}_{k}^{p} = \frac{1}{\sqrt{n}} (\sum_{j = 1}^{n - 1} x_{j}^{p} \times \sin (j (2 k - 1) \frac{π}{2 n}) + \frac{1}{2} {(- 1)}^{k - 1} x_{n}^{p}),   if ​ IDIR = 1,

or its inverse

x_{k}^{p} = \frac{2}{\sqrt{n}} \sum_{j = 1}^{n} {\hat{x}}_{j}^{p} \times \sin ((2 j - 1) k \frac{π}{2 n}),   if ​ IDIR = - 1,

where

k = 1, 2, \dots, n

and

p = 1, 2, \dots, m

(Note the scale factor

\frac{1}{\sqrt{n}}

in this definition.)

A call of C06RGF with

IDIR = 1

followed by a call with

IDIR = - 1

will restore the original data.

The two transforms are also known as type-III DST and type-II DST, respectively.

The transform calculated by this routine can be used to solve Poisson's equation when the solution is specified at the left boundary, and the derivative of the solution is specified at the right boundary (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 Parameters

1: $IDIR$ – INTEGERInput

On entry: indicates the transform, as defined in Section 3, to be computed.

$IDIR = 1$: Forward transform.
$IDIR = - 1$: Inverse transform.

Constraint:

IDIR = 1

- 1

2: $M$ – INTEGERInput

On entry:

m

, the number of sequences to be transformed.

Constraint:

M \geq 1

3: $N$ – INTEGERInput

On entry:

n

, the number of real values in each sequence.

Constraint:

N \geq 1

4: $X (N, M)$ – REAL (KIND=nag_wp) arrayInput/Output

On entry: the data values of the

p

th sequence to be transformed, denoted by

x_{j}^{p}

, for

j = 1, 2, \dots, n

and

p = 1, 2, \dots, m

, must be stored in

X (j, p)

On exit: the

n

components of the

p

th quarter-wave sine transform, denoted by

{\hat{x}}_{k}^{p}

, for

k = 1, 2, \dots, n

and

p = 1, 2, \dots, m

, are stored in

X (k, p)

, overwriting the corresponding original values.

5: $IFAIL$ – INTEGERInput/Output

On entry: IFAIL must be set to

0

- 1 ​ 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 ​ 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 $- 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

- 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, $M = 〈value〉$ .
Constraint: $M \geq 1$ .

$IFAIL = 2$: On entry, $N = 〈value〉$ .
Constraint: $N \geq 1$ .

$IFAIL = 3$: On entry, $IDIR = 〈value〉$ .
Constraint: $IDIR = - 1$ or $1$ .

$IFAIL = 4$: 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.8 in the Essential Introduction for further information.

$IFAIL = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.

$IFAIL = - 999$: Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction 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

C06RGF 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.

9 Further Comments

The time taken by C06RGF is approximately proportional to

n m \log (n)

, but also depends on the factors of

n

. C06RGF 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

O (n)

is internally allocated by this routine.

10 Example

This example reads in sequences of real data values and prints their quarter-wave sine transforms as computed by C06RGF with

IDIR = 1

. It then calls the routine again with

IDIR = - 1

and prints the results which may be compared with the original data.

NAG Library Routine DocumentC06RGF

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG Library Routine Document

C06RGF