FftwRealToRealPlan.h

Go to the documentation of this file.

#ifndef CARMA_UTIL_FFTWREALTOREALPLAN_H
#define CARMA_UTIL_FFTWREALTOREALPLAN_H

#include "carma/util/FftwAllocator.h"

#include <fftw3.h>

#include <vector>
#include <map>
#include <string>

namespace carma {

namespace util {
        
    typedef 
    std::vector< double, carma::util::FftwAllocator< double > > FftwRealVector;

    class FftwRealToRealPlan {
    public:

        enum Kind { // Supported plan kinds 
            REAL_TO_HALFCOMPLEX,
            HALFCOMPLEX_TO_REAL 
        };

        enum Rigor { // Supported plan creation rigors.
            ESTIMATE,  // Estimate the best plan via heuristics 
            MEASURE,   // Determine best plan by measuring several ffts 
            PATIENT,   // Same as measure, but tests more algorithms 
            EXHAUSTIVE // Same as patient, but tests even more algorithms 
        };

        typedef ::std::map< enum Rigor, ::std::string > RigorEnumMap;

        static RigorEnumMap rigors(); // Convenience for looping & debug

        explicit FftwRealToRealPlan( FftwRealVector::size_type size,
                                     FftwRealVector & data,
                                     enum Kind transformKind,
                                     enum Rigor minimumRigor = MEASURE );

        FftwRealToRealPlan( const FftwRealToRealPlan & from );
        
        ~FftwRealToRealPlan( );

        void execute( );

        FftwRealVector::size_type getSize( ) const;

        enum Kind getKind( ) const;

        static void importWisdom( const ::std::string & filename );

        static void exportWisdom( const ::std::string & filename );

        static void forgetWisdom();

    private:

        const FftwRealVector::size_type size_;
        const FftwRealVector::value_type * data0_; // For realloc checks
        const Kind kind_;
        const Rigor rigor_;
        FftwRealVector & data_;
        ::fftw_plan plan_;
    };
} // namespace util
} // namespace carma
#endif