NAG Library ManualKeyword Search:

NAG Library Routine Document

c06ref (fft_sine)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

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

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

Fortran Interface

Subroutine c06ref (

m, n, x, ifail)

Integer, Intent (In)	::	m, n
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (Inout)	::	x(n-1,m)

C Header Interface

#include nagmk26.h

void	c06ref_ ( const Integer m, const Integer n, double x[], Integer *ifail)

3

Description

Given

m

sequences of

n - 1

real data values

x_{j}^{p}

, for

j = 1, 2, \dots, n - 1

and

p = 1, 2, \dots, m

, c06ref simultaneously calculates the Fourier sine transforms of all the sequences defined by

{\hat{x}}_{k}^{p} = \sqrt{\frac{2}{n}} \sum_{j = 1}^{n - 1} x_{j}^{p} \times \sin (j k \frac{π}{n}), k = 1, 2, \dots, n - 1 ​ and ​ p = 1, 2, \dots, 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: $m$ – IntegerInput: On entry: $m$ , the number of sequences to be transformed.

Constraint: $m \geq 1$ .
2: $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: $n \geq 1$ .
3: $x (n - 1, 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 - 1$ and $p = 1, 2, \dots, m$ , must be stored in $x (j, p)$ .

On exit: the $(n - 1)$ components of the $p$ th Fourier sine transform, denoted by ${\hat{x}}_{k}^{p}$ , for $k = 1, 2, \dots, n - 1$ and $p = 1, 2, \dots, m$ , are stored in $x (k, p)$ , overwriting the corresponding original values.
4: $ifail$ – IntegerInput/Output: On entry: ifail must be set to $0$ , $- 1 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 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 $- 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$: 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.9 in How to Use the NAG Library and its Documentation for further information.

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

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

9

Further Comments

The time taken by c06ref is approximately proportional to

n m \log (n)

, 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

O (n)

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.

NAG Library Routine Document

c06ref (fft_sine)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

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