bpp-core3
3.0.0
|
Function wrapper that remove simple constraints on parameters. Also transform first and second order derivatives. More...
#include <Bpp/Numeric/Function/ReparametrizationFunctionWrapper.h>
Public Member Functions | |
ReparametrizationDerivableSecondOrderWrapper (std::shared_ptr< SecondOrderDerivable > function, bool verbose=true) | |
Build a new reparametrization wrapper for the given function, using all available parameters. More... | |
ReparametrizationDerivableSecondOrderWrapper (std::shared_ptr< SecondOrderDerivable > function, const ParameterList ¶meters, bool verbose=true) | |
Build a new reparametrization wrapper for the given function, using only the specified parameters. More... | |
virtual | ~ReparametrizationDerivableSecondOrderWrapper () |
ReparametrizationDerivableSecondOrderWrapper * | clone () const |
Create a copy of this object and send a pointer to it. More... | |
void | enableSecondOrderDerivatives (bool yn) |
Tell if derivatives must be computed. More... | |
bool | enableSecondOrderDerivatives () const |
Tell if derivatives must be computed. More... | |
double | getSecondOrderDerivative (const std::string &variable) const |
Get the second order derivative of the function at the current point. More... | |
double | getSecondOrderDerivative (const std::string &variable1, const std::string &variable2) const |
Get the value of the cross derivative of the function according to a given set of parameters. More... | |
virtual double | d2f (const std::string &variable, const ParameterList ¶meters) |
Get the value of the second order derivative of the function according to a given set of parameters. More... | |
virtual double | d2f (const std::string &variable1, const std::string &variable2, const ParameterList ¶meters) |
Get the value of the cross derivative of the function according to a given set of parameters. More... | |
virtual void | enableFirstOrderDerivatives (bool yn)=0 |
Tell if derivatives must be computed. More... | |
virtual bool | enableFirstOrderDerivatives () const =0 |
Tell if derivatives must be computed. More... | |
virtual double | getFirstOrderDerivative (const std::string &variable) const =0 |
Get the derivative of the function at the current point. More... | |
virtual double | df (const std::string &variable, const ParameterList ¶meters) |
Get the value of the first derivative of the function according to a given set of parameters. More... | |
virtual void | setParameters (const ParameterList ¶meters)=0 |
Set the point where the function must be computed. More... | |
virtual double | getValue () const =0 |
Get the value of the function at the current point. More... | |
virtual double | f (const ParameterList ¶meters) |
Get the value of the function according to a given set of parameters. More... | |
virtual bool | hasParameter (const std::string &name) const =0 |
Tell if there is a parameter with specified name. More... | |
virtual const ParameterList & | getParameters () const =0 |
Get all parameters available. More... | |
virtual const Parameter & | parameter (const std::string &name) const =0 |
Get the parameter with specified name. More... | |
virtual double | getParameterValue (const std::string &name) const =0 |
Get the value for parameter of name 'name'. More... | |
virtual void | setAllParametersValues (const ParameterList ¶meters)=0 |
Set the parameters values to be equals to those of parameters. More... | |
virtual void | setParameterValue (const std::string &name, double value)=0 |
Set the value of parameter with name name to be equal to value. More... | |
virtual void | setParametersValues (const ParameterList ¶meters)=0 |
Update the parameters from parameters. More... | |
virtual bool | matchParametersValues (const ParameterList ¶meters)=0 |
Update the parameters from parameters. More... | |
virtual void | removeConstraint (const std::string &name)=0 |
Remove the constraint associated with one parameter, if any. More... | |
virtual void | setConstraint (const std::string &name, std::shared_ptr< ConstraintInterface > constraint)=0 |
Set/Change the constraint associated with one parameter. More... | |
virtual size_t | getNumberOfParameters () const =0 |
Get the number of parameters. More... | |
virtual void | setNamespace (const std::string &prefix)=0 |
Set the namespace for the parameter names. More... | |
virtual std::string | getNamespace () const =0 |
virtual std::string | getParameterNameWithoutNamespace (const std::string &name) const =0 |
Resolves a parameter name according to the current namespace. More... | |
void | enableFirstOrderDerivatives (bool yn) |
Tell if derivatives must be computed. More... | |
bool | enableFirstOrderDerivatives () const |
Tell if derivatives must be computed. More... | |
double | getFirstOrderDerivative (const std::string &variable) const |
Get the derivative of the function at the current point. More... | |
void | setParameters (const ParameterList ¶meters) |
Set the point where the function must be computed. More... | |
double | getValue () const |
Get the value of the function at the current point. More... | |
bool | hasParameter (const std::string &name) const override |
Tell if there is a parameter with specified name. More... | |
const ParameterList & | getParameters () const override |
Get all parameters available. More... | |
const Parameter & | parameter (const std::string &name) const override |
Get the parameter with specified name. More... | |
double | getParameterValue (const std::string &name) const override |
Get the value for parameter of name 'name'. More... | |
void | setAllParametersValues (const ParameterList ¶meters) override |
Set the parameters values to be equals to those of parameters. More... | |
void | setParameterValue (const std::string &name, double value) override |
Set the value of parameter with name name to be equal to value. More... | |
void | setParametersValues (const ParameterList ¶meters) override |
Update the parameters from parameters. More... | |
bool | matchParametersValues (const ParameterList ¶meters) override |
Update the parameters from parameters. More... | |
void | removeConstraint (const std::string &name) override |
Remove the constraint associated with one parameter, if any. More... | |
void | setConstraint (const std::string &name, std::shared_ptr< ConstraintInterface > constraint) override |
Set/Change the constraint associated with one parameter. More... | |
size_t | getNumberOfParameters () const override |
Get the number of parameters. More... | |
void | setNamespace (const std::string &prefix) override |
Set the namespace for the parameter names. More... | |
std::string | getNamespace () const override |
std::string | getParameterNameWithoutNamespace (const std::string &name) const override |
Resolves a parameter name according to the current namespace. More... | |
virtual const FunctionInterface & | function () const |
virtual FunctionInterface & | function () |
virtual std::shared_ptr< const FunctionInterface > | getFunction () const |
virtual std::shared_ptr< FunctionInterface > | getFunction () |
void | fireParameterChanged (const ParameterList ¶meters) |
Notify the class when one or several parameters have changed. More... | |
const std::shared_ptr< Parameter > & | getParameter (const std::string &name) const |
Protected Member Functions | |
virtual ParameterList & | getParameters_ ()=0 |
Get all parameters available. More... | |
ParameterList & | getParameters_ () override |
Get all parameters available. More... | |
const std::shared_ptr< Parameter > & | getParameter (size_t i) const |
std::shared_ptr< Parameter > & | getParameter (size_t i) |
virtual void | addParameter_ (Parameter *parameter) |
virtual void | addParameters_ (const ParameterList ¶meters) |
virtual void | shareParameter_ (const std::shared_ptr< Parameter > ¶meter) |
virtual void | shareParameters_ (const ParameterList ¶meters) |
virtual void | includeParameters_ (const ParameterList ¶meters) |
virtual void | deleteParameter_ (size_t index) |
virtual void | deleteParameter_ (std::string &name) |
virtual void | deleteParameters_ (const std::vector< std::string > &names) |
void | resetParameters_ () |
Parameter & | getParameter_ (const std::string &name) |
Parameter & | getParameter_ (size_t index) |
const Parameter & | getParameter_ (size_t index) const |
Parameter & | getParameterWithNamespace_ (const std::string &name) |
const Parameter & | getParameterWithNamespace_ (const std::string &name) const |
Protected Attributes | |
std::shared_ptr< FunctionInterface > | function_ |
ParameterList | functionParameters_ |
Private Member Functions | |
void | init_ (bool verbose) |
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.
Definition at line 167 of file ReparametrizationFunctionWrapper.h.
|
inline |
Build a new reparametrization wrapper for the given function, using all available parameters.
function | The function to reparametrize. |
verbose | Print some information. |
Definition at line 178 of file ReparametrizationFunctionWrapper.h.
|
inline |
Build a new reparametrization wrapper for the given function, using only the specified parameters.
function | The function to reparametrize. |
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. |
verbose | Print some information. |
Definition at line 191 of file ReparametrizationFunctionWrapper.h.
|
inlinevirtual |
Definition at line 195 of file ReparametrizationFunctionWrapper.h.
|
inlineprotectedvirtualinherited |
Reimplemented in bpp::AbstractParameterAliasable.
Definition at line 111 of file AbstractParametrizable.h.
References bpp::ParameterList::addParameter().
Referenced by bpp::AbstractParameterAliasable::addParameter_(), and bpp::AutoCorrelationTransitionMatrix::AutoCorrelationTransitionMatrix().
|
inlineprotectedvirtualinherited |
Reimplemented in bpp::AbstractParameterAliasable.
Definition at line 117 of file AbstractParametrizable.h.
References bpp::ParameterList::addParameters().
Referenced by bpp::AbstractParameterAliasable::addParameters_(), bpp::FullHmmTransitionMatrix::FullHmmTransitionMatrix(), bpp::LogsumHmmLikelihood::LogsumHmmLikelihood(), bpp::LowMemoryRescaledHmmLikelihood::LowMemoryRescaledHmmLikelihood(), and bpp::RescaledHmmLikelihood::RescaledHmmLikelihood().
|
inlinevirtual |
Create a copy of this object and send a pointer to it.
Implements bpp::SecondOrderDerivable.
Definition at line 197 of file ReparametrizationFunctionWrapper.h.
References bpp::ReparametrizationFunctionWrapper::init_().
|
inlinevirtualinherited |
Get the value of the second order derivative of the function according to a given set of parameters.
variable | The name of the variable in . |
parameters | The parameter set to pass to the function. |
Exception | If an error occured. |
Definition at line 193 of file Functions.h.
References bpp::FunctionInterface::setParameters().
|
inlinevirtualinherited |
Get the value of the cross derivative of the function according to a given set of parameters.
variable1 | The name of the variable in . |
variable2 | The name of the variable in . |
parameters | The parameter set to pass to the function. |
Exception | If an error occured. |
Definition at line 220 of file Functions.h.
References bpp::FunctionInterface::setParameters().
|
inlineprotectedvirtualinherited |
Reimplemented in bpp::AbstractParameterAliasable.
Definition at line 137 of file AbstractParametrizable.h.
References bpp::ParameterList::deleteParameter(), and bpp::ParameterList::size().
Referenced by bpp::AbstractParameterAliasable::deleteParameter_().
|
inlineprotectedvirtualinherited |
Reimplemented in bpp::AbstractParameterAliasable.
Definition at line 144 of file AbstractParametrizable.h.
References bpp::ParameterList::deleteParameter().
|
inlineprotectedvirtualinherited |
Reimplemented in bpp::AbstractParameterAliasable.
Definition at line 149 of file AbstractParametrizable.h.
References bpp::ParameterList::deleteParameters().
|
inlinevirtualinherited |
Get the value of the first derivative of the function according to a given set of parameters.
variable | The name of the variable in . |
parameters | The parameter set to pass to the function. |
Exception | If an error occured. |
Definition at line 138 of file Functions.h.
References bpp::FunctionInterface::setParameters().
|
pure virtualinherited |
Tell if derivatives must be computed.
yn | yes/no |
Implemented in bpp::FirstOrderDerivableWrapper, bpp::ReparametrizationDerivableFirstOrderWrapper, bpp::AbstractNumericalDerivative, and bpp::AbstractHmmLikelihood.
Referenced by bpp::ConjugateGradientMultiDimensions::doInit(), bpp::BfgsMultiDimensions::doInit(), bpp::ConjugateGradientMultiDimensions::doStep(), and bpp::BfgsMultiDimensions::doStep().
|
pure virtualinherited |
Tell if derivatives must be computed.
Implemented in bpp::FirstOrderDerivableWrapper, bpp::ReparametrizationDerivableFirstOrderWrapper, bpp::AbstractNumericalDerivative, and bpp::AbstractHmmLikelihood.
|
inlinevirtualinherited |
Tell if derivatives must be computed.
yn | yes/no |
Implements bpp::FirstOrderDerivable.
Definition at line 149 of file ReparametrizationFunctionWrapper.h.
References bpp::ReparametrizationDerivableFirstOrderWrapper::enableFirstOrderDerivatives(), and bpp::ReparametrizationFunctionWrapper::function_.
Referenced by bpp::ReparametrizationDerivableFirstOrderWrapper::enableFirstOrderDerivatives().
|
inlinevirtualinherited |
Tell if derivatives must be computed.
Implements bpp::FirstOrderDerivable.
Definition at line 151 of file ReparametrizationFunctionWrapper.h.
References bpp::ReparametrizationDerivableFirstOrderWrapper::enableFirstOrderDerivatives(), and bpp::ReparametrizationFunctionWrapper::function_.
Referenced by bpp::ReparametrizationDerivableFirstOrderWrapper::enableFirstOrderDerivatives().
|
inlinevirtual |
Tell if derivatives must be computed.
yn | yes/no |
Implements bpp::SecondOrderDerivable.
Definition at line 203 of file ReparametrizationFunctionWrapper.h.
References enableSecondOrderDerivatives(), and bpp::ReparametrizationFunctionWrapper::function_.
Referenced by enableSecondOrderDerivatives().
|
inlinevirtual |
Tell if derivatives must be computed.
Implements bpp::SecondOrderDerivable.
Definition at line 205 of file ReparametrizationFunctionWrapper.h.
References enableSecondOrderDerivatives(), and bpp::ReparametrizationFunctionWrapper::function_.
Referenced by enableSecondOrderDerivatives().
|
inlinevirtualinherited |
Get the value of the function according to a given set of parameters.
parameters | The parameter set to pass to the function. |
Exception | If an error occured. |
Reimplemented in bpp::InfinityFunctionWrapper, bpp::FunctionWrapper, and bpp::AbstractNumericalDerivative.
Definition at line 82 of file Functions.h.
References bpp::FunctionInterface::getValue(), and bpp::FunctionInterface::setParameters().
Referenced by bpp::NumTools::uniRoot().
|
virtualinherited |
Notify the class when one or several parameters have changed.
parameters | A ParameterList object with parameters that changed. |
Reimplemented from bpp::AbstractParametrizable.
Definition at line 141 of file ReparametrizationFunctionWrapper.cpp.
References bpp::ApplicationTools::error, and bpp::Parameter::setValue().
Referenced by bpp::ReparametrizationFunctionWrapper::getValue().
|
inlinevirtualinherited |
Definition at line 82 of file ReparametrizationFunctionWrapper.h.
References bpp::ReparametrizationFunctionWrapper::function_.
|
inlinevirtualinherited |
Definition at line 84 of file ReparametrizationFunctionWrapper.h.
References bpp::ReparametrizationFunctionWrapper::function_.
|
pure virtualinherited |
Get the derivative of the function at the current point.
variable | The name of the variable in . |
Exception | If no point is specified or if an error occured. |
Implemented in bpp::FirstOrderDerivableWrapper, bpp::ReparametrizationDerivableFirstOrderWrapper, bpp::AbstractNumericalDerivative, and bpp::AbstractHmmLikelihood.
Referenced by bpp::NewtonOneDimension::doStep(), bpp::AbstractHmmLikelihood::enableFirstOrderDerivatives(), bpp::ConjugateGradientMultiDimensions::getGradient(), and bpp::BfgsMultiDimensions::getGradient().
|
inlinevirtualinherited |
Get the derivative of the function at the current point.
variable | The name of the variable in . |
Exception | If no point is specified or if an error occured. |
Implements bpp::FirstOrderDerivable.
Definition at line 153 of file ReparametrizationFunctionWrapper.h.
References bpp::ReparametrizationFunctionWrapper::function_, and bpp::AbstractParametrizable::parameter().
|
inlinevirtualinherited |
Definition at line 86 of file ReparametrizationFunctionWrapper.h.
References bpp::ReparametrizationFunctionWrapper::function_.
|
inlinevirtualinherited |
Definition at line 88 of file ReparametrizationFunctionWrapper.h.
References bpp::ReparametrizationFunctionWrapper::function_.
|
inlineoverridevirtualinherited |
Implements bpp::Parametrizable.
Definition at line 99 of file AbstractParametrizable.h.
References bpp::AbstractParametrizable::getParameterNameWithoutNamespace(), and bpp::AbstractParametrizable::prefix_.
Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::MixtureOfDiscreteDistributions::MixtureOfDiscreteDistributions(), bpp::Simplex::setFrequencies(), and bpp::AbstractParameterAliasable::setNamespace().
|
pure virtualinherited |
Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.
Referenced by bpp::Parametrizable::~Parametrizable().
|
inlineoverridevirtualinherited |
Get the number of parameters.
Implements bpp::Parametrizable.
Definition at line 95 of file AbstractParametrizable.h.
References bpp::AbstractParametrizable::setNamespace(), and bpp::ParameterList::size().
Referenced by bpp::AbstractParameterAliasable::AbstractParameterAliasable(), bpp::AbstractParameterAliasable::aliasParameters(), bpp::SimpleDiscreteDistribution::fireParameterChanged(), bpp::AbstractParameterAliasable::operator=(), bpp::ConstantDistribution::restrictToConstraint(), and bpp::SimpleDiscreteDistribution::restrictToConstraint().
|
pure virtualinherited |
Get the number of parameters.
Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, bpp::AbstractParametrizable, and bpp::DirectionFunction.
Referenced by bpp::BppODiscreteDistributionFormat::writeDiscreteDistribution(), and bpp::Parametrizable::~Parametrizable().
|
inlineinherited |
Definition at line 48 of file AbstractParametrizable.h.
References bpp::ParameterList::getParameter().
Referenced by bpp::AbstractParameterAliasable::AbstractParameterAliasable(), bpp::AbstractParameterAliasable::operator=(), and bpp::AbstractParameterAliasable::unaliasParameters().
|
inlineprotectedinherited |
Definition at line 211 of file AbstractParametrizable.h.
References bpp::ParameterList::getParameter().
|
inlineprotectedinherited |
Definition at line 216 of file AbstractParametrizable.h.
References bpp::ParameterList::getParameter().
|
inlineprotectedinherited |
name | The name of the parameter. |
ParameterNotFoundException | If no parameter with that name is found in the list. |
Definition at line 164 of file AbstractParametrizable.h.
References bpp::AbstractParametrizable::hasParameter(), and bpp::ParameterList::parameter().
Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::AbstractParametrizable::getParameterWithNamespace_(), bpp::AbstractParametrizable::removeConstraint(), bpp::ConstantDistribution::restrictToConstraint(), bpp::TruncatedExponentialDiscreteDistribution::restrictToConstraint(), bpp::SimpleDiscreteDistribution::restrictToConstraint(), bpp::InvariantMixedDiscreteDistribution::restrictToConstraint(), bpp::AbstractParametrizable::setConstraint(), and bpp::AbstractParameterAliasable::unaliasParameters().
|
inlineprotectedinherited |
Definition at line 190 of file AbstractParametrizable.h.
References bpp::ParameterList::size().
|
inlineprotectedinherited |
Definition at line 197 of file AbstractParametrizable.h.
References bpp::ParameterList::size().
|
overridevirtualinherited |
Resolves a parameter name according to the current namespace.
Implements bpp::Parametrizable.
Definition at line 28 of file AbstractParametrizable.cpp.
References bpp::TextTools::startsWith().
Referenced by bpp::AbstractParameterAliasable::AbstractParameterAliasable(), bpp::AbstractParametrizable::getNamespace(), and bpp::AbstractParameterAliasable::operator=().
|
pure virtualinherited |
Resolves a parameter name according to the current namespace.
Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.
Referenced by bpp::BppODiscreteDistributionFormat::readDiscreteDistribution(), bpp::BppOParametrizableFormat::write(), and bpp::Parametrizable::~Parametrizable().
|
inlineoverridevirtualinherited |
Get all parameters available.
Implements bpp::Parametrizable.
Definition at line 41 of file AbstractParametrizable.h.
References bpp::AbstractParametrizable::parameters_.
Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::FullHmmTransitionMatrix::FullHmmTransitionMatrix(), bpp::MixtureOfDiscreteDistributions::MixtureOfDiscreteDistributions(), and bpp::ParametrizableCollection< N >::removeObject().
|
pure virtualinherited |
Get all parameters available.
Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, bpp::DirectionFunction, and bpp::AbstractParametrizable.
Referenced by bpp::ParameterAliasableAdapter::getIndependentParameters(), bpp::BppODiscreteDistributionFormat::readDiscreteDistribution(), bpp::BppOParametrizableFormat::write(), and bpp::Parametrizable::~Parametrizable().
|
protectedpure virtualinherited |
Get all parameters available.
Implemented in bpp::FunctionWrapper, bpp::AbstractParametrizable, and bpp::DirectionFunction.
Referenced by bpp::Parametrizable::~Parametrizable().
|
inlineoverrideprotectedvirtualinherited |
Get all parameters available.
Implements bpp::Parametrizable.
Definition at line 205 of file AbstractParametrizable.h.
References bpp::AbstractParametrizable::parameters_.
Referenced by bpp::AbstractParameterAliasable::AbstractParameterAliasable(), bpp::AbstractParameterAliasable::aliasParameters(), and bpp::AbstractParameterAliasable::operator=().
|
inlineoverridevirtualinherited |
Get the value for parameter of name 'name'.
name | The name of the parameter. |
Implements bpp::Parametrizable.
Definition at line 53 of file AbstractParametrizable.h.
References bpp::Parameter::getValue(), and bpp::AbstractParametrizable::parameter().
Referenced by bpp::DirichletDiscreteDistribution::applyParameters(), bpp::ConstantDistribution::fireParameterChanged(), bpp::GaussianDiscreteDistribution::fireParameterChanged(), bpp::BetaDiscreteDistribution::fireParameterChanged(), bpp::ExponentialDiscreteDistribution::fireParameterChanged(), bpp::InvariantMixedDiscreteDistribution::fireParameterChanged(), bpp::GammaDiscreteDistribution::fireParameterChanged(), bpp::AutoCorrelationTransitionMatrix::fireParameterChanged(), bpp::TruncatedExponentialDiscreteDistribution::fireParameterChanged(), bpp::SimpleDiscreteDistribution::fireParameterChanged(), bpp::MixtureOfDiscreteDistributions::fireParameterChanged(), bpp::Simplex::fireParameterChanged(), bpp::BetaDiscreteDistribution::randC(), bpp::ExponentialDiscreteDistribution::randC(), bpp::GammaDiscreteDistribution::randC(), bpp::TruncatedExponentialDiscreteDistribution::randC(), and bpp::ConstantDistribution::restrictToConstraint().
|
pure virtualinherited |
Get the value for parameter of name 'name'.
name | The name of the parameter. |
Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.
Referenced by bpp::BppODiscreteDistributionFormat::readDiscreteDistribution(), and bpp::Parametrizable::~Parametrizable().
|
inlineprotectedinherited |
name | The name of the parameter, including its namespace. |
ParameterNotFoundException | If no parameter with that name is found in the list. |
Definition at line 176 of file AbstractParametrizable.h.
References bpp::AbstractParametrizable::getParameter_().
|
inlineprotectedinherited |
name | The name of the parameter, including its namespace. |
ParameterNotFoundException | If no parameter with that name is found in the list. |
Definition at line 185 of file AbstractParametrizable.h.
References bpp::AbstractParametrizable::parameter().
|
inlinevirtual |
Get the second order derivative of the function at the current point.
variable | The name of the variable in . |
Exception | If no point is specified or if an error occured. |
Implements bpp::SecondOrderDerivable.
Definition at line 207 of file ReparametrizationFunctionWrapper.h.
References bpp::ReparametrizationFunctionWrapper::function_, and bpp::AbstractParametrizable::parameter().
|
inlinevirtual |
Get the value of the cross derivative of the function according to a given set of parameters.
variable1 | The name of the variable in . |
variable2 | The name of the variable in . |
Exception | If an error occured. |
Implements bpp::SecondOrderDerivable.
Definition at line 215 of file ReparametrizationFunctionWrapper.h.
References bpp::ReparametrizationFunctionWrapper::function_, and bpp::AbstractParametrizable::parameter().
|
pure virtualinherited |
Get the value of the function at the current point.
Exception | If no point is specified or if an error occured. |
Implemented in bpp::TestFunction, bpp::InfinityFunctionWrapper, bpp::FunctionWrapper, bpp::LogsumHmmLikelihood, bpp::RescaledHmmLikelihood, bpp::LowMemoryRescaledHmmLikelihood, bpp::ReparametrizationFunctionWrapper, bpp::ThreePointsNumericalDerivative, bpp::FivePointsNumericalDerivative, bpp::TwoPointsNumericalDerivative, and bpp::DirectionFunction.
Referenced by bpp::FunctionInterface::f(), bpp::AbstractNumericalDerivative::f(), bpp::InfinityFunctionWrapper::f(), and bpp::FunctionInterface::~FunctionInterface().
|
inlinevirtualinherited |
Get the value of the function at the current point.
Exception | If no point is specified or if an error occured. |
Implements bpp::FunctionInterface.
Definition at line 99 of file ReparametrizationFunctionWrapper.h.
References bpp::ReparametrizationFunctionWrapper::fireParameterChanged().
|
pure virtualinherited |
Tell if there is a parameter with specified name.
name | The name of the parameter to look for. |
Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.
Referenced by bpp::Parametrizable::~Parametrizable().
|
inlineoverridevirtualinherited |
Tell if there is a parameter with specified name.
name | The name of the parameter to look for. |
Implements bpp::Parametrizable.
Definition at line 39 of file AbstractParametrizable.h.
References bpp::ParameterList::hasParameter().
Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::GammaDiscreteDistribution::fireParameterChanged(), bpp::AbstractParametrizable::getParameter_(), and bpp::AbstractParameterAliasable::unaliasParameters().
|
inlineprotectedvirtualinherited |
Reimplemented in bpp::AbstractParameterAliasable.
Definition at line 132 of file AbstractParametrizable.h.
References bpp::ParameterList::includeParameters().
Referenced by bpp::AbstractParameterAliasable::includeParameters_().
|
private |
|
inlineoverridevirtualinherited |
Update the parameters from parameters.
Only common parameters with parameters will be updated.
parameters | A list of parameters. |
ConstraintException | If a value in parameters does not match the constraint in the corresponding parameter in the list. |
Implements bpp::Parametrizable.
Definition at line 76 of file AbstractParametrizable.h.
References bpp::AbstractParametrizable::fireParameterChanged(), bpp::ParameterList::matchParametersValues(), and bpp::ParameterList::shareSubList().
Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::Simplex::setFrequencies(), bpp::ReparametrizationFunctionWrapper::setParameters(), and bpp::FullHmmTransitionMatrix::setTransitionProbabilities().
|
pure virtualinherited |
Update the parameters from parameters.
Only common parameters with parameters will be updated.
parameters | A list of parameters. |
ConstraintException | If a value in parameters does not match the constraint in the corresponding parameter in the list. |
Implemented in bpp::InfinityFunctionWrapper, bpp::FunctionWrapper, bpp::AbstractNumericalDerivative, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.
Referenced by bpp::BppODiscreteDistributionFormat::initialize_(), bpp::TestFunction::setParameters(), and bpp::Parametrizable::~Parametrizable().
|
inlineoverridevirtualinherited |
Get the parameter with specified name.
name | The name of the parameter to look for. |
ParameterNotFoundException | if no parameter with this name is found. |
Implements bpp::Parametrizable.
Definition at line 43 of file AbstractParametrizable.h.
References bpp::ParameterList::parameter().
Referenced by bpp::AbstractParameterAliasable::getAliasedParameters(), bpp::ReparametrizationDerivableFirstOrderWrapper::getFirstOrderDerivative(), bpp::AbstractParameterAliasable::getFromParameters(), bpp::AbstractParametrizable::getParameterValue(), bpp::AbstractParametrizable::getParameterWithNamespace_(), and getSecondOrderDerivative().
|
pure virtualinherited |
Get the parameter with specified name.
name | The name of the parameter to look for. |
ParameterNotFoundException | if no parameter with this name is found. |
Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.
Referenced by bpp::TestFunction::getValue(), and bpp::Parametrizable::~Parametrizable().
|
inlineoverridevirtualinherited |
Remove the constraint associated with one parameter, if any.
name | The name of the parameter to look for. |
ParameterNotFoundException | if no parameter with this name is found. |
Implements bpp::Parametrizable.
Definition at line 85 of file AbstractParametrizable.h.
References bpp::AbstractParametrizable::getParameter_(), and bpp::Parameter::removeConstraint().
|
pure virtualinherited |
Remove the constraint associated with one parameter, if any.
name | The name of the parameter to look for. |
ParameterNotFoundException | if no parameter with this name is found. |
Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.
Referenced by bpp::Parametrizable::~Parametrizable().
|
inlineprotectedinherited |
Definition at line 154 of file AbstractParametrizable.h.
References bpp::ParameterList::reset().
Referenced by bpp::AbstractParameterAliasable::resetParameters_().
|
inlineoverridevirtualinherited |
Set the parameters values to be equals to those of parameters.
The list must contain exactly the same parameters (ie same names) than the parameters available.
parameters | A list with all parameters. |
ParameterNotFoundException | If a some parameter in the list is not in params. |
ConstraintException | If a value in parameters does not match the constraint in the corresponding parameter in the list. |
Implements bpp::Parametrizable.
Definition at line 58 of file AbstractParametrizable.h.
References bpp::AbstractParametrizable::fireParameterChanged(), and bpp::ParameterList::setAllParametersValues().
|
pure virtualinherited |
Set the parameters values to be equals to those of parameters.
The list must contain exactly the same parameters (ie same names) than the parameters available.
parameters | A list with all parameters. |
ParameterNotFoundException | If a some parameter in the list is not in params. |
ConstraintException | If a value in parameters does not match the constraint in the corresponding parameter in the list. |
Implemented in bpp::InfinityFunctionWrapper, bpp::FunctionWrapper, bpp::AbstractNumericalDerivative, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.
Referenced by bpp::Parametrizable::~Parametrizable().
|
inlineoverridevirtualinherited |
Set/Change the constraint associated with one parameter.
name | The name of the parameter to look for. |
constraint | A pointer to the constraint (may be null) |
ParameterNotFoundException | if no parameter with this name is found. |
Implements bpp::Parametrizable.
Definition at line 90 of file AbstractParametrizable.h.
References bpp::AbstractParametrizable::getParameter_(), and bpp::Parameter::setConstraint().
Referenced by bpp::SimpleDiscreteDistribution::restrictToConstraint().
|
pure virtualinherited |
Set/Change the constraint associated with one parameter.
name | The name of the parameter to look for. |
constraint | A pointer to the constraint (may be null) |
ParameterNotFoundException | if no parameter with this name is found. |
Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.
Referenced by bpp::Parametrizable::~Parametrizable().
|
overridevirtualinherited |
Set the namespace for the parameter names.
prefix | The 'namespace', that is a prefix to add to all parameter names. If parameter names are already prefixed, the new prefix will be used instead. |
Implements bpp::Parametrizable.
Reimplemented in bpp::LogsumHmmLikelihood, bpp::RescaledHmmLikelihood, bpp::LowMemoryRescaledHmmLikelihood, bpp::MixtureOfDiscreteDistributions, and bpp::InvariantMixedDiscreteDistribution.
Definition at line 10 of file AbstractParametrizable.cpp.
References bpp::TextTools::startsWith().
Referenced by bpp::AbstractParametrizable::getNumberOfParameters(), bpp::AbstractParameterAliasable::setNamespace(), bpp::LowMemoryRescaledHmmLikelihood::setNamespace(), bpp::LogsumHmmLikelihood::setNamespace(), and bpp::RescaledHmmLikelihood::setNamespace().
|
pure virtualinherited |
Set the namespace for the parameter names.
prefix | The 'namespace', that is a prefix to add to all parameter names. If parameter names are already prefixed, the new prefix will be used instead. |
Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, bpp::LogsumHmmLikelihood, bpp::RescaledHmmLikelihood, bpp::LowMemoryRescaledHmmLikelihood, bpp::AbstractParameterAliasable, bpp::MixtureOfDiscreteDistributions, bpp::AbstractParametrizable, and bpp::InvariantMixedDiscreteDistribution.
Referenced by bpp::Parametrizable::~Parametrizable().
|
pure virtualinherited |
Set the point where the function must be computed.
parameters | The parameter set to pass to the function. |
Implemented in bpp::TestFunction, bpp::InfinityFunctionWrapper, bpp::FunctionWrapper, bpp::AbstractNumericalDerivative, bpp::LogsumHmmLikelihood, bpp::RescaledHmmLikelihood, bpp::LowMemoryRescaledHmmLikelihood, bpp::ReparametrizationFunctionWrapper, and bpp::DirectionFunction.
Referenced by bpp::SecondOrderDerivable::d2f(), bpp::InfinityDerivableSecondOrderWrapper::d2f(), bpp::FirstOrderDerivable::df(), bpp::InfinityDerivableFirstOrderWrapper::df(), bpp::FunctionInterface::f(), bpp::AbstractNumericalDerivative::f(), bpp::InfinityFunctionWrapper::f(), and bpp::FunctionInterface::~FunctionInterface().
|
inlinevirtualinherited |
Set the point where the function must be computed.
parameters | The parameter set to pass to the function. |
Implements bpp::FunctionInterface.
Definition at line 90 of file ReparametrizationFunctionWrapper.h.
References bpp::ParameterList::createSubList(), bpp::ParameterList::getParameterNames(), and bpp::AbstractParametrizable::matchParametersValues().
|
inlineoverridevirtualinherited |
Update the parameters from parameters.
parameters must be a subset of all parameters available.
parameters | A list containing all parameters to update. |
ParameterNotFoundException | If a some parameter in params is not in the list. |
ConstraintException | If a value in parameters does not match the constraint in the corresponding parameter in the list. |
Implements bpp::Parametrizable.
Definition at line 70 of file AbstractParametrizable.h.
References bpp::AbstractParametrizable::fireParameterChanged(), and bpp::ParameterList::setParametersValues().
Referenced by bpp::LowMemoryRescaledHmmLikelihood::setParameters(), bpp::RescaledHmmLikelihood::setParameters(), and bpp::LogsumHmmLikelihood::setParameters().
|
pure virtualinherited |
Update the parameters from parameters.
parameters must be a subset of all parameters available.
parameters | A list containing all parameters to update. |
ParameterNotFoundException | If a some parameter in params is not in the list. |
ConstraintException | If a value in parameters does not match the constraint in the corresponding parameter in the list. |
Implemented in bpp::InfinityFunctionWrapper, bpp::FunctionWrapper, bpp::AbstractNumericalDerivative, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.
Referenced by bpp::Parametrizable::~Parametrizable().
|
inlineoverridevirtualinherited |
Set the value of parameter with name name to be equal to value.
name | the name of the parameter to set. |
value | The value of the parameter. |
ParameterNotFoundException | If no parameter in the list has the name name. |
ConstraintException | If value does not match the constraint associated to parameter name. |
Implements bpp::Parametrizable.
Definition at line 64 of file AbstractParametrizable.h.
References bpp::ParameterList::createSubList(), bpp::AbstractParametrizable::fireParameterChanged(), and bpp::ParameterList::setParameterValue().
|
pure virtualinherited |
Set the value of parameter with name name to be equal to value.
name | the name of the parameter to set. |
value | The value of the parameter. |
ParameterNotFoundException | If no parameter in the list has the name name. |
ConstraintException | If value does not match the constraint associated to parameter name. |
Implemented in bpp::InfinityFunctionWrapper, bpp::FunctionWrapper, bpp::AbstractNumericalDerivative, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.
Referenced by bpp::Parametrizable::~Parametrizable().
|
inlineprotectedvirtualinherited |
Reimplemented in bpp::AbstractParameterAliasable.
Definition at line 122 of file AbstractParametrizable.h.
References bpp::ParameterList::shareParameter().
Referenced by bpp::AbstractParameterAliasable::shareParameter_().
|
inlineprotectedvirtualinherited |
Reimplemented in bpp::AbstractParameterAliasable.
Definition at line 127 of file AbstractParametrizable.h.
References bpp::ParameterList::shareParameters().
Referenced by bpp::AbstractParameterAliasable::shareParameters_().
|
protectedinherited |
Definition at line 26 of file ReparametrizationFunctionWrapper.h.
Referenced by bpp::ReparametrizationDerivableFirstOrderWrapper::enableFirstOrderDerivatives(), enableSecondOrderDerivatives(), bpp::ReparametrizationFunctionWrapper::function(), bpp::ReparametrizationDerivableFirstOrderWrapper::getFirstOrderDerivative(), bpp::ReparametrizationFunctionWrapper::getFunction(), getSecondOrderDerivative(), and bpp::ReparametrizationFunctionWrapper::operator=().
|
protectedinherited |
Definition at line 27 of file ReparametrizationFunctionWrapper.h.
Referenced by bpp::ReparametrizationFunctionWrapper::operator=().