Indoor/lib/simple_fft/fft.hpp

#ifndef __SIMPLE_FFT__FFT_HPP__
#define __SIMPLE_FFT__FFT_HPP__

#include "copy_array.hpp"
#include "fft_impl.hpp"

namespace simple_fft {

// in-place, complex, forward
template <class TComplexArray1D>
bool FFT(TComplexArray1D & data, const size_t size, const char *& error_description)
{
    return impl::CFFT<TComplexArray1D,1>::FFT_inplace(data, size, impl::FFT_FORWARD,
                                                      error_description);
}

template <class TComplexArray2D>
bool FFT(TComplexArray2D & data, const size_t size1, const size_t size2,
         const char *& error_description)
{
    return impl::CFFT<TComplexArray2D,2>::FFT_inplace(data, size1, size2, impl::FFT_FORWARD,
                                                      error_description);
}

template <class TComplexArray3D>
bool FFT(TComplexArray3D & data, const size_t size1, const size_t size2, const size_t size3,
         const char *& error_description)
{
    return impl::CFFT<TComplexArray3D,3>::FFT_inplace(data, size1, size2, size3,
                                                      impl::FFT_FORWARD,
                                                      error_description);
}

// in-place, complex, inverse
template <class TComplexArray1D>
bool IFFT(TComplexArray1D & data, const size_t size, const char *& error_description)
{
    return impl::CFFT<TComplexArray1D,1>::FFT_inplace(data, size, impl::FFT_BACKWARD,
                                                      error_description);
}

template <class TComplexArray2D>
bool IFFT(TComplexArray2D & data, const size_t size1, const size_t size2,
          const char *& error_description)
{
    return impl::CFFT<TComplexArray2D,2>::FFT_inplace(data, size1, size2, impl::FFT_BACKWARD,
                                                      error_description);
}

template <class TComplexArray3D>
bool IFFT(TComplexArray3D & data, const size_t size1, const size_t size2, const size_t size3,
          const char *& error_description)
{
    return impl::CFFT<TComplexArray3D,3>::FFT_inplace(data, size1, size2, size3,
                                                      impl::FFT_BACKWARD,
                                                      error_description);
}

// not-in-place, complex, forward
template <class TComplexArray1D>
bool FFT(const TComplexArray1D & data_in, TComplexArray1D & data_out,
         const size_t size, const char *& error_description)
{
    copy_array::copyArray(data_in, data_out, size);
    return impl::CFFT<TComplexArray1D,1>::FFT_inplace(data_out, size, impl::FFT_FORWARD,
                                                      error_description);
}

template <class TComplexArray2D>
bool FFT(const TComplexArray2D & data_in, TComplexArray2D & data_out,
         const size_t size1, const size_t size2, const char *& error_description)
{
    copy_array::copyArray(data_in, data_out, size1, size2);
    return impl::CFFT<TComplexArray2D,2>::FFT_inplace(data_out, size1, size2,
                                                      impl::FFT_FORWARD,
                                                      error_description);
}

template <class TComplexArray3D>
bool FFT(const TComplexArray3D & data_in, TComplexArray3D & data_out,
         const size_t size1, const size_t size2, const size_t size3,
         const char *& error_description)
{
    copy_array::copyArray(data_in, data_out, size1, size2, size3);
    return impl::CFFT<TComplexArray3D,3>::FFT_inplace(data_out, size1, size2, size3,
                                                      impl::FFT_FORWARD,
                                                      error_description);
}

// not-in-place, complex, inverse
template <class TComplexArray1D>
bool IFFT(const TComplexArray1D & data_in, TComplexArray1D & data_out,
          const size_t size, const char *& error_description)
{
    copy_array::copyArray(data_in, data_out, size);
    return impl::CFFT<TComplexArray1D,1>::FFT_inplace(data_out, size, impl::FFT_BACKWARD,
                                                      error_description);
}

template <class TComplexArray2D>
bool IFFT(const TComplexArray2D & data_in, TComplexArray2D & data_out,
          const size_t size1, const size_t size2, const char *& error_description)
{
    copy_array::copyArray(data_in, data_out, size1, size2);
    return impl::CFFT<TComplexArray2D,2>::FFT_inplace(data_out, size1, size2,
                                                      impl::FFT_BACKWARD,
                                                      error_description);
}

template <class TComplexArray3D>
bool IFFT(const TComplexArray3D & data_in, TComplexArray3D & data_out,
          const size_t size1, const size_t size2, const size_t size3,
          const char *& error_description)
{
    copy_array::copyArray(data_in, data_out, size1, size2, size3);
    return impl::CFFT<TComplexArray3D,3>::FFT_inplace(data_out, size1, size2, size3,
                                                      impl::FFT_BACKWARD,
                                                      error_description);
}

// not-in-place, real, forward
template <class TRealArray1D, class TComplexArray1D>
bool FFT(const TRealArray1D & data_in, TComplexArray1D & data_out,
         const size_t size, const char *& error_description)
{
    copy_array::copyArray(data_in, data_out, size);
    return impl::CFFT<TComplexArray1D,1>::FFT_inplace(data_out, size,
                                                      impl::FFT_FORWARD,
                                                      error_description);
}

template <class TRealArray2D, class TComplexArray2D>
bool FFT(const TRealArray2D & data_in, TComplexArray2D & data_out,
         const size_t size1, const size_t size2, const char *& error_description)
{
    copy_array::copyArray(data_in, data_out, size1, size2);
    return impl::CFFT<TComplexArray2D,2>::FFT_inplace(data_out, size1, size2,
                                                      impl::FFT_FORWARD,
                                                      error_description);
}

template <class TRealArray3D, class TComplexArray3D>
bool FFT(const TRealArray3D & data_in, TComplexArray3D & data_out,
         const size_t size1, const size_t size2, const size_t size3,
         const char *& error_description)
{
    copy_array::copyArray(data_in, data_out, size1, size2, size3);
    return impl::CFFT<TComplexArray3D,3>::FFT_inplace(data_out, size1, size2, size3,
                                                      impl::FFT_FORWARD,
                                                      error_description);
}

} // simple_fft

#endif // __SIMPLE_FFT__FFT_HPP__