bpp::InfinityDerivableSecondOrderWrapper Class Reference

Wrapper class for optimization under constraints. More...

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

Inheritance diagram for bpp::InfinityDerivableSecondOrderWrapper:

Collaboration diagram for bpp::InfinityDerivableSecondOrderWrapper:

Public Member Functions
	InfinityDerivableSecondOrderWrapper (DerivableFirstOrder *function)
virtual	~InfinityDerivableSecondOrderWrapper ()
InfinityDerivableSecondOrderWrapper *	clone () const
	Create a copy of this object and send a pointer to it. More...
double	getSecondOrderDerivative (const std::string &variable) const throw (Exception)
double	d2f (const std::string &variable, const ParameterList &parameters) throw (Exception)
double	getSecondOrderDerivative (const std::string &variable1, const std::string &variable2) const throw (Exception)
double	d2f (const std::string &variable1, const std::string &variable2, const ParameterList &parameters) throw (Exception)
double	getFirstOrderDerivative (const std::string &variable) const throw (Exception)
double	df (const std::string &variable, const ParameterList &parameters) throw (Exception)
void	setParameters (const ParameterList &parameters) throw (ParameterNotFoundException, ConstraintException)
	Set the point where the function must be computed. More...
double	getValue () const throw (Exception)
	Get the value of the function at the current point. More...
double	f (const ParameterList &parameters) throw (Exception)
	Get the value of the function according to a given set of parameters. More...
void	setAllParametersValues (const ParameterList &parameters) throw (ParameterNotFoundException, ConstraintException)
	Set the parameters values to be equals to those of parameters. More...
void	setParameterValue (const std::string &name, double value) throw (ParameterNotFoundException, ConstraintException)
	Set the value of parameter with name name to be equal to value. More...
void	setParametersValues (const ParameterList &parameters) throw (ParameterNotFoundException, ConstraintException)
	Update the parameters from parameters. More...
bool	matchParametersValues (const ParameterList &parameters) throw (ConstraintException)
	Update the parameters from parameters. More...
bool	hasParameter (const std::string &name) const
	Tell if there is a parameter with specified name. More...
const ParameterList &	getParameters () const throw (Exception)
	Get all parameters available. More...
const Parameter &	getParameter (const std::string &name) const throw (ParameterNotFoundException)
	Get the parameter with specified name. More...
double	getParameterValue (const std::string &name) const throw (ParameterNotFoundException)
	Get the value for parameter of name 'name'. More...
size_t	getNumberOfParameters () const
	Get the number of parameters. More...
void	setNamespace (const std::string &prefix)
	Set the namespace for the parameter names. More...
std::string	getNamespace () const
std::string	getParameterNameWithoutNamespace (const std::string &name) const
	Resolves a parameter name according to the current namespace. More...

Protected Attributes
bool	constraintMatch_
Function *	function_

Detailed Description

Wrapper class for optimization under constraints.

Catch any ConstraintException thrown and send +inf.

Definition at line 581 of file Functions.h.

Constructor & Destructor Documentation

InfinityDerivableSecondOrderWrapper()

bpp::InfinityDerivableSecondOrderWrapper::InfinityDerivableSecondOrderWrapper ( DerivableFirstOrder *  function )

inline

Definition at line 585 of file Functions.h.

Referenced by clone().

~InfinityDerivableSecondOrderWrapper()

virtual bpp::InfinityDerivableSecondOrderWrapper::~InfinityDerivableSecondOrderWrapper ( )

inlinevirtual

Definition at line 588 of file Functions.h.

Member Function Documentation

clone()

InfinityDerivableSecondOrderWrapper* bpp::InfinityDerivableSecondOrderWrapper::clone ( ) const

inlinevirtual

Create a copy of this object and send a pointer to it.

Returns

A pointer toward the copy object.

Reimplemented from bpp::InfinityDerivableFirstOrderWrapper.

Definition at line 593 of file Functions.h.

References InfinityDerivableSecondOrderWrapper().

d2f() [1/2]

double bpp::InfinityDerivableSecondOrderWrapper::d2f ( const std::string &  variable, const ParameterList &  parameters  ) throw ( Exception )

inline

Definition at line 603 of file Functions.h.

References getSecondOrderDerivative(), and bpp::InfinityFunctionWrapper::setParameters().

d2f() [2/2]

double bpp::InfinityDerivableSecondOrderWrapper::d2f ( const std::string &  variable1, const std::string &  variable2, const ParameterList &  parameters  ) throw ( Exception )

inline

Definition at line 614 of file Functions.h.

References getSecondOrderDerivative(), and bpp::InfinityFunctionWrapper::setParameters().

df()

double bpp::InfinityDerivableFirstOrderWrapper::df ( const std::string &  variable, const ParameterList &  parameters  ) throw ( Exception )

inlineinherited

Definition at line 569 of file Functions.h.

References bpp::InfinityDerivableFirstOrderWrapper::getFirstOrderDerivative(), and bpp::InfinityFunctionWrapper::setParameters().

f()

double bpp::InfinityFunctionWrapper::f ( const ParameterList &  parameters ) throw ( Exception )

inlinevirtualinherited

Get the value of the function according to a given set of parameters.

Parameters

parameters

The parameter set to pass to the function.

Returns

The value of the function with the given parameter set.

Exceptions

Exception

If an error occured.

Reimplemented from bpp::FunctionWrapper.

Definition at line 478 of file Functions.h.

References bpp::InfinityFunctionWrapper::getValue(), and bpp::InfinityFunctionWrapper::setParameters().

getFirstOrderDerivative()

double bpp::InfinityDerivableFirstOrderWrapper::getFirstOrderDerivative ( const std::string &  variable ) const throw ( Exception )

inlineinherited

Definition at line 564 of file Functions.h.

References bpp::InfinityFunctionWrapper::constraintMatch_, and bpp::FunctionWrapper::function_.

Referenced by bpp::InfinityDerivableFirstOrderWrapper::df().

getNamespace()

std::string bpp::FunctionWrapper::getNamespace ( ) const

inlinevirtualinherited

Returns

The current namespace used. This is an empty string if no namespace is currently defined.

Implements bpp::Parametrizable.

Definition at line 360 of file Functions.h.

References bpp::FunctionWrapper::function_, and bpp::Parametrizable::getNamespace().

getNumberOfParameters()

size_t bpp::FunctionWrapper::getNumberOfParameters ( ) const

inlinevirtualinherited

Get the number of parameters.

See also

getNumberOfIndependentParameters If some parameters are aliased.

Returns

The number of parameters.

Implements bpp::Parametrizable.

Definition at line 350 of file Functions.h.

References bpp::FunctionWrapper::function_, and bpp::Parametrizable::getNumberOfParameters().

getParameter()

const Parameter& bpp::FunctionWrapper::getParameter ( const std::string &  name ) const throw ( ParameterNotFoundException )

inlinevirtualinherited

Get the parameter with specified name.

Parameters

name	The name of the parameter to look for.

Returns

The parameter with given name.

Exceptions

ParameterNotFoundException

if no parameter with this name is found.

Implements bpp::Parametrizable.

Definition at line 306 of file Functions.h.

References bpp::FunctionWrapper::function_, and bpp::Parametrizable::getParameter().

getParameterNameWithoutNamespace()

std::string bpp::FunctionWrapper::getParameterNameWithoutNamespace ( const std::string &  name ) const

inlinevirtualinherited

Resolves a parameter name according to the current namespace.

Returns

The parameter name without the namespace prefix, if any.

Implements bpp::Parametrizable.

Definition at line 365 of file Functions.h.

References bpp::FunctionWrapper::function_, and bpp::Parametrizable::getParameterNameWithoutNamespace().

getParameters()

const ParameterList& bpp::FunctionWrapper::getParameters ( ) const throw ( Exception )

inlinevirtualinherited

Get all parameters available.

See also

getIndependentParameters if some parameters are aliased.

Returns

A list with all parameters available.

Implements bpp::Parametrizable.

Definition at line 301 of file Functions.h.

References bpp::FunctionWrapper::function_, and bpp::Parametrizable::getParameters().

getParameterValue()

double bpp::FunctionWrapper::getParameterValue ( const std::string &  name ) const throw ( ParameterNotFoundException )

inlinevirtualinherited

Get the value for parameter of name 'name'.

Parameters

name	The name of the parameter.

Returns

the value of parameter name.

Implements bpp::Parametrizable.

Definition at line 321 of file Functions.h.

References bpp::FunctionWrapper::function_, and bpp::Parametrizable::getParameterValue().

getSecondOrderDerivative() [1/2]

double bpp::InfinityDerivableSecondOrderWrapper::getSecondOrderDerivative ( const std::string &  variable ) const throw ( Exception )

inline

Definition at line 598 of file Functions.h.

References bpp::InfinityFunctionWrapper::constraintMatch_, and bpp::FunctionWrapper::function_.

Referenced by d2f(), and getSecondOrderDerivative().

getSecondOrderDerivative() [2/2]

double bpp::InfinityDerivableSecondOrderWrapper::getSecondOrderDerivative ( const std::string &  variable1, const std::string &  variable2  ) const throw ( Exception )

inline

Definition at line 609 of file Functions.h.

References bpp::InfinityFunctionWrapper::constraintMatch_, bpp::FunctionWrapper::function_, and getSecondOrderDerivative().

getValue()

double bpp::InfinityFunctionWrapper::getValue ( ) const throw ( Exception )

inlinevirtualinherited

Get the value of the function at the current point.

Returns

The value of the function.

Exceptions

Exception

If no point is specified or if an error occured.

Reimplemented from bpp::FunctionWrapper.

Definition at line 473 of file Functions.h.

References bpp::InfinityFunctionWrapper::constraintMatch_, bpp::FunctionWrapper::function_, and bpp::Function::getValue().

Referenced by bpp::InfinityFunctionWrapper::f().

hasParameter()

bool bpp::FunctionWrapper::hasParameter ( const std::string &  name ) const

inlinevirtualinherited

Tell if there is a parameter with specified name.

Parameters

name	The name of the parameter to look for.

Returns

y/n.

Implements bpp::Parametrizable.

Definition at line 290 of file Functions.h.

References bpp::FunctionWrapper::function_, and bpp::Parametrizable::hasParameter().

matchParametersValues()

bool bpp::InfinityFunctionWrapper::matchParametersValues ( const ParameterList &  parameters ) throw ( ConstraintException )

inlinevirtualinherited

Update the parameters from parameters.

Only common parameters with parameters will be updated.

Parameters

parameters

A list of parameters.

Returns

True if at least one parameter value has been changed.

Exceptions

ConstraintException

If a value in parameters does not match the constraint in the corresponding parameter in the list.

Reimplemented from bpp::FunctionWrapper.

Definition at line 526 of file Functions.h.

References bpp::InfinityFunctionWrapper::constraintMatch_, bpp::FunctionWrapper::function_, and bpp::Parametrizable::matchParametersValues().

setAllParametersValues()

void bpp::InfinityFunctionWrapper::setAllParametersValues ( const ParameterList &  parameters ) throw ( ParameterNotFoundException, ConstraintException )

inlinevirtualinherited

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

parameters

A list with all parameters.

Exceptions

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.

Reimplemented from bpp::FunctionWrapper.

Definition at line 484 of file Functions.h.

References bpp::InfinityFunctionWrapper::constraintMatch_, bpp::FunctionWrapper::function_, and bpp::Parametrizable::setAllParametersValues().

setNamespace()

void bpp::FunctionWrapper::setNamespace ( const std::string &  prefix )

inlinevirtualinherited

Set the namespace for the parameter names.

Parameters

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.

Definition at line 355 of file Functions.h.

References bpp::FunctionWrapper::function_, and bpp::Parametrizable::setNamespace().

setParameters()

void bpp::InfinityFunctionWrapper::setParameters ( const ParameterList &  parameters ) throw ( ParameterNotFoundException, ConstraintException )

inlinevirtualinherited

Set the point where the function must be computed.

Parameters

parameters

The parameter set to pass to the function.

Reimplemented from bpp::FunctionWrapper.

Definition at line 459 of file Functions.h.

References bpp::InfinityFunctionWrapper::constraintMatch_, bpp::FunctionWrapper::function_, and bpp::Function::setParameters().

Referenced by d2f(), bpp::InfinityDerivableFirstOrderWrapper::df(), and bpp::InfinityFunctionWrapper::f().

setParametersValues()

void bpp::InfinityFunctionWrapper::setParametersValues ( const ParameterList &  parameters ) throw ( ParameterNotFoundException, ConstraintException )

inlinevirtualinherited

Update the parameters from parameters.

parameters must be a subset of all parameters available.

Parameters

parameters

A list containing all parameters to update.

Exceptions

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.

Reimplemented from bpp::FunctionWrapper.

Definition at line 512 of file Functions.h.

References bpp::InfinityFunctionWrapper::constraintMatch_, bpp::FunctionWrapper::function_, and bpp::Parametrizable::setParametersValues().

setParameterValue()

void bpp::InfinityFunctionWrapper::setParameterValue ( const std::string &  name, double  value  ) throw ( ParameterNotFoundException, ConstraintException )

inlinevirtualinherited

Set the value of parameter with name name to be equal to value.

Parameters

name	the name of the parameter to set.
value	The value of the parameter.

Exceptions

ParameterNotFoundException	If no parameter in the list has the name name.
ConstraintException	If value does not match the constraint associated to parameter name.

Reimplemented from bpp::FunctionWrapper.

Definition at line 498 of file Functions.h.

References bpp::InfinityFunctionWrapper::constraintMatch_, bpp::FunctionWrapper::function_, and bpp::Parametrizable::setParameterValue().

Member Data Documentation

constraintMatch_

bool bpp::InfinityFunctionWrapper::constraintMatch_

mutableprotectedinherited

Definition at line 443 of file Functions.h.

Referenced by bpp::InfinityDerivableFirstOrderWrapper::getFirstOrderDerivative(), getSecondOrderDerivative(), bpp::InfinityFunctionWrapper::getValue(), bpp::InfinityFunctionWrapper::matchParametersValues(), bpp::InfinityFunctionWrapper::setAllParametersValues(), bpp::InfinityFunctionWrapper::setParameters(), bpp::InfinityFunctionWrapper::setParametersValues(), and bpp::InfinityFunctionWrapper::setParameterValue().

function_

Function* bpp::FunctionWrapper::function_

protectedinherited

Definition at line 278 of file Functions.h.

Referenced by bpp::DerivableFirstOrderWrapper::enableFirstOrderDerivatives(), bpp::DerivableSecondOrderWrapper::enableSecondOrderDerivatives(), bpp::FunctionWrapper::f(), bpp::DerivableFirstOrderWrapper::getFirstOrderDerivative(), bpp::InfinityDerivableFirstOrderWrapper::getFirstOrderDerivative(), bpp::FunctionWrapper::getNamespace(), bpp::FunctionWrapper::getNumberOfParameters(), bpp::FunctionWrapper::getParameter(), bpp::FunctionWrapper::getParameterNameWithoutNamespace(), bpp::FunctionWrapper::getParameters(), bpp::FunctionWrapper::getParameterValue(), bpp::DerivableSecondOrderWrapper::getSecondOrderDerivative(), getSecondOrderDerivative(), bpp::FunctionWrapper::getValue(), bpp::InfinityFunctionWrapper::getValue(), bpp::FunctionWrapper::hasParameter(), bpp::AbstractNumericalDerivative::matchParametersValues(), bpp::FunctionWrapper::matchParametersValues(), bpp::InfinityFunctionWrapper::matchParametersValues(), bpp::FunctionWrapper::operator=(), bpp::AbstractNumericalDerivative::setAllParametersValues(), bpp::FunctionWrapper::setAllParametersValues(), bpp::InfinityFunctionWrapper::setAllParametersValues(), bpp::FunctionWrapper::setNamespace(), bpp::AbstractNumericalDerivative::setParameters(), bpp::FunctionWrapper::setParameters(), bpp::InfinityFunctionWrapper::setParameters(), bpp::AbstractNumericalDerivative::setParametersValues(), bpp::FunctionWrapper::setParametersValues(), bpp::InfinityFunctionWrapper::setParametersValues(), bpp::AbstractNumericalDerivative::setParameterValue(), bpp::FunctionWrapper::setParameterValue(), and bpp::InfinityFunctionWrapper::setParameterValue().

---

The documentation for this class was generated from the following file:

• Bpp/Numeric/Function/Functions.h