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

Complex fast Fourier transforms. More...

Namespaces

namespace  radix2
 Radix 2 transforms.
 

Classes

class  wavetable
 C++ version of gsl_fft_halfcomplex_wavetable functions. More...
 

Functions

int backward (gsl::complex_packed_array data, size_t const stride, size_t const n, wavetable const &wavetable, real::workspace &work)
 C++ version of gsl_fft_halfcomplex_backward(). More...
 
int inverse (gsl::complex_packed_array data, size_t const stride, size_t const n, wavetable const &wavetable, real::workspace &work)
 C++ version of gsl_fft_halfcomplex_inverse(). More...
 
int unpack (double const real_coefficient[], double complex_coefficient[], size_t const stride, size_t const n)
 C++ version of gsl_fft_halfcomplex_unpack(). More...
 
template<typename DATA >
int backward (DATA &data, size_t const stride, wavetable const &wavetable, real::workspace &work)
 C++ version of gsl_fft_halfcomplex_backward(). More...
 
template<typename DATA >
int inverse (DATA &data, size_t const stride, wavetable const &wavetable, real::workspace &work)
 C++ version of gsl_fft_halfcomplex_inverse(). More...
 
template<typename R , typename C >
int unpack (R const &real_coefficient, C &complex_coefficient, size_t const stride)
 C++ version of gsl_fft_halfcomplex_unpack(). More...
 
template<>
int unpack (vector const &real_coefficient, vector_complex &complex_coefficient, size_t const stride)
 C++ version of gsl_fft_halfcomplex_unpack(). More...
 
int backward (gsl::complex_packed_array data, size_t const n, wavetable const &wavetable, real::workspace &work)
 C++ version of gsl_fft_halfcomplex_backward(). More...
 
int inverse (gsl::complex_packed_array data, size_t const n, wavetable const &wavetable, real::workspace &work)
 C++ version of gsl_fft_halfcomplex_inverse(). More...
 
int unpack (double const real_coefficient[], double complex_coefficient[], size_t const n)
 C++ version of gsl_fft_halfcomplex_unpack(). More...
 
template<typename DATA >
int backward (DATA &data, wavetable const &wavetable, real::workspace &work)
 C++ version of gsl_fft_halfcomplex_backward(). More...
 
template<typename DATA >
int inverse (DATA &data, wavetable const &wavetable, real::workspace &work)
 C++ version of gsl_fft_halfcomplex_inverse(). More...
 
template<typename R , typename C >
int unpack (R const &real_coefficient, C &complex_coefficient)
 C++ version of gsl_fft_halfcomplex_unpack(). More...
 
template<>
int unpack (vector const &real_coefficient, vector_complex &complex_coefficient)
 C++ version of gsl_fft_halfcomplex_unpack(). More...
 

Detailed Description

Complex fast Fourier transforms.

Function Documentation

◆ backward() [1/4]

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

C++ version of gsl_fft_halfcomplex_backward().

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

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

Definition at line 349 of file fft_halfcomplex.hpp.

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

◆ backward() [2/4]

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

C++ version of gsl_fft_halfcomplex_backward().

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

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

Definition at line 444 of file fft_halfcomplex.hpp.

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

◆ backward() [3/4]

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

C++ version of gsl_fft_halfcomplex_backward().

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

Definition at line 409 of file fft_halfcomplex.hpp.

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

◆ backward() [4/4]

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

C++ version of gsl_fft_halfcomplex_backward().

Parameters
dataAn array of halfcomplex values as an array of double values.
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 310 of file fft_halfcomplex.hpp.

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

◆ inverse() [1/4]

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

C++ version of gsl_fft_halfcomplex_inverse().

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

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

Definition at line 364 of file fft_halfcomplex.hpp.

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

◆ inverse() [2/4]

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

C++ version of gsl_fft_halfcomplex_inverse().

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

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

Definition at line 458 of file fft_halfcomplex.hpp.

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

◆ inverse() [3/4]

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

C++ version of gsl_fft_halfcomplex_inverse().

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

Definition at line 421 of file fft_halfcomplex.hpp.

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

◆ inverse() [4/4]

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

C++ version of gsl_fft_halfcomplex_inverse().

Parameters
dataAn array of halfcomplex values as an array of double values.
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 323 of file fft_halfcomplex.hpp.

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

◆ unpack() [1/6]

int gsl::fft::halfcomplex::unpack ( double const  real_coefficient[],
double  complex_coefficient[],
size_t const  n 
)
inline

C++ version of gsl_fft_halfcomplex_unpack().

Parameters
real_coefficientAn array of double values.
complex_coefficientAn array of double values for complex coefficients.
nThe size of the array.
Returns
Error code on failure.

Definition at line 432 of file fft_halfcomplex.hpp.

References gsl::rstat::n().

◆ unpack() [2/6]

int gsl::fft::halfcomplex::unpack ( double const  real_coefficient[],
double  complex_coefficient[],
size_t const  stride,
size_t const  n 
)
inline

C++ version of gsl_fft_halfcomplex_unpack().

Parameters
real_coefficientAn array of double values.
complex_coefficientAn array of double values for complex coefficients.
strideThe stride of the array.
nThe size of the array.
Returns
Error code on failure.

Definition at line 335 of file fft_halfcomplex.hpp.

References gsl::rstat::n().

◆ unpack() [3/6]

template<typename R , typename C >
int gsl::fft::halfcomplex::unpack ( R const &  real_coefficient,
C &  complex_coefficient 
)
inline

C++ version of gsl_fft_halfcomplex_unpack().

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

Parameters
real_coefficientAn array of double values.
complex_coefficientAn array of double values for complex coefficients.
Returns
Error code on failure.

Definition at line 471 of file fft_halfcomplex.hpp.

References gsl::movstat::max(), and gsl::rstat::n().

◆ unpack() [4/6]

template<typename R , typename C >
int gsl::fft::halfcomplex::unpack ( R const &  real_coefficient,
C &  complex_coefficient,
size_t const  stride 
)
inline

C++ version of gsl_fft_halfcomplex_unpack().

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

Parameters
real_coefficientAn array of double values.
complex_coefficientAn array of double values for complex coefficients.
strideThe stride of the array.
Returns
Error code on failure.

Definition at line 378 of file fft_halfcomplex.hpp.

References gsl::movstat::max(), and gsl::rstat::n().

◆ unpack() [5/6]

template<>
int gsl::fft::halfcomplex::unpack ( vector const &  real_coefficient,
vector_complex complex_coefficient 
)
inline

C++ version of gsl_fft_halfcomplex_unpack().

Works with vector and vector_complex.

Parameters
real_coefficientAn array of double values.
complex_coefficientAn array of double values for complex coefficients.
Returns
Error code on failure.

Definition at line 483 of file fft_halfcomplex.hpp.

References gsl::vector::data(), gsl::vector_complex::data(), gsl::movstat::max(), gsl::rstat::n(), gsl::vector::size(), and gsl::vector_complex::size().

◆ unpack() [6/6]

template<>
int gsl::fft::halfcomplex::unpack ( vector const &  real_coefficient,
vector_complex complex_coefficient,
size_t const  stride 
)
inline

C++ version of gsl_fft_halfcomplex_unpack().

Works with vector and vector_complex.

Parameters
real_coefficientAn array of double values.
complex_coefficientAn array of double values for complex coefficients.
strideThe stride of the array.
Returns
Error code on failure.

Definition at line 393 of file fft_halfcomplex.hpp.

References gsl::vector::data(), gsl::vector_complex::data(), gsl::movstat::max(), gsl::rstat::n(), gsl::vector::size(), and gsl::vector_complex::size().