/usr/include/Bpp/Numeric/Function/ReparametrizationFunctionWrapper.h is in libbpp-core-dev 2.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 | //
// File: ReparametrizationFunctionWrapper.h
// Created by: Julien Dutheil
// Created on: Fri Jan 30 09:30 2009
//
/*
Copyright or © or Copr. CNRS, (November 17, 2004)
This software is a computer program whose purpose is to provide classes
for numerical calculus.
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.
*/
#ifndef _REPARAMETRIZATIONFUNCTIONWRAPPER_H_
#define _REPARAMETRIZATIONFUNCTIONWRAPPER_H_
#include "Functions.h"
#include "../AbstractParametrizable.h"
#include "../TransformedParameter.h"
namespace bpp {
/**
* @brief Function wrapper that remove simple constraints on parameters.
*
* This function takes as input another function and reparametrize it when possible.
* currently, only constraint of the type ]a, b[ where a and b can be +/- inf.
*/
class ReparametrizationFunctionWrapper:
public virtual Function,
public AbstractParametrizable
{
private:
Function* function_;
ParameterList functionParameters_;
public:
/**
* @brief Build a new reparametrization wrapper for the given function, using all available parameters.
*
* @param function The function to reparametrize.
* @param verbose Print some information.
*/
ReparametrizationFunctionWrapper(Function* function, bool verbose=true) :
AbstractParametrizable(function->getNamespace()),
function_(function),
functionParameters_(function->getParameters())
{
init_(verbose);
}
/**
* @brief Build a new reparametrization wrapper for the given function, using only the specified parameters.
*
* @param function The function to reparametrize.
* @param parameters The list of parameters that will be reparametrized. The intersection with the
* list of function parameters will be used in the reparametrized function. Any other parameters
* (in the given list or in the original function) will be ignored.
* @param verbose Print some information.
*/
ReparametrizationFunctionWrapper(Function* function, const ParameterList& parameters, bool verbose=true) :
AbstractParametrizable(function->getNamespace()),
function_(function),
functionParameters_(function->getParameters().getCommonParametersWith(parameters))
{
init_(verbose);
}
ReparametrizationFunctionWrapper(const ReparametrizationFunctionWrapper& rfw) :
AbstractParametrizable(rfw),
function_(rfw.function_),
functionParameters_(rfw.functionParameters_) {}
ReparametrizationFunctionWrapper& operator=(const ReparametrizationFunctionWrapper& rfw)
{
AbstractParametrizable::operator=(rfw),
function_ = rfw.function_;
functionParameters_ = rfw.functionParameters_;
return *this;
}
virtual ~ReparametrizationFunctionWrapper() {}
#if defined(NO_VIRTUAL_COV)
Clonable* clone() const { return new ReparametrizationFunctionWrapper(*this); }
#else
ReparametrizationFunctionWrapper* clone() const { return new ReparametrizationFunctionWrapper(*this); }
#endif
private:
void init_(bool verbose);
public:
virtual const Function& getFunction() const { return *function_; }
virtual Function& getFunction() { return *function_; }
void setParameters(const ParameterList& parameters)
throw (ParameterNotFoundException, ConstraintException)
{
// parameters.printParameters(std::cout);
matchParametersValues(parameters);
//We only set parameters that have been changed:
// functionParameters_.printParameters(std::cout);
function_->setParameters(functionParameters_.subList(parameters.getParameterNames()));
}
double getValue() const throw (Exception)
{
return function_->getValue();
}
void fireParameterChanged (const ParameterList ¶meters);
};
/**
* @brief Function wrapper that remove simple constraints on parameters. Also transform first order derivatives.
*
* This function takes as input another function and reparametrize it when possible.
* currently, only constraint of the type ]a, b[ where a and b can be +/- inf.
*/
class ReparametrizationDerivableFirstOrderWrapper:
public virtual DerivableFirstOrder,
public ReparametrizationFunctionWrapper
{
public:
/**
* @brief Build a new reparametrization wrapper for the given function, using all available parameters.
*
* @param function The function to reparametrize.
* @param verbose Print some information.
*/
ReparametrizationDerivableFirstOrderWrapper(DerivableFirstOrder* function, bool verbose=true) :
ReparametrizationFunctionWrapper(function, verbose)
{}
/**
* @brief Build a new reparametrization wrapper for the given function, using only the specified parameters.
*
* @param function The function to reparametrize.
* @param parameters The list of parameters that will be reparametrized. The intersection with the
* list of function parameters will be used in the reparametrized function. Any other parameters
* (in the given list or in the original function) will be ignored.
* @param verbose Print some information.
*/
ReparametrizationDerivableFirstOrderWrapper(DerivableFirstOrder* function, const ParameterList& parameters, bool verbose=true) :
ReparametrizationFunctionWrapper(function, parameters, verbose)
{}
virtual ~ReparametrizationDerivableFirstOrderWrapper() {}
#if defined(NO_VIRTUAL_COV)
Clonable* clone() const { return new ReparametrizationDerivableFirstOrderWrapper(*this); }
#else
ReparametrizationDerivableFirstOrderWrapper* clone() const { return new ReparametrizationDerivableFirstOrderWrapper(*this); }
#endif
private:
void init_(bool verbose);
public:
void enableFirstOrderDerivatives(bool yn) { dynamic_cast<DerivableFirstOrder&>(getFunction()).enableFirstOrderDerivatives(yn); }
bool enableFirstOrderDerivatives() const { return dynamic_cast<const DerivableFirstOrder&>(getFunction()).enableFirstOrderDerivatives(); }
double getFirstOrderDerivative(const std::string& variable) const throw (Exception)
{
return dynamic_cast<const DerivableFirstOrder&>(getFunction()).getFirstOrderDerivative(variable)
* dynamic_cast<const TransformedParameter&>(getParameter(variable)).getFirstOrderDerivative();
}
};
/**
* @brief Function wrapper that remove simple constraints on parameters. Also transform first and second order derivatives.
*
* This function takes as input another function and reparametrize it when possible.
* currently, only constraint of the type ]a, b[ where a and b can be +/- inf.
*/
class ReparametrizationDerivableSecondOrderWrapper:
public virtual DerivableSecondOrder,
public ReparametrizationDerivableFirstOrderWrapper
{
public:
/**
* @brief Build a new reparametrization wrapper for the given function, using all available parameters.
*
* @param function The function to reparametrize.
* @param verbose Print some information.
*/
ReparametrizationDerivableSecondOrderWrapper(DerivableSecondOrder* function, bool verbose=true) :
ReparametrizationDerivableFirstOrderWrapper(function, verbose)
{}
/**
* @brief Build a new reparametrization wrapper for the given function, using only the specified parameters.
*
* @param function The function to reparametrize.
* @param parameters The list of parameters that will be reparametrized. The intersection with the
* list of function parameters will be used in the reparametrized function. Any other parameters
* (in the given list or in the original function) will be ignored.
* @param verbose Print some information.
*/
ReparametrizationDerivableSecondOrderWrapper(DerivableSecondOrder* function, const ParameterList& parameters, bool verbose=true) :
ReparametrizationDerivableFirstOrderWrapper(function, parameters, verbose)
{}
virtual ~ReparametrizationDerivableSecondOrderWrapper() {}
#if defined(NO_VIRTUAL_COV)
Clonable* clone() const { return new ReparametrizationDerivableSecondOrderWrapper(*this); }
#else
ReparametrizationDerivableSecondOrderWrapper* clone() const { return new ReparametrizationDerivableSecondOrderWrapper(*this); }
#endif
private:
void init_(bool verbose);
public:
void enableSecondOrderDerivatives(bool yn) { dynamic_cast<DerivableSecondOrder&>(getFunction()).enableSecondOrderDerivatives(yn); }
bool enableSecondOrderDerivatives() const { return dynamic_cast<const DerivableSecondOrder&>(getFunction()).enableSecondOrderDerivatives(); }
double getSecondOrderDerivative(const std::string& variable) const throw (Exception)
{
return dynamic_cast<const DerivableSecondOrder&>(getFunction()).getSecondOrderDerivative(variable)
* pow(dynamic_cast<const TransformedParameter&>(getParameter(variable)).getFirstOrderDerivative(), 2)
+ dynamic_cast<const DerivableSecondOrder&>(getFunction()).getFirstOrderDerivative(variable)
* dynamic_cast<const TransformedParameter&>(getParameter(variable)).getSecondOrderDerivative();
}
double getSecondOrderDerivative(const std::string& variable1, const std::string& variable2) const throw (Exception)
{
return dynamic_cast<const DerivableSecondOrder&>(getFunction()).getSecondOrderDerivative(variable1, variable2)
* dynamic_cast<const TransformedParameter&>(getParameter(variable1)).getFirstOrderDerivative()
* dynamic_cast<const TransformedParameter&>(getParameter(variable2)).getFirstOrderDerivative();
}
};
} //end of namespace bpp.
#endif //_REPARAMETRIZATIONFUNCTIONWRAPPER_H_
|