Wrapper class for optimization under constraints. More...

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

Inheritance diagram for bpp::InfinityFunctionWrapper:

Collaboration diagram for bpp::InfinityFunctionWrapper:

Public Member Functions
	InfinityFunctionWrapper (std::shared_ptr< FunctionInterface > function)

virtual	~InfinityFunctionWrapper ()

InfinityFunctionWrapper *	clone () const override
	Create a copy of this object and send a pointer to it. More...

void	setParameters (const ParameterList &parameters) override
	Set the point where the function must be computed. More...

double	getValue () const override
	Get the value of the function at the current point. More...

double	f (const ParameterList &parameters) override
	Get the value of the function according to a given set of parameters. More...

void	setAllParametersValues (const ParameterList &parameters) 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 &parameters) override
	Update the parameters from parameters. More...

bool	matchParametersValues (const ParameterList &parameters) override
	Update the parameters from parameters. 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	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...

Protected Member Functions
ParameterList &	getParameters_ () override
	Get all parameters available. More...

Protected Attributes
bool	constraintMatch_

std::shared_ptr< FunctionInterface >	function_

Detailed Description

Wrapper class for optimization under constraints.

Catch any ConstraintException thrown and send +inf.

Definition at line 410 of file Functions.h.

Constructor & Destructor Documentation

◆ InfinityFunctionWrapper()

bpp::InfinityFunctionWrapper::InfinityFunctionWrapper ( std::shared_ptr< FunctionInterface > function )

inline

Definition at line 417 of file Functions.h.

◆ ~InfinityFunctionWrapper()

virtual bpp::InfinityFunctionWrapper::~InfinityFunctionWrapper ( )

inlinevirtual

Definition at line 420 of file Functions.h.

Member Function Documentation

◆ clone()

InfinityFunctionWrapper* bpp::InfinityFunctionWrapper::clone ( ) const

inlineoverridevirtual

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

Returns: A pointer toward the copy object.

Implements bpp::Clonable.

Reimplemented in bpp::InfinityDerivableSecondOrderWrapper, and bpp::InfinityDerivableFirstOrderWrapper.

Definition at line 422 of file Functions.h.

◆ f()

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

inlineoverridevirtual

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 443 of file Functions.h.

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

◆ getNamespace()

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

inlineoverridevirtualinherited

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

Implements bpp::Parametrizable.

Definition at line 322 of file Functions.h.

◆ getNumberOfParameters()

size_t bpp::FunctionWrapper::getNumberOfParameters ( ) const

inlineoverridevirtualinherited

Get the number of parameters.

See also: getNumberOfIndependentParameters If some parameters are aliased.

Returns: The number of parameters.

Implements bpp::Parametrizable.

Definition at line 312 of file Functions.h.

◆ getParameterNameWithoutNamespace()

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

inlineoverridevirtualinherited

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 327 of file Functions.h.

◆ getParameters()

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

inlineoverridevirtualinherited

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 257 of file Functions.h.

◆ getParameters_()

ParameterList& bpp::FunctionWrapper::getParameters_ ( )

inlineoverrideprotectedvirtualinherited

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 333 of file Functions.h.

◆ getParameterValue()

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

inlineoverridevirtualinherited

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 277 of file Functions.h.

◆ getValue()

double bpp::InfinityFunctionWrapper::getValue ( ) const

inlineoverridevirtual

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 438 of file Functions.h.

◆ hasParameter()

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

inlineoverridevirtualinherited

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 247 of file Functions.h.

◆ matchParametersValues()

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

inlineoverridevirtual

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 488 of file Functions.h.

◆ parameter()

const Parameter& bpp::FunctionWrapper::parameter ( const std::string & name ) const

inlineoverridevirtualinherited

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 262 of file Functions.h.

◆ removeConstraint()

void bpp::FunctionWrapper::removeConstraint ( const std::string & name )

inlineoverridevirtualinherited

Remove the constraint associated with one parameter, if any.

Parameters

name	The name of the parameter to look for.

Exceptions

ParameterNotFoundException if no parameter with this name is found.

Implements bpp::Parametrizable.

Definition at line 302 of file Functions.h.

◆ setAllParametersValues()

void bpp::InfinityFunctionWrapper::setAllParametersValues ( const ParameterList & parameters )

inlineoverridevirtual

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 449 of file Functions.h.

◆ setConstraint()

void bpp::FunctionWrapper::setConstraint	(	const std::string &	name,
		std::shared_ptr< ConstraintInterface >	constraint
	)

inlineoverridevirtualinherited

Set/Change the constraint associated with one parameter.

Parameters

name	The name of the parameter to look for.
constraint	A pointer to the constraint (may be null)

Exceptions

ParameterNotFoundException if no parameter with this name is found.

Implements bpp::Parametrizable.

Definition at line 307 of file Functions.h.

◆ setNamespace()

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

inlineoverridevirtualinherited

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 317 of file Functions.h.

◆ setParameters()

void bpp::InfinityFunctionWrapper::setParameters ( const ParameterList & parameters )

inlineoverridevirtual

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 425 of file Functions.h.

◆ setParametersValues()

void bpp::InfinityFunctionWrapper::setParametersValues ( const ParameterList & parameters )

inlineoverridevirtual

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 475 of file Functions.h.

◆ setParameterValue()

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

inlineoverridevirtual

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 462 of file Functions.h.

Member Data Documentation

◆ constraintMatch_

bool bpp::InfinityFunctionWrapper::constraintMatch_

mutableprotected

Definition at line 414 of file Functions.h.

◆ function_

std::shared_ptr<FunctionInterface> bpp::FunctionWrapper::function_

protectedinherited

Definition at line 235 of file Functions.h.

Referenced by bpp::FunctionWrapper::operator=().

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

Bpp/Numeric/Function/Functions.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ InfinityFunctionWrapper()

◆ ~InfinityFunctionWrapper()

Member Function Documentation

◆ clone()

◆ f()

◆ getNamespace()

◆ getNumberOfParameters()

◆ getParameterNameWithoutNamespace()

◆ getParameters()

◆ getParameters_()

◆ getParameterValue()

◆ getValue()

◆ hasParameter()

◆ matchParametersValues()

◆ parameter()

◆ removeConstraint()

◆ setAllParametersValues()

◆ setConstraint()

◆ setNamespace()

◆ setParameters()

◆ setParametersValues()

◆ setParameterValue()

Member Data Documentation

◆ constraintMatch_

◆ function_