naginterfaces.library.sum.fft_​sine

naginterfaces.library.sum.fft_sine(x)

fft_sine computes the discrete Fourier sine transforms of $m$ sequences of real data values. The elements of each sequence and its transform are stored contiguously.

For full information please refer to the NAG Library document for c06re

https://www.nag.com/numeric/nl/nagdoc_30/flhtml/c06/c06ref.html

Parameters

xfloat, array-like, shape $(n-1,m)$

The data values of the $\text{p}$th sequence to be transformed, denoted by $x_{\text{j}}^{\text{p}}$, for $\text{p}=1,2,\dots ,m$, for $\text{j}=1,2,\dots ,n-1$, must be stored in $x[j-1,p-1]$.

Returns

xfloat, ndarray, shape $(n-1,m)$

The $(n-1)$ components of the $\text{p}$th Fourier sine transform, denoted by ${\hat{x}}_{\text{k}}^{\text{p}}$, for $\text{p}=1,2,\dots ,m$, for $\text{k}=1,2,\dots ,n-1$, are stored in $x[k-1,p-1]$, overwriting the corresponding original values.

Raises

NagValueError

(errno $1$)

On entry, $m=⟨value⟩$.

Constraint: $m\ge 1$.

(errno $2$)

On entry, $n=⟨value⟩$.

Constraint: $n\ge 1$.

(errno $3$)

An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.

Notes

Given $m$ sequences of $n-1$ real data values $x_{\text{j}}^{\text{p}}$, for $\text{p}=1,2,\dots ,m$, for $\text{j}=1,2,\dots ,n-1$, fft_sine 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 \left(jk\frac{\pi }{n}\right)\text{,}k=1,2,\dots ,n-1\text{and}p=1,2,\dots ,m\text{.}$$

(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 fft_sine will restore the original data.

The transform calculated by this function can be used to solve Poisson’s equation when the solution is specified at both left and right boundaries (see Swarztrauber (1977)).

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

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