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

Real fast Fourier transforms. More...

Namespaces

namespace  radix2
 Radix 2 transforms.
 

Classes

class  wavetable
 C++ version of gsl_fft_real_wavetable_float functions. More...
 
class  workspace
 Workspace for real fast fourier transforms. More...
 

Functions

int transform (float data[], size_t const stride, size_t const n, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_real_float_transform(). More...
 
int unpack (float const real_float_coefficient[], float complex_coefficient[], size_t const stride, size_t const n)
 C++ version of gsl_fft_real_float_unpack(). More...
 
template<typename DATA >
int transform (DATA &data, size_t const stride, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_real_float_transform(). More...
 
template<typename R , typename C >
int unpack (R const &real_float_coefficient, C &complex_coefficient, size_t const stride)
 C++ version of gsl_fft_real_float_unpack(). More...
 
template<>
int unpack (vector_float const &real_float_coefficient, vector_complex_float &complex_coefficient, size_t const stride)
 C++ version of gsl_fft_real_float_unpack(). More...
 
int transform (float data[], size_t const n, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_real_float_transform(). More...
 
int unpack (float const real_float_coefficient[], float complex_coefficient[], size_t const n)
 C++ version of gsl_fft_real_float_unpack(). More...
 
template<typename DATA >
int transform (DATA &data, wavetable const &wavetable, workspace &work)
 C++ version of gsl_fft_real_float_transform(). More...
 
template<typename R , typename C >
int unpack (R const &real_float_coefficient, C &complex_coefficient)
 C++ version of gsl_fft_real_float_unpack(). More...
 
template<>
int unpack (vector_float const &real_float_coefficient, vector_complex_float &complex_coefficient)
 C++ version of gsl_fft_real_float_unpack(). More...
 

Detailed Description

Real fast Fourier transforms.

Function Documentation

◆ transform() [1/4]

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

C++ version of gsl_fft_real_float_transform().

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

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

Definition at line 507 of file fft_real_float.hpp.

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

◆ transform() [2/4]

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

C++ version of gsl_fft_real_float_transform().

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

Parameters
dataAn array of float values.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 574 of file fft_real_float.hpp.

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

◆ transform() [3/4]

int gsl::fft::real_float::transform ( float  data[],
size_t const  n,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_real_float_transform().

Parameters
dataAn array of float values.
nThe size of the array.
wavetableA wavetable of size n.
workA workspace of size n.
Returns
Error code on failure.

Definition at line 551 of file fft_real_float.hpp.

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

◆ transform() [4/4]

int gsl::fft::real_float::transform ( float  data[],
size_t const  stride,
size_t const  n,
wavetable const &  wavetable,
workspace work 
)
inline

C++ version of gsl_fft_real_float_transform().

Parameters
dataAn array of float 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 481 of file fft_real_float.hpp.

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

◆ unpack() [1/6]

int gsl::fft::real_float::unpack ( float const  real_float_coefficient[],
float  complex_coefficient[],
size_t const  n 
)
inline

C++ version of gsl_fft_real_float_unpack().

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

Definition at line 562 of file fft_real_float.hpp.

References gsl::rstat::n().

◆ unpack() [2/6]

int gsl::fft::real_float::unpack ( float const  real_float_coefficient[],
float  complex_coefficient[],
size_t const  stride,
size_t const  n 
)
inline

C++ version of gsl_fft_real_float_unpack().

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

Definition at line 493 of file fft_real_float.hpp.

References gsl::rstat::n().

◆ unpack() [3/6]

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

C++ version of gsl_fft_real_float_unpack().

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

Parameters
real_float_coefficientAn array of float values.
complex_coefficientAn array of float values for complex coefficients.
Returns
Error code on failure.

Definition at line 586 of file fft_real_float.hpp.

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

◆ unpack() [4/6]

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

C++ version of gsl_fft_real_float_unpack().

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

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

Definition at line 520 of file fft_real_float.hpp.

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

◆ unpack() [5/6]

template<>
int gsl::fft::real_float::unpack ( vector_float const &  real_float_coefficient,
vector_complex_float complex_coefficient 
)
inline

C++ version of gsl_fft_real_float_unpack().

Works with vector and vector_complex.

Parameters
real_float_coefficientAn array of float values.
complex_coefficientAn array of float values for complex coefficients.
Returns
Error code on failure.

Definition at line 600 of file fft_real_float.hpp.

References gsl::vector_complex_float::data(), gsl::vector_float::data(), gsl::movstat::max(), gsl::rstat::n(), gsl::vector_complex_float::size(), and gsl::vector_float::size().

◆ unpack() [6/6]

template<>
int gsl::fft::real_float::unpack ( vector_float const &  real_float_coefficient,
vector_complex_float complex_coefficient,
size_t const  stride 
)
inline

C++ version of gsl_fft_real_float_unpack().

Works with vector and vector_complex.

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

Definition at line 535 of file fft_real_float.hpp.

References gsl::vector_complex_float::data(), gsl::vector_float::data(), gsl::movstat::max(), gsl::rstat::n(), gsl::vector_complex_float::size(), and gsl::vector_float::size().