linear_combination_function.h

Go to the documentation of this file.

//
// Copyright (c) 2015 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_LINEAR_COMBINATION_FUNCTION_H
#define MYGSL_LINEAR_COMBINATION_FUNCTION_H

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

namespace mygsl {


  class linear_combination_function : public i_unary_function
  {
  public:

    linear_combination_function();

    linear_combination_function(double w1_,
                                const const_unary_function_handle_type & f1_,
                                double w2_,
                                const const_unary_function_handle_type & f2_);

    virtual ~linear_combination_function();

    virtual bool is_initialized() const;

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

    void reset();

    std::size_t add(double weight_, const i_unary_function &);

    std::size_t add(double weight_, const const_unary_function_handle_type &);

    void change_weight(int term_index_, double weight_);

    virtual bool has_explicit_domain_of_definition() const;

    virtual bool is_in_domain_of_definition(double x_) const;

    virtual double get_non_zero_domain_min() const;

    virtual double get_non_zero_domain_max() const;

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

  protected :

    double _eval(double x_) const;

    void _set_defaults();

  private:

    void _recompute_();

  private:

    // Working data:
    struct term_type;
    std::vector<term_type> _terms_; 
    bool _explicit_domain_of_definition_; 
    double _non_zero_domain_min_; 
    double _non_zero_domain_max_; 

    MYGSL_UNARY_FUNCTOR_REGISTRATION_INTERFACE(linear_combination_function)

  };

} // end of namespace mygsl

#endif // MYGSL_LINEAR_COMBINATION_FUNCTION_H

// Local Variables:
// mode: c++
// coding: utf-8
// End: