ccgsl 2.7.2
C++wrappersforGnuScientificLibrary
gsl::fft::complex Namespace Reference

Complex fast Fourier transforms. More...

Namespaces

namespace  radix2
 Radix 2 transforms.
 

Classes

class  wavetable
 C++ version of gsl_fft_complex_wavetable functions. More...
 
class  workspace
 Workspace for complex fast fourier transforms. More...
 

Functions

int forward (gsl::complex_packed_array data, size_t const stride, size_t const n, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_forward(). More...
 
int backward (gsl::complex_packed_array data, size_t const stride, size_t const n, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_backward(). More...
 
int inverse (gsl::complex_packed_array data, size_t const stride, size_t const n, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_inverse(). More...
 
int transform (gsl::complex_packed_array data, size_t const stride, size_t const n, wavetable const &wavetable, workspace &work, fft::direction const sign)
 C++ version of gsl_fft_complex_transform(). More...
 
int forward (gsl::complex_packed_array data, size_t const n, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_forward(). More...
 
int backward (gsl::complex_packed_array data, size_t const n, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_backward(). More...
 
int inverse (gsl::complex_packed_array data, size_t const n, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_inverse(). More...
 
int transform (gsl::complex_packed_array data, size_t const n, wavetable const &wavetable, workspace &work, fft::direction const sign)
 C++ version of gsl_fft_complex_transform(). More...
 
template<typename DATA >
int forward (DATA &data, size_t const stride, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_forward(). More...
 
template<typename DATA >
int backward (DATA &data, size_t const stride, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_backward(). More...
 
template<typename DATA >
int inverse (DATA &data, size_t const stride, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_inverse(). More...
 
template<typename DATA >
int transform (DATA &data, size_t const stride, wavetable const &wavetable, workspace &work, fft::direction const sign)
 C++ version of gsl_fft_complex_transform(). More...
 
template<>
int forward (gsl::vector_complex &data, size_t const stride, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_forward(). More...
 
template<>
int backward (gsl::vector_complex &data, size_t const stride, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_backward(). More...
 
template<>
int inverse (gsl::vector_complex &data, size_t const stride, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_inverse(). More...
 
template<>
int transform (gsl::vector_complex &data, size_t const stride, wavetable const &wavetable, workspace &work, fft::direction const sign)
 C++ version of gsl_fft_complex_transform(). More...
 
template<typename DATA >
int forward (DATA &data, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_forward(). More...
 
template<typename DATA >
int backward (DATA &data, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_backward(). More...
 
template<typename DATA >
int inverse (DATA &data, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_inverse(). More...
 
template<typename DATA >
int transform (DATA &data, wavetable const &wavetable, workspace &work, fft::direction const sign)
 C++ version of gsl_fft_complex_transform(). More...
 
template<>
int forward (gsl::vector_complex &data, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_forward(). More...
 
template<>
int backward (gsl::vector_complex &data, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_backward(). More...
 
template<>
int inverse (gsl::vector_complex &data, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_complex_inverse(). More...
 
template<>
int transform (gsl::vector_complex &data, wavetable const &wavetable, workspace &work, fft::direction const sign)
 C++ version of gsl_fft_complex_transform(). More...
 

Detailed Description

Complex fast Fourier transforms.

Function Documentation

◆ backward() [1/6]

template<typename DATA >
int gsl::fft::complex::backward ( DATA &  data,
size_t const  stride,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_backward().

Works with std::array<double>, std::vector<double> and gsl::vector.

Parameters
dataAn array of complex values packed as an array of double length of doubles.
strideThe stride of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 971 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), and gsl::fft::complex::workspace::get().

◆ backward() [2/6]

template<typename DATA >
int gsl::fft::complex::backward ( DATA &  data,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_backward().

Works with std::array<double>, std::vector<double> and gsl::vector.

Parameters
dataAn array of complex values packed as an array of double length of doubles.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 1085 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), and gsl::fft::complex::workspace::get().

◆ backward() [3/6]

int gsl::fft::complex::backward ( gsl::complex_packed_array  data,
size_t const  n,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_backward().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
nThe size of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 916 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::rstat::n().

◆ backward() [4/6]

int gsl::fft::complex::backward ( gsl::complex_packed_array  data,
size_t const  stride,
size_t const  n,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_backward().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
strideThe stride of the array.
nThe size of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 863 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::rstat::n().

◆ backward() [5/6]

template<>
int gsl::fft::complex::backward ( gsl::vector_complex data,
size_t const  stride,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_backward().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
strideThe stride of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 1027 of file fft_complex.hpp.

References gsl::vector_complex::data(), gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::vector_complex::size().

◆ backward() [6/6]

template<>
int gsl::fft::complex::backward ( gsl::vector_complex data,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_backward().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 1137 of file fft_complex.hpp.

References gsl::vector_complex::data(), gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::vector_complex::size().

◆ forward() [1/6]

template<typename DATA >
int gsl::fft::complex::forward ( DATA &  data,
size_t const  stride,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_forward().

Works with std::array<double>, std::vector<double> and gsl::vector.

Parameters
dataAn array of complex values packed as an array of double length of doubles.
strideThe stride of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 957 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), and gsl::fft::complex::workspace::get().

◆ forward() [2/6]

template<typename DATA >
int gsl::fft::complex::forward ( DATA &  data,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_forward().

Works with std::array<double>, std::vector<double> and gsl::vector.

Parameters
dataAn array of complex values packed as an array of double length of doubles.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 1072 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), and gsl::fft::complex::workspace::get().

◆ forward() [3/6]

int gsl::fft::complex::forward ( gsl::complex_packed_array  data,
size_t const  n,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_forward().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
nThe size of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 904 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::rstat::n().

◆ forward() [4/6]

int gsl::fft::complex::forward ( gsl::complex_packed_array  data,
size_t const  stride,
size_t const  n,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_forward().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
strideThe stride of the array.
nThe size of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 850 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::rstat::n().

◆ forward() [5/6]

template<>
int gsl::fft::complex::forward ( gsl::vector_complex data,
size_t const  stride,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_forward().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
strideThe stride of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 1013 of file fft_complex.hpp.

References gsl::vector_complex::data(), gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::vector_complex::size().

◆ forward() [6/6]

template<>
int gsl::fft::complex::forward ( gsl::vector_complex data,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_forward().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 1124 of file fft_complex.hpp.

References gsl::vector_complex::data(), gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::vector_complex::size().

◆ inverse() [1/6]

template<typename DATA >
int gsl::fft::complex::inverse ( DATA &  data,
size_t const  stride,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_inverse().

Works with std::array<double>, std::vector<double> and gsl::vector.

Parameters
dataAn array of complex values packed as an array of double length of doubles.
strideThe stride of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 985 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), and gsl::fft::complex::workspace::get().

◆ inverse() [2/6]

template<typename DATA >
int gsl::fft::complex::inverse ( DATA &  data,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_inverse().

Works with std::array<double>, std::vector<double> and gsl::vector.

Parameters
dataAn array of complex values packed as an array of double length of doubles.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 1098 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), and gsl::fft::complex::workspace::get().

◆ inverse() [3/6]

int gsl::fft::complex::inverse ( gsl::complex_packed_array  data,
size_t const  n,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_inverse().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
nThe size of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 928 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::rstat::n().

◆ inverse() [4/6]

int gsl::fft::complex::inverse ( gsl::complex_packed_array  data,
size_t const  stride,
size_t const  n,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_inverse().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
strideThe stride of the array.
nThe size of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 876 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::rstat::n().

◆ inverse() [5/6]

template<>
int gsl::fft::complex::inverse ( gsl::vector_complex data,
size_t const  stride,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_inverse().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
strideThe stride of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 1041 of file fft_complex.hpp.

References gsl::vector_complex::data(), gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::vector_complex::size().

◆ inverse() [6/6]

template<>
int gsl::fft::complex::inverse ( gsl::vector_complex data,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_complex_inverse().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 1150 of file fft_complex.hpp.

References gsl::vector_complex::data(), gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::vector_complex::size().

◆ transform() [1/6]

template<typename DATA >
int gsl::fft::complex::transform ( DATA &  data,
size_t const  stride,
wavetable const &  wavetable,
workspace work,
fft::direction const  sign 
)
inline

C++ version of gsl_fft_complex_transform().

Works with std::array<double>, std::vector<double> and gsl::vector.

Parameters
dataAn array of complex values packed as an array of double length of doubles.
strideThe stride of the array.
wavetableA wavetable of size n.
workA workspace of size n.
signfft::forward or fft::backward.
Returns
Error code on failure.

Definition at line 1000 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::sign().

◆ transform() [2/6]

template<typename DATA >
int gsl::fft::complex::transform ( DATA &  data,
wavetable const &  wavetable,
workspace work,
fft::direction const  sign 
)
inline

C++ version of gsl_fft_complex_transform().

Works with std::array<double>, std::vector<double> and gsl::vector.

Parameters
dataAn array of complex values packed as an array of double length of doubles.
wavetableA wavetable of size n.
workA workspace of size n.
signfft::forward or fft::backward.
Returns
Error code on failure.

Definition at line 1112 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), and gsl::sign().

◆ transform() [3/6]

int gsl::fft::complex::transform ( gsl::complex_packed_array  data,
size_t const  n,
wavetable const &  wavetable,
workspace work,
fft::direction const  sign 
)
inline

C++ version of gsl_fft_complex_transform().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
nThe size of the array.
wavetableA wavetable of size n.
workA workspace of size n.
signfft::forward or fft::backward.
Returns
Error code on failure.

Definition at line 941 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), gsl::rstat::n(), and gsl::sign().

◆ transform() [4/6]

int gsl::fft::complex::transform ( gsl::complex_packed_array  data,
size_t const  stride,
size_t const  n,
wavetable const &  wavetable,
workspace work,
fft::direction const  sign 
)
inline

C++ version of gsl_fft_complex_transform().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
strideThe stride of the array.
nThe size of the array.
wavetableA wavetable of size n.
workA workspace of size n.
signfft::forward or fft::backward.
Returns
Error code on failure.

Definition at line 890 of file fft_complex.hpp.

References gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), gsl::rstat::n(), and gsl::sign().

◆ transform() [5/6]

template<>
int gsl::fft::complex::transform ( gsl::vector_complex data,
size_t const  stride,
wavetable const &  wavetable,
workspace work,
fft::direction const  sign 
)
inline

C++ version of gsl_fft_complex_transform().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
strideThe stride of the array.
wavetableA wavetable of size n.
workA workspace of size n.
signfft::forward or fft::backward.
Returns
Error code on failure.

Definition at line 1056 of file fft_complex.hpp.

References gsl::vector_complex::data(), gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), gsl::sign(), and gsl::vector_complex::size().

◆ transform() [6/6]

template<>
int gsl::fft::complex::transform ( gsl::vector_complex data,
wavetable const &  wavetable,
workspace work,
fft::direction const  sign 
)
inline

C++ version of gsl_fft_complex_transform().

Parameters
dataAn array of complex values packed as an array of double length of doubles.
wavetableA wavetable of size n.
workA workspace of size n.
signfft::forward or fft::backward.
Returns
Error code on failure.

Definition at line 1164 of file fft_complex.hpp.

References gsl::vector_complex::data(), gsl::fft::complex::wavetable::get(), gsl::fft::complex::workspace::get(), gsl::sign(), and gsl::vector_complex::size().