File: PolynomialFunction.h

package info (click to toggle)
libbpp-core 2.4.1-13
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,904 kB
  • sloc: cpp: 31,128; python: 481; makefile: 14
file content (125 lines) | stat: -rw-r--r-- 4,140 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
//
// File: PolynomialFunction.cpp
// Created by: Julien Dutheil
// Created on: Wed Oct 27 18:46 2010
//

/*
Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)

This software is a computer program whose purpose is to provide classes
for numerical calculus. This file is part of the Bio++ project.

This software is governed by the CeCILL  license under French law and
abiding by the rules of distribution of free software.  You can  use, 
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info". 

As a counterpart to the access to the source code and  rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty  and the software's author,  the holder of the
economic rights,  and the successive licensors  have only  limited
liability. 

In this respect, the user's attention is drawn to the risks associated
with loading,  using,  modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean  that it is complicated to manipulate,  and  that  also
therefore means  that it is reserved for developers  and  experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or 
data to be ensured and,  more generally, to use and operate it in the 
same conditions as regards security. 

The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/

#include <Bpp/Numeric/Function/Functions.h>
#include <Bpp/Numeric/AbstractParametrizable.h>

#include <map>
#include <string>

using namespace bpp;
using namespace std;

class PolynomialFunction1:
  public virtual Function,
  public AbstractParametrizable
{
  private:
    double fval_;
 
  public:
    PolynomialFunction1() : AbstractParametrizable(""), fval_(0) {
      //We declare parameters here:
      addParameter_(new Parameter("x", 0));
      addParameter_(new Parameter("y", 0));
      addParameter_(new Parameter("z", 0));
      fireParameterChanged(getParameters());
    }
 
    PolynomialFunction1* clone() const { return new PolynomialFunction1(*this); }
 
  public:
    void setParameters(const ParameterList& pl)
    {
      matchParametersValues(pl);
    }
    double getValue() const { return fval_; }
 
    void fireParameterChanged(const ParameterList& pl) {
      double x = getParameterValue("x");
      double y = getParameterValue("y");
      double z = getParameterValue("z");
      fval_ = (x-5)*(x-5) + (y+2)*(y+2) + (z-3)*(z-3);
    }
};

class PolynomialFunction1Der1:
  public PolynomialFunction1,
  public virtual DerivableFirstOrder
{
  protected:
    bool compFirstDer_;
    mutable map<string, double> firstDer_;

  public:
    PolynomialFunction1Der1(): compFirstDer_(true), firstDer_() {
      //Need to compute derivatives:
      fireParameterChanged(getParameters());
    }
 
    PolynomialFunction1Der1* clone() const { return new PolynomialFunction1Der1(*this); }
 
  public:
    void setParameters(const ParameterList& pl)
    {
      matchParametersValues(pl);
    }
 
    void fireParameterChanged(const ParameterList& pl) {
      PolynomialFunction1::fireParameterChanged(pl);
      if (compFirstDer_) {
        double x = getParameterValue("x");
        double y = getParameterValue("y");
        double z = getParameterValue("z");
        firstDer_["x"] = 2 * (x - 5);
        firstDer_["y"] = 2 * (y + 2);
        firstDer_["z"] = 2 * (z - 3);
      }
    }

    void enableFirstOrderDerivatives(bool yn) { compFirstDer_ = yn; }
    bool enableFirstOrderDerivatives() const { return compFirstDer_; }

    double getFirstOrderDerivative(const std::string& variable) const {
      if (!compFirstDer_)
        throw Exception("PolynomialFunction1Der1::getFirstOrderDerivative. First order derivatives are not computed.");
      return firstDer_[variable];
    }
};