MEAL::ParameterPolicy Class Reference

Managers of Function parameters. More...

#include <ParameterPolicy.h>

Inheritance diagram for MEAL::ParameterPolicy:

Public Member Functions
virtual ParameterPolicy *	clone (Function *new_context) const =0
	Clone constructor.
virtual unsigned	get_nparam () const =0
	Return the number of parameters.
virtual std::string	get_name (unsigned index) const =0
	Return the name of the specified parameter.
virtual std::string	get_description (unsigned index) const =0
	Return the name of the specified parameter.
virtual double	get_param (unsigned index) const =0
	Return the value of the specified parameter.
virtual void	set_param (unsigned index, double value)=0
	Set the value of the specified parameter.
virtual double	get_variance (unsigned index) const =0
	Return the variance of the specified parameter.
virtual void	set_variance (unsigned index, double value)=0
	Set the variance of the specified parameter.
virtual bool	get_infit (unsigned index) const =0
	Return true if parameter at index is to be fitted.
virtual void	set_infit (unsigned index, bool flag)=0
	Set flag for parameter at index to be fitted.
Public Member Functions inherited from MEAL::FunctionPolicy
	FunctionPolicy (Function *context=0)
	Default constructor.
	~FunctionPolicy ()
	Destructor.
Function *	get_context () const
	Return the Function for whom this policy operates.
Public Member Functions inherited from Reference::Able
	Able (const Able &)
Able &	operator= (const Able &)
unsigned	get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
	HeapTracked (const HeapTracked &)
HeapTracked &	operator= (const HeapTracked &)
bool	__is_on_heap () const

Static Public Attributes
static bool	auto_install = true
	Install policy upon construction.

Protected Member Functions
	ParameterPolicy (Function *context)
	Default destructor.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Additional Inherited Members
Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()
Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)
static void	operator delete (void *location, void *ptr)
static void	operator delete (void *location)
static size_t	get_heap_queue_size ()

Detailed Description

Managers of Function parameters.

Member Function Documentation

clone()

virtual ParameterPolicy * MEAL::ParameterPolicy::clone ( Function * new_context ) const

pure virtual

Clone constructor.

Implemented in MEAL::Composite, MEAL::CyclicParameter, MEAL::NoParameters, MEAL::OneParameter, and MEAL::Parameters.

References ParameterPolicy().

get_description()

virtual std::string MEAL::ParameterPolicy::get_description ( unsigned index ) const

pure virtual

Return the name of the specified parameter.

Implemented in MEAL::Composite, MEAL::NoParameters, MEAL::OneParameter, and MEAL::Parameters.

get_infit()

virtual bool MEAL::ParameterPolicy::get_infit ( unsigned index ) const

pure virtual

Return true if parameter at index is to be fitted.

Implemented in MEAL::Composite, MEAL::NoParameters, MEAL::OneParameter, and MEAL::Parameters.

get_name()

virtual std::string MEAL::ParameterPolicy::get_name ( unsigned index ) const

pure virtual

Return the name of the specified parameter.

Implemented in MEAL::Composite, MEAL::NoParameters, MEAL::OneParameter, and MEAL::Parameters.

get_nparam()

virtual unsigned MEAL::ParameterPolicy::get_nparam ( ) const

pure virtual

Return the number of parameters.

Implemented in MEAL::Composite, MEAL::NoParameters, MEAL::OneParameter, and MEAL::Parameters.

get_param()

virtual double MEAL::ParameterPolicy::get_param ( unsigned index ) const

pure virtual

Return the value of the specified parameter.

Implemented in MEAL::Composite, MEAL::NoParameters, MEAL::OneParameter, and MEAL::Parameters.

get_variance()

virtual double MEAL::ParameterPolicy::get_variance ( unsigned index ) const

pure virtual

Return the variance of the specified parameter.

Implemented in MEAL::Composite, MEAL::NoParameters, MEAL::OneParameter, and MEAL::Parameters.

set_infit()

virtual void MEAL::ParameterPolicy::set_infit ( unsigned index, bool flag )

pure virtual

Set flag for parameter at index to be fitted.

Implemented in MEAL::Composite, MEAL::NoParameters, MEAL::OneParameter, and MEAL::Parameters.

set_param()

virtual void MEAL::ParameterPolicy::set_param ( unsigned index, double value )

pure virtual

Set the value of the specified parameter.

Implemented in MEAL::Composite, MEAL::NoParameters, MEAL::OneParameter, and MEAL::Parameters.

set_variance()

virtual void MEAL::ParameterPolicy::set_variance ( unsigned index, double value )

pure virtual

Set the variance of the specified parameter.

Implemented in MEAL::Composite, MEAL::NoParameters, MEAL::OneParameter, and MEAL::Parameters.

Member Data Documentation

auto_install

bool MEAL::ParameterPolicy::auto_install = true

static

Install policy upon construction.

By default, ParameterPolicy derived instances are installed in the context during construction.

Referenced by ParameterPolicy().

---

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

• ParameterPolicy.h
• ParameterPolicy.C