NAG Library Routine Document
C06RBF
1 Purpose
C06RBF computes the discrete Fourier cosine transforms of sequences of real data values.
2 Specification
INTEGER |
M, N, IFAIL |
REAL (KIND=nag_wp) |
X(M*(N+3)), WORK(*) |
|
3 Description
Given
sequences of
real data values
, for
and
, C06RBF simultaneously calculates the Fourier cosine transforms of all the sequences defined by
(Note the scale factor
in this definition.)
Since the Fourier cosine transform is its own inverse, two consecutive calls of C06RBF will restore the original data.
The transform calculated by this routine can be used to solve Poisson's equation when the derivative of 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
,
,
and
.
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: M – INTEGERInput
On entry: , the number of sequences to be transformed.
Constraint:
.
- 2: N – INTEGERInput
On entry: one less than the number of real values in each sequence, i.e., the number of values in each sequence is .
Constraint:
.
- 3: X() – REAL (KIND=nag_wp) arrayInput/Output
On entry: the data must be stored in
X as if in a two-dimensional array of dimension
; each of the
sequences is stored in a
row of the array.
In other words, if the
data values of the
th sequence to be transformed are denoted by
, for
and
, then the first
elements of the array
X must contain the values
The
th and
th elements of each row
, for
, are required as workspace. These
elements may contain arbitrary values as they are set to zero by the routine.
On exit: the
Fourier cosine transforms stored as if in a two-dimensional array of dimension
. Each of the
transforms is stored in a
row of the array, overwriting the corresponding original data.
If the
components of the
th Fourier cosine transform are denoted by
, for
and
, then the
elements of the array
X contain the values
- 4: WORK() – REAL (KIND=nag_wp) arrayWorkspace
-
Note: the dimension of the array
WORK
must be at least
.
The workspace requirements as documented for C06RBF may be an overestimate in some implementations.
On exit:
contains the minimum workspace required for the current values of
M and
N with this implementation.
- 5: IFAIL – INTEGERInput/Output
-
On entry:
IFAIL must be set to
,
. 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
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is
.
When the value is used it is essential to test the value of IFAIL on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
6 Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
X04AAF).
Errors or warnings detected by the routine:
-
-
-
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 C06RBF is approximately proportional to , but also depends on the factors of . C06RBF is fastest if the only prime factors of are , and , and is particularly slow if is a large prime, or has large prime factors.
9 Example
This example reads in sequences of real data values and prints their Fourier cosine transforms (as computed by C06RBF). It then calls the routine again and prints the results which may be compared with the original sequence.
9.1 Program Text
Program Text (c06rbfe.f90)
9.2 Program Data
Program Data (c06rbfe.d)
9.3 Program Results
Program Results (c06rbfe.r)