Bayeux  3.4.1
Core Foundation library for SuperNEMO
composite_function.h
Go to the documentation of this file.
1 //
4 // Copyright (c) 2015 by François Mauger <mauger@lpccaen.in2p3.fr>
5 //
6 // This file is part of Bayeux.
7 //
8 // Bayeux is free software: you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation, either version 3 of the License, or
11 // (at your option) any later version.
12 //
13 // Bayeux is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with Bayeux. If not, see <http://www.gnu.org/licenses/>.
20 
21 #ifndef MYGSL_COMPOSITE_FUNCTION_H
22 #define MYGSL_COMPOSITE_FUNCTION_H
23 
24 // This project:
25 #include <mygsl/i_unary_function.h>
26 
27 namespace mygsl {
28 
30 
39  : public i_unary_function
40  {
41  public:
42 
45 
48  const i_unary_function & g_);
49 
53 
55  virtual ~composite_function();
56 
58  virtual bool is_initialized() const;
59 
61  virtual void initialize(const datatools::properties & config_,
62  const unary_function_dict_type & functors_);
63 
65  void reset();
66 
68  void set_f(const i_unary_function &);
69 
71  void set_g(const i_unary_function &);
72 
74  bool has_f() const;
75 
77  bool has_g() const;
78 
80  /* virtual */ bool has_explicit_domain_of_definition() const;
81 
82  /* virtual */ bool is_in_domain_of_definition(double x_) const;
83 
84  /* virtual */ double get_non_zero_domain_min() const;
85 
86  /* virtual */ double get_non_zero_domain_max() const;
87 
89  virtual void tree_dump(std::ostream & out_ = std::clog,
90  const std::string & title_ = "",
91  const std::string & indent_ = "",
92  bool inherit_ = false) const;
93 
94  protected :
95 
97  double _eval(double x_) const;
98 
99  private:
100 
102  void _init_();
103 
104  private:
105 
108 
111 
112  };
113 
114 } // end of namespace mygsl
115 
116 #endif // MYGSL_COMPOSITE_FUNCTION_H
117 
118 // Local Variables: --
119 // mode: c++ --
120 // c-file-style: "gnu" --
121 // tab-width: 2 --
122 // End: --
virtual bool is_initialized() const
Check initialization status.
bool is_in_domain_of_definition(double x_) const
Check if a value is in the domain of definition of the function (default: true)
void reset()
Reset the composite function.
void set_g(const i_unary_function &)
Set the second functor.
virtual ~composite_function()
Destructor.
Composite function.
Definition: composite_function.h:38
double get_non_zero_domain_max() const
The maximum bound of the non-zero domain (default is plus infinity)
bool has_g() const
Check the second functor.
double _eval(double x_) const
Evaluation.
Abstract interface for unary functions : R -> R.
Definition: i_unary_function.h:44
Smart handle to an unary function object.
Definition: unary_function_utils.h:33
virtual void tree_dump(std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
Smart printing.
Top-level namespace of the Bayeux/mygsl module library.
Definition: base_decay_driver.h:47
bool has_f() const
Check the first functor.
std::map< std::string, unary_function_handle_type > unary_function_dict_type
Alias for dictionary of handles to unary function objects.
Definition: unary_function_utils.h:30
void set_f(const i_unary_function &)
Set the first functor.
#define MYGSL_UNARY_FUNCTOR_REGISTRATION_INTERFACE(UnaryFunctorClass)
Definition: i_unary_function.h:206
bool has_explicit_domain_of_definition() const
Check if the function has an explicit domain of definition (default: false)
virtual void initialize(const datatools::properties &config_, const unary_function_dict_type &functors_)
Initialization from a container of parameters and a dictionary of functors.
double get_non_zero_domain_min() const
The minimum bound of the non-zero domain (default is minus infinity)
composite_function()
Default constructor.
A dictionary of arbitrary properties.
Definition: properties.h:125