# HG changeset patch # User John W. Eaton # Date 1250049140 14400 # Node ID fb933db0c5171d4ffbb4a71b9fe20a9de340221e # Parent eee9b315044691d87d40bbdcad95b5d54218a876 convert fftw planner classes to singleton objects diff --git a/liboctave/ChangeLog b/liboctave/ChangeLog --- a/liboctave/ChangeLog +++ b/liboctave/ChangeLog @@ -1,3 +1,8 @@ +2009-08-11 John W. Eaton + + * oct-fftw.h, oct-fftw.cc (octave_fftw_planner): Convert to singleton. + (octave_float_fft_planner): Likewise. + 2009-08-11 John W. Eaton * Makefile.in (LINK_DEPS): Use READLINE_LIBS instead of diff --git a/liboctave/oct-fftw.cc b/liboctave/oct-fftw.cc --- a/liboctave/oct-fftw.cc +++ b/liboctave/oct-fftw.cc @@ -1,6 +1,6 @@ /* -Copyright (C) 2001, 2002, 2004, 2005, 2006, 2007, 2008 John W. Eaton +Copyright (C) 2001, 2002, 2004, 2005, 2006, 2007, 2008, 2009 John W. Eaton This file is part of Octave. @@ -34,6 +34,8 @@ #include "quit.h" #include "oct-locbuf.h" +octave_fftw_planner *octave_fftw_planner::instance = 0; + // Helper class to create and cache fftw plans for both 1d and // 2d. This implementation defaults to using FFTW_ESTIMATE to create // the plans, which in theory is suboptimal, but provides quit @@ -72,45 +74,35 @@ fftw_import_system_wisdom (); } -octave_fftw_planner::FftwMethod -octave_fftw_planner::method (void) +bool +octave_fftw_planner::instance_ok (void) { - return meth; -} + bool retval = true; -octave_fftw_planner::FftwMethod -octave_fftw_planner::method (FftwMethod _meth) -{ - FftwMethod ret = meth; - if (_meth == ESTIMATE || _meth == MEASURE || - _meth == PATIENT || _meth == EXHAUSTIVE || - _meth == HYBRID) + if (! instance) + instance = new octave_fftw_planner (); + + if (! instance) { - if (meth != _meth) - { - meth = _meth; - if (rplan) - fftw_destroy_plan (rplan); - if (plan[0]) - fftw_destroy_plan (plan[0]); - if (plan[1]) - fftw_destroy_plan (plan[1]); - rplan = plan[0] = plan[1] = 0; - } + (*current_liboctave_error_handler) + ("unable to create octave_fftw_planner object!"); + + retval = false; } - else - ret = UNKNOWN; - return ret; + + return retval; } #define CHECK_SIMD_ALIGNMENT(x) \ (((reinterpret_cast (x)) & 0xF) == 0) fftw_plan -octave_fftw_planner::create_plan (int dir, const int rank, - const dim_vector dims, octave_idx_type howmany, - octave_idx_type stride, octave_idx_type dist, - const Complex *in, Complex *out) +octave_fftw_planner::do_create_plan (int dir, const int rank, + const dim_vector dims, + octave_idx_type howmany, + octave_idx_type stride, + octave_idx_type dist, + const Complex *in, Complex *out) { int which = (dir == FFTW_FORWARD) ? 0 : 1; fftw_plan *cur_plan_p = &plan[which]; @@ -228,9 +220,11 @@ } fftw_plan -octave_fftw_planner::create_plan (const int rank, const dim_vector dims, - octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, - const double *in, Complex *out) +octave_fftw_planner::do_create_plan (const int rank, const dim_vector dims, + octave_idx_type howmany, + octave_idx_type stride, + octave_idx_type dist, + const double *in, Complex *out) { fftw_plan *cur_plan_p = &rplan; bool create_new_plan = false; @@ -341,6 +335,38 @@ return *cur_plan_p; } +octave_fftw_planner::FftwMethod +octave_fftw_planner::do_method (void) +{ + return meth; +} + +octave_fftw_planner::FftwMethod +octave_fftw_planner::do_method (FftwMethod _meth) +{ + FftwMethod ret = meth; + if (_meth == ESTIMATE || _meth == MEASURE + || _meth == PATIENT || _meth == EXHAUSTIVE + || _meth == HYBRID) + { + if (meth != _meth) + { + meth = _meth; + if (rplan) + fftw_destroy_plan (rplan); + if (plan[0]) + fftw_destroy_plan (plan[0]); + if (plan[1]) + fftw_destroy_plan (plan[1]); + rplan = plan[0] = plan[1] = 0; + } + } + else + ret = UNKNOWN; + return ret; +} + +octave_float_fftw_planner *octave_float_fftw_planner::instance = 0; octave_float_fftw_planner::octave_float_fftw_planner (void) { @@ -361,42 +387,33 @@ fftwf_import_system_wisdom (); } -octave_float_fftw_planner::FftwMethod -octave_float_fftw_planner::method (void) +bool +octave_float_fftw_planner::instance_ok (void) { - return meth; -} + bool retval = true; -octave_float_fftw_planner::FftwMethod -octave_float_fftw_planner::method (FftwMethod _meth) -{ - FftwMethod ret = meth; - if (_meth == ESTIMATE || _meth == MEASURE || - _meth == PATIENT || _meth == EXHAUSTIVE || - _meth == HYBRID) + if (! instance) + instance = new octave_float_fftw_planner (); + + if (! instance) { - if (meth != _meth) - { - meth = _meth; - if (rplan) - fftwf_destroy_plan (rplan); - if (plan[0]) - fftwf_destroy_plan (plan[0]); - if (plan[1]) - fftwf_destroy_plan (plan[1]); - rplan = plan[0] = plan[1] = 0; - } + (*current_liboctave_error_handler) + ("unable to create octave_fftw_planner object!"); + + retval = false; } - else - ret = UNKNOWN; - return ret; + + return retval; } fftwf_plan -octave_float_fftw_planner::create_plan (int dir, const int rank, - const dim_vector dims, octave_idx_type howmany, - octave_idx_type stride, octave_idx_type dist, - const FloatComplex *in, FloatComplex *out) +octave_float_fftw_planner::do_create_plan (int dir, const int rank, + const dim_vector dims, + octave_idx_type howmany, + octave_idx_type stride, + octave_idx_type dist, + const FloatComplex *in, + FloatComplex *out) { int which = (dir == FFTW_FORWARD) ? 0 : 1; fftwf_plan *cur_plan_p = &plan[which]; @@ -514,9 +531,12 @@ } fftwf_plan -octave_float_fftw_planner::create_plan (const int rank, const dim_vector dims, - octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, - const float *in, FloatComplex *out) +octave_float_fftw_planner::do_create_plan (const int rank, + const dim_vector dims, + octave_idx_type howmany, + octave_idx_type stride, + octave_idx_type dist, + const float *in, FloatComplex *out) { fftwf_plan *cur_plan_p = &rplan; bool create_new_plan = false; @@ -627,8 +647,36 @@ return *cur_plan_p; } -octave_fftw_planner fftw_planner; -octave_float_fftw_planner float_fftw_planner; +octave_float_fftw_planner::FftwMethod +octave_float_fftw_planner::do_method (void) +{ + return meth; +} + +octave_float_fftw_planner::FftwMethod +octave_float_fftw_planner::do_method (FftwMethod _meth) +{ + FftwMethod ret = meth; + if (_meth == ESTIMATE || _meth == MEASURE + || _meth == PATIENT || _meth == EXHAUSTIVE + || _meth == HYBRID) + { + if (meth != _meth) + { + meth = _meth; + if (rplan) + fftwf_destroy_plan (rplan); + if (plan[0]) + fftwf_destroy_plan (plan[0]); + if (plan[1]) + fftwf_destroy_plan (plan[1]); + rplan = plan[0] = plan[1] = 0; + } + } + else + ret = UNKNOWN; + return ret; +} template static inline void @@ -716,8 +764,8 @@ dist = (dist < 0 ? npts : dist); dim_vector dv (npts); - fftw_plan plan = fftw_planner.create_plan (1, dv, nsamples, stride, dist, - in, out); + fftw_plan plan = octave_fftw_planner::create_plan (1, dv, nsamples, + stride, dist, in, out); fftw_execute_dft_r2c (plan, (const_cast(in)), reinterpret_cast (out)); @@ -736,8 +784,9 @@ dist = (dist < 0 ? npts : dist); dim_vector dv (npts); - fftw_plan plan = fftw_planner.create_plan (FFTW_FORWARD, 1, dv, nsamples, - stride, dist, in, out); + fftw_plan plan = octave_fftw_planner::create_plan (FFTW_FORWARD, 1, dv, + nsamples, stride, + dist, in, out); fftw_execute_dft (plan, reinterpret_cast (const_cast(in)), @@ -753,8 +802,9 @@ dist = (dist < 0 ? npts : dist); dim_vector dv (npts); - fftw_plan plan = fftw_planner.create_plan (FFTW_BACKWARD, 1, dv, nsamples, - stride, dist, in, out); + fftw_plan plan = octave_fftw_planner::create_plan (FFTW_BACKWARD, 1, dv, + nsamples, stride, + dist, in, out); fftw_execute_dft (plan, reinterpret_cast (const_cast(in)), @@ -781,8 +831,8 @@ octave_idx_type offset = (dv.numel () / dv(0)) * ((dv(0) - 1) / 2); - fftw_plan plan = fftw_planner.create_plan (rank, dv, 1, 1, dist, - in, out + offset); + fftw_plan plan = octave_fftw_planner::create_plan (rank, dv, 1, 1, dist, + in, out + offset); fftw_execute_dft_r2c (plan, (const_cast(in)), reinterpret_cast (out+ offset)); @@ -802,8 +852,8 @@ for (int i = 0; i < rank; i++) dist *= dv(i); - fftw_plan plan = fftw_planner.create_plan (FFTW_FORWARD, rank, dv, 1, 1, - dist, in, out); + fftw_plan plan = octave_fftw_planner::create_plan (FFTW_FORWARD, rank, + dv, 1, 1, dist, in, out); fftw_execute_dft (plan, reinterpret_cast (const_cast(in)), @@ -820,8 +870,8 @@ for (int i = 0; i < rank; i++) dist *= dv(i); - fftw_plan plan = fftw_planner.create_plan (FFTW_BACKWARD, rank, dv, 1, 1, - dist, in, out); + fftw_plan plan = octave_fftw_planner::create_plan (FFTW_BACKWARD, rank, + dv, 1, 1, dist, in, out); fftw_execute_dft (plan, reinterpret_cast (const_cast(in)), @@ -842,8 +892,9 @@ dist = (dist < 0 ? npts : dist); dim_vector dv (npts); - fftwf_plan plan = float_fftw_planner.create_plan (1, dv, nsamples, stride, dist, - in, out); + fftwf_plan plan = octave_float_fftw_planner::create_plan (1, dv, nsamples, + stride, dist, + in, out); fftwf_execute_dft_r2c (plan, (const_cast(in)), reinterpret_cast (out)); @@ -862,8 +913,10 @@ dist = (dist < 0 ? npts : dist); dim_vector dv (npts); - fftwf_plan plan = float_fftw_planner.create_plan (FFTW_FORWARD, 1, dv, nsamples, - stride, dist, in, out); + fftwf_plan plan = octave_float_fftw_planner::create_plan (FFTW_FORWARD, 1, + dv, nsamples, + stride, dist, + in, out); fftwf_execute_dft (plan, reinterpret_cast (const_cast(in)), @@ -879,8 +932,10 @@ dist = (dist < 0 ? npts : dist); dim_vector dv (npts); - fftwf_plan plan = float_fftw_planner.create_plan (FFTW_BACKWARD, 1, dv, nsamples, - stride, dist, in, out); + fftwf_plan plan = octave_float_fftw_planner::create_plan (FFTW_BACKWARD, 1, + dv, nsamples, + stride, dist, + in, out); fftwf_execute_dft (plan, reinterpret_cast (const_cast(in)), @@ -907,8 +962,9 @@ octave_idx_type offset = (dv.numel () / dv(0)) * ((dv(0) - 1) / 2); - fftwf_plan plan = float_fftw_planner.create_plan (rank, dv, 1, 1, dist, - in, out + offset); + fftwf_plan plan = octave_float_fftw_planner::create_plan (rank, dv, 1, 1, + dist, in, + out + offset); fftwf_execute_dft_r2c (plan, (const_cast(in)), reinterpret_cast (out+ offset)); @@ -928,8 +984,9 @@ for (int i = 0; i < rank; i++) dist *= dv(i); - fftwf_plan plan = float_fftw_planner.create_plan (FFTW_FORWARD, rank, dv, 1, 1, - dist, in, out); + fftwf_plan plan = octave_float_fftw_planner::create_plan (FFTW_FORWARD, + rank, dv, 1, 1, + dist, in, out); fftwf_execute_dft (plan, reinterpret_cast (const_cast(in)), @@ -946,8 +1003,9 @@ for (int i = 0; i < rank; i++) dist *= dv(i); - fftwf_plan plan = float_fftw_planner.create_plan (FFTW_BACKWARD, rank, dv, 1, 1, - dist, in, out); + fftwf_plan plan = octave_float_fftw_planner::create_plan (FFTW_BACKWARD, + rank, dv, 1, 1, + dist, in, out); fftwf_execute_dft (plan, reinterpret_cast (const_cast(in)), diff --git a/liboctave/oct-fftw.h b/liboctave/oct-fftw.h --- a/liboctave/oct-fftw.h +++ b/liboctave/oct-fftw.h @@ -1,6 +1,6 @@ /* -Copyright (C) 2001, 2004, 2005, 2007, 2008 John W. Eaton +Copyright (C) 2001, 2004, 2005, 2007, 2008, 2009 John W. Eaton This file is part of Octave. @@ -33,19 +33,16 @@ OCTAVE_API octave_fftw_planner { -public: +protected: octave_fftw_planner (void); - fftw_plan create_plan (int dir, const int rank, const dim_vector dims, - octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, - const Complex *in, Complex *out); +public: - fftw_plan create_plan (const int rank, const dim_vector dims, - octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, - const double *in, Complex *out); + ~octave_fftw_planner (void) { } - enum FftwMethod { + enum FftwMethod + { UNKNOWN = -1, ESTIMATE, MEASURE, @@ -54,12 +51,67 @@ HYBRID }; - FftwMethod method (void); + static bool instance_ok (void); + + static fftw_plan + create_plan (int dir, const int rank, const dim_vector dims, + octave_idx_type howmany, octave_idx_type stride, + octave_idx_type dist, const Complex *in, + Complex *out) + { + static fftw_plan dummy; + + return instance_ok () + ? instance->do_create_plan (dir, rank, dims, howmany, stride, + dist, in, out) + : dummy; + } - FftwMethod method (FftwMethod _meth); + static fftw_plan + create_plan (const int rank, const dim_vector dims, + octave_idx_type howmany, octave_idx_type stride, + octave_idx_type dist, const double *in, Complex *out) + { + static fftw_plan dummy; + + return instance_ok () + ? instance->do_create_plan (rank, dims, howmany, stride, dist, in, out) + : dummy; + } + + static FftwMethod method (void) + { + static FftwMethod dummy; + + return instance_ok () ? instance->do_method () : dummy; + } + + static FftwMethod method (FftwMethod _meth) + { + static FftwMethod dummy; + + return instance_ok () ? instance->do_method (_meth) : dummy; + } private: + static octave_fftw_planner *instance; + + fftw_plan + do_create_plan (int dir, const int rank, const dim_vector dims, + octave_idx_type howmany, octave_idx_type stride, + octave_idx_type dist, const Complex *in, + Complex *out); + + fftw_plan + do_create_plan (const int rank, const dim_vector dims, + octave_idx_type howmany, octave_idx_type stride, + octave_idx_type dist, const double *in, Complex *out); + + FftwMethod do_method (void); + + FftwMethod do_method (FftwMethod _meth); + FftwMethod meth; // FIXME -- perhaps this should be split into two classes? @@ -110,19 +162,16 @@ OCTAVE_API octave_float_fftw_planner { -public: +protected: octave_float_fftw_planner (void); - fftwf_plan create_plan (int dir, const int rank, const dim_vector dims, - octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, - const FloatComplex *in, FloatComplex *out); +public: - fftwf_plan create_plan (const int rank, const dim_vector dims, - octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, - const float *in, FloatComplex *out); + ~octave_float_fftw_planner (void) { } - enum FftwMethod { + enum FftwMethod + { UNKNOWN = -1, ESTIMATE, MEASURE, @@ -131,12 +180,67 @@ HYBRID }; - FftwMethod method (void); + static bool instance_ok (void); + + static fftwf_plan + create_plan (int dir, const int rank, const dim_vector dims, + octave_idx_type howmany, octave_idx_type stride, + octave_idx_type dist, const FloatComplex *in, + FloatComplex *out) + { + static fftwf_plan dummy; + + return instance_ok () + ? instance->do_create_plan (dir, rank, dims, howmany, stride, + dist, in, out) + : dummy; + } - FftwMethod method (FftwMethod _meth); + static fftwf_plan + create_plan (const int rank, const dim_vector dims, + octave_idx_type howmany, octave_idx_type stride, + octave_idx_type dist, const float *in, FloatComplex *out) + { + static fftwf_plan dummy; + + return instance_ok () + ? instance->do_create_plan (rank, dims, howmany, stride, dist, in, out) + : dummy; + } + + static FftwMethod method (void) + { + static FftwMethod dummy; + + return instance_ok () ? instance->method () : dummy; + } + + static FftwMethod method (FftwMethod _meth) + { + static FftwMethod dummy; + + return instance_ok () ? instance->method (_meth) : dummy; + } private: + static octave_float_fftw_planner *instance; + + fftwf_plan + do_create_plan (int dir, const int rank, const dim_vector dims, + octave_idx_type howmany, octave_idx_type stride, + octave_idx_type dist, const FloatComplex *in, + FloatComplex *out); + + fftwf_plan + do_create_plan (const int rank, const dim_vector dims, + octave_idx_type howmany, octave_idx_type stride, + octave_idx_type dist, const float *in, FloatComplex *out); + + FftwMethod do_method (void); + + FftwMethod do_method (FftwMethod _meth); + FftwMethod meth; // FIXME -- perhaps this should be split into two classes? @@ -183,10 +287,6 @@ bool rsimd_align; }; -// FIXME -- maybe octave_fftw_planner should be a singleton object? -extern OCTAVE_API octave_fftw_planner fftw_planner; -extern OCTAVE_API octave_float_fftw_planner float_fftw_planner; - class OCTAVE_API octave_fftw diff --git a/src/ChangeLog b/src/ChangeLog --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,8 @@ +2009-08-11 John W. Eaton + + * DLD-FUNCTIONS/fftw.cc (Ffftw): Update for octave_fftw_planner + and octave_float_fftw_planner as singleton objects. + 2009-08-11 John W. Eaton * oct-conf.h.in: Use READLINE_LIBS instead of LIBREADLINE. diff --git a/src/DLD-FUNCTIONS/fftw.cc b/src/DLD-FUNCTIONS/fftw.cc --- a/src/DLD-FUNCTIONS/fftw.cc +++ b/src/DLD-FUNCTIONS/fftw.cc @@ -1,6 +1,6 @@ /* -Copyright (C) 2006, 2007, 2008 David Bateman +Copyright (C) 2006, 2007, 2008, 2009 David Bateman This file is part of Octave. @@ -176,8 +176,8 @@ if (!error_state) { - meth = fftw_planner.method (meth); - float_fftw_planner.method (methf); + meth = octave_fftw_planner::method (meth); + octave_float_fftw_planner::method (methf); if (meth == octave_fftw_planner::MEASURE) retval = octave_value ("measure"); @@ -228,7 +228,7 @@ if (arg0 == "planner") { octave_fftw_planner::FftwMethod meth = - fftw_planner.method (); + octave_fftw_planner::method (); if (meth == octave_fftw_planner::MEASURE) retval = octave_value ("measure"); @@ -266,4 +266,3 @@ return retval; } -