MEAL::Parameters Class Reference

Abstract base class implements parameter storage and access. More...

#include <Parameters.h>

Inheritance diagram for MEAL::Parameters:

Public Member Functions
	Parameters (Function *context, unsigned nparam=0)
	Default constructor.
	Parameters (const Parameters &np)
	Copy constructor.
Parameters &	operator= (const Parameters &np)
	Assignment operator.
Parameters *	clone (Function *) const
	Clone construtor.
unsigned	get_nparam () const
	Return the number of parameters.
std::string	get_name (unsigned index) const
	Return the name of the specified parameter.
void	set_name (unsigned index, const std::string &name)
	Return the name of the specified parameter.
std::string	get_description (unsigned index) const
	Return the description of the specified parameter.
void	set_description (unsigned index, const std::string &description)
	Return the description of the specified parameter.
double	get_param (unsigned index) const
	Return the value of the specified parameter.
void	set_param (unsigned index, double value)
	Set the value of the specified parameter.
void	swap_param (unsigned index, double &value)
	Swap the value of the specified parameter.
double	get_variance (unsigned index) const
	Return the variance of the specified parameter.
void	set_variance (unsigned index, double value)
	Set the variance of the specified parameter.
bool	get_infit (unsigned index) const
	Return true if parameter at index is to be fitted.
void	set_infit (unsigned index, bool flag)
	Set flag for parameter at index to be fitted.
void	resize (unsigned nparam)
	Resize arrays, setting fit=true for new parameters.
void	erase (unsigned iparam)
	Erase the specified parameter.
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

Protected Member Functions
void	range_check (unsigned index, const char *method) const
	Ensure that index <= get_nparam.
Protected Member Functions inherited from MEAL::ParameterPolicy
	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 ()
Static Public Attributes inherited from MEAL::ParameterPolicy
static bool	auto_install = true
	Install policy upon construction.

Detailed Description

Abstract base class implements parameter storage and access.

Member Function Documentation

clone()

MEAL::Parameters * MEAL::Parameters::clone ( Function * context ) const

virtual

Clone construtor.

Implements MEAL::ParameterPolicy.

References get_nparam(), and Parameters().

get_description()

std::string MEAL::Parameters::get_description ( unsigned index ) const

inlinevirtual

Return the description of the specified parameter.

Implements MEAL::ParameterPolicy.

References range_check().

get_infit()

bool MEAL::Parameters::get_infit ( unsigned index ) const

inlinevirtual

Return true if parameter at index is to be fitted.

Implements MEAL::ParameterPolicy.

References range_check().

get_name()

std::string MEAL::Parameters::get_name ( unsigned index ) const

inlinevirtual

Return the name of the specified parameter.

Implements MEAL::ParameterPolicy.

References range_check().

get_nparam()

unsigned MEAL::Parameters::get_nparam ( ) const

inlinevirtual

Return the number of parameters.

Implements MEAL::ParameterPolicy.

Referenced by clone(), and operator=().

get_param()

double MEAL::Parameters::get_param ( unsigned index ) const

inlinevirtual

Return the value of the specified parameter.

Implements MEAL::ParameterPolicy.

References range_check().

Referenced by swap_param().

get_variance()

double MEAL::Parameters::get_variance ( unsigned index ) const

inlinevirtual

Return the variance of the specified parameter.

Implements MEAL::ParameterPolicy.

References range_check().

set_infit()

void MEAL::Parameters::set_infit ( unsigned index, bool flag )

inlinevirtual

Set flag for parameter at index to be fitted.

Implements MEAL::ParameterPolicy.

References range_check().

set_param()

void MEAL::Parameters::set_param ( unsigned index, double value )

virtual

Set the value of the specified parameter.

Implements MEAL::ParameterPolicy.

References MEAL::FunctionPolicy::get_context(), range_check(), and MEAL::Function::very_verbose.

Referenced by swap_param().

set_variance()

void MEAL::Parameters::set_variance ( unsigned index, double value )

inlinevirtual

Set the variance of the specified parameter.

Implements MEAL::ParameterPolicy.

References range_check().

---

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

• Parameters.h
• Parameters.C