c06fq: FL CL CPP AD

NAG FL Interface
c06fqf (withdraw_fft_hermitian_1d_multi_rfmt)

Note: this routine is deprecated and will be withdrawn at Mark 30.2. Replaced by c06ppf or c06pqf.

Old Code

Call c06fqf(m,n,x,init,trig,work,ifail)

New Code

Call c06pqf('B',n,m,x,work,ifail)

The mapping of input elements is as follows:

(Here x begins at element zero $x (0)$ .)
for j=0,1,…,m-1
- $J = j \times (n + 2)$ ;
- $x (J + 2 \times i) \leftarrow x (i \times m + j)$ , for $i = 0, 1, \dots, n / 2$ [real parts];
- $x (J + 2 \times i + 1) \leftarrow x ((n - i) \times m + j)$ , for $i = 1, 2, \dots, (n - 1) / 2$ [imaginary parts];
- $x (J + 1)$ must be zero;
- $x (J + n + 1)$ must zero when n is even.

The mapping of output elements is as follows:

(Here x begins at element zero $x (0)$ .)
for j=0,1,…,m-1
- $J = j \times (n + 2)$ ;
- $x (J + i) \leftarrow x (i \times m + j)$ , for $i = 0, 1, \dots, n - 1$ ;
- $x (J + n)$ and $x (J + n + 1)$ will be set to zero.

Keyword Search:

NAG Library Manual, Mark 28.3

Interfaces: FL CL CPP AD

NAG FL Interface Introduction

C06 (Sum) Chapter Contents

C06 (Sum) Chapter Introduction

c06fq: FL CL CPP AD

▸▿ 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

c06fqf computes the discrete Fourier transforms of

m

Hermitian sequences, each containing

n

complex data values. This routine is designed to be particularly efficient on vector processors.

2 Specification

Fortran Interface

Subroutine c06fqf (

m, n, x, init, trig, work, ifail)

Integer, Intent (In)	::	m, n
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (Inout)	::	x(mn), trig(2n)
Real (Kind=nag_wp), Intent (Out)	::	work(m*n)
Character (1), Intent (In)	::	init

C Header Interface

#include <nag.h>

void	c06fqf_ (const Integer m, const Integer n, double x[], const char init, double trig[], double work[], Integer ifail, const Charlen length_init)

The routine may be called by the names c06fqf or nagf_sum_withdraw_fft_hermitian_1d_multi_rfmt.

3 Description

Given

m

Hermitian sequences of

n

complex data values

z_{j}^{p}

, for

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

and

p = 1, 2, \dots, m

, c06fqf simultaneously calculates the Fourier transforms of all the sequences defined by

{\hat{x}}_{k}^{p} = \frac{1}{\sqrt{n}} \sum_{j = 0}^{n - 1} z_{j}^{p} \times \exp (- i \frac{2 π j k}{n}), k = 0, 1, \dots, n - 1 ​ and ​ p = 1, 2, \dots, m .

(Note the scale factor

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

in this definition.)

The transformed values are purely real (see also the C06 Chapter Introduction).

The discrete Fourier transform is sometimes defined using a positive sign in the exponential term

{\hat{x}}_{k}^{p} = \frac{1}{\sqrt{n}} \sum_{j = 0}^{n - 1} z_{j}^{p} \times \exp (+ i \frac{2 π j k}{n}) .

To compute this form, this routine should be preceded by forming the complex conjugates of the

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

; that is

x (k) = - x (k)

, for

k = (n / 2 + 1) \times m + 1, \dots, m \times n

The routine uses a variant of the fast Fourier transform (FFT) algorithm (see Brigham (1974)) known as the Stockham self-sorting algorithm, which is described in Temperton (1983). Special coding is provided for the factors

2

3

4

5

and

6

. This routine is designed to be particularly efficient on vector processors, and it becomes especially fast as

m

, the number of transforms to be computed in parallel, increases.

4 References

Brigham E O (1974) The Fast Fourier Transform Prentice–Hall

Temperton C (1983) Fast mixed-radix real Fourier transforms J. Comput. Phys. 52 340–350

5 Arguments

1: $m$ – Integer Input

On entry:

m

, the number of sequences to be transformed.

Constraint:

m \geq 1

2: $n$ – Integer Input

On entry:

n

, the number of data values in each sequence.

Constraint:

n \geq 1

3: $x (m \times n)$ – Real (Kind=nag_wp) array Input/Output

On entry: the data must be stored in x as if in a two-dimensional array of dimension

(1 : m, 0 : n - 1)

; each of the

m

sequences is stored in a row of the array in Hermitian form. If the

n

data values

z_{j}^{p}

are written as

x_{j}^{p} + i y_{j}^{p}

, then for

0 \leq j \leq n / 2

x_{j}^{p}

is contained in

x (p, j)

, and for

1 \leq j \leq (n - 1) / 2

y_{j}^{p}

is contained in

x (p, n - j)

. (See also Section 2.1.2 in the C06 Chapter Introduction.)

On exit: the components of the

m

discrete Fourier transforms, stored as if in a two-dimensional array of dimension

(1 : m, 0 : n - 1)

. Each of the

m

transforms is stored as a row of the array, overwriting the corresponding original sequence. If the

n

components of the discrete Fourier transform are denoted by

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

, for

k = 0, 1, \dots, n - 1

, the

m n

elements of the array x contain the values

{\hat{x}}_{0}^{1}, {\hat{x}}_{0}^{2}, \dots, {\hat{x}}_{0}^{m}, {\hat{x}}_{1}^{1}, {\hat{x}}_{1}^{2}, \dots, {\hat{x}}_{1}^{m}, \dots, {\hat{x}}_{n - 1}^{1}, {\hat{x}}_{n - 1}^{2}, \dots, {\hat{x}}_{n - 1}^{m} .

4: $init$ – Character(1) Input

On entry: indicates whether trigonometric coefficients are to be calculated.

$init ='I'$: Calculate the required trigonometric coefficients for the given value of $n$ , and store in the array trig.
$init ='S'$ or $'R'$: The required trigonometric coefficients are assumed to have been calculated and stored in the array trig in a prior call to one of c06fpf or c06fqf. The routine performs a simple check that the current value of $n$ is consistent with the values stored in trig.

Constraint:

init ='I'

'S'

'R'

5: $trig (2 \times n)$ – Real (Kind=nag_wp) array Input/Output

On entry: if

init ='S'

'R'

, trig must contain the required trigonometric coefficients that have been previously calculated. Otherwise trig need not be set.

On exit: contains the required coefficients (computed by the routine if

init ='I'

6: $work (m \times n)$ – Real (Kind=nag_wp) array Workspace

7: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

−1

1

to set behaviour on detection of an error; these values have no effect when no error is detected.

A value of

0

causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of

−1

means that an error message is printed while a value of

1

means that it is not.

If halting is not appropriate, the value

−1

1

is recommended. If message printing is undesirable, then the value

1

is recommended. Otherwise, the value

0

is recommended. 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, $init = ⟨ value ⟩$ .
Constraint: $init ='I'$ , $'S'$ or $'R'$ .

$ifail = 5$: On entry, $init = ⟨ value ⟩$ but n and trig array incompatible.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface 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

c06fqf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

c06fqf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

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 c06fqf is approximately proportional to

n m \log (n)

, but also depends on the factors of

n

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

10 Example

This example reads in sequences of real data values which are assumed to be Hermitian sequences of complex data stored in Hermitian form. The sequences are expanded into full complex form and printed. The discrete Fourier transforms are then computed (using c06fqf) and printed out. Inverse transforms are then calculated by conjugating and calling c06fpf showing that the original sequences are restored.

c06fq: FL CL CPP AD

NAG FL Interfacec06fqf (withdraw_​fft_​hermitian_​1d_​multi_​rfmt)

Old Code

New Code

▸▿ 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

NAG FL Interface
c06fqf (withdraw_fft_hermitian_1d_multi_rfmt)