convolution_function.h

Go to the documentation of this file.

//
// Copyright (c) 2016 by François Mauger <mauger@lpccaen.in2p3.fr>
//
// This file is part of Bayeux.
//
// Bayeux is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Bayeux is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Bayeux. If not, see <http://www.gnu.org/licenses/>.

#ifndef MYGSL_CONVOLUTION_FUNCTION_H
#define MYGSL_CONVOLUTION_FUNCTION_H

// This project:
#include <mygsl/i_unary_function.h>

// Third party:
#include <boost/noncopyable.hpp>

namespace mygsl {


  class convolution_function
    : public i_unary_function
    , private boost::noncopyable
  {
  public:

    convolution_function();

    convolution_function(const i_unary_function & f_,
                         const i_unary_function & g_,
                         std::size_t size_ = 1000);

    convolution_function(const const_unary_function_handle_type & hcf_,
                         const const_unary_function_handle_type & hcg_,
                         std::size_t size_ = 1000);

    virtual ~convolution_function();

    virtual bool is_initialized() const;

    virtual void initialize(const datatools::properties & config_,
                            const unary_function_dict_type & functors_);

    void reset();

    void set_f(const i_unary_function &);

    void set_g(const i_unary_function &);

    bool has_f() const;

    bool has_g() const;

    const i_unary_function & get_f() const;

    const i_unary_function & get_g() const;

    void set_limit(std::size_t size_);

    std::size_t get_limit() const;

    virtual void tree_dump(std::ostream & out_ = std::clog,
                           const std::string & title_  = "",
                           const std::string & indent_ = "",
                           bool inherit_ = false) const;

    class convolution_term : public i_unary_function
    {
    public:

      convolution_term(const convolution_function & cf_, double t_);

      /* virtual */ double get_non_zero_domain_min() const;

      /* virtual */ double get_non_zero_domain_max() const;

      void print(std::ostream & = std::clog, const std::string & title_ = "") const;

    protected:

      virtual double _eval(double) const;

    private:

      const convolution_function * _cs_; 
      double _t_;
      double _tmin_;
      double _tmax_;

    };

    static double convolution_func(double t_, void * params_);

  protected:

    double _eval(double x_) const;

    void _at_init();

    void _at_reset();

  private:

    unary_function_handle _f_; 
    unary_function_handle _g_; 
    std::size_t           _limit_ = 0; 

    class gsl_pimpl;
    gsl_pimpl * _gsl_work_ = nullptr; 

    MYGSL_UNARY_FUNCTOR_REGISTRATION_INTERFACE(convolution_function)

  };

} // end of namespace mygsl

#endif // MYGSL_CONVOLUTION_FUNCTION_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --