gstlrn::ParamInfo Class Reference

Definition of the generic parameter. More...

#include <ParamInfo.hpp>

Inheritance diagram for gstlrn::ParamInfo:

Detailed Description

Definition of the generic parameter.

Parameters

_name	Name assigned to the parameter
_value	Value (initial) assigned to the parameter
_currentValue	Value currently assigned to the parameter
_absoluteBounds	Absolute bounds within which the parameter may vary
_userBounds	Current bounds for the parameter
_isFixed	True if the parameter value may not vary (in the non linear optimization)
_description	String describing the role of this parameter
_address	Address of the parameter in the optimization vector (ListParams)

Public Member Functions
	ParamInfo (const String &name="", double value=TEST, const std::array< double, 2 > &absoluteBounds={-INF, INF}, const std::string &description="", bool isfixed=false)
	ParamInfo (const ParamInfo &other)
ParamInfo &	operator= (const ParamInfo &other)
virtual	~ParamInfo ()
double	getValue () const
double	getAbsoluteMinValue () const
double	getAbsoluteMaxValue () const
void	setMinValue (double value)
void	setMaxValue (double value)
void	decreaseMax (double value)
void	increaseMin (double value)
void	setValue (double value)
String	getName () const
double	getUserMin () const
double	getUserMax () const
void	setFixed (bool isFixed)
bool	isFixed () const
void	setAddress (Id addr) const
size_t	getAddress () const
String	toString (const AStringFormat *strfmt=nullptr) const override
Public Member Functions inherited from gstlrn::AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (Id level) const final

Constructor & Destructor Documentation

ParamInfo() [1/2]

gstlrn::ParamInfo::ParamInfo	(	const String &	name = "",
		double	value = TEST,
		const std::array< double, 2 > &	absoluteBounds = {-INF, INF},
		const std::string &	description = "",
		bool	isfixed = false
	)

ParamInfo() [2/2]

gstlrn::ParamInfo::ParamInfo

(

const ParamInfo &

other

)

~ParamInfo()

gstlrn::ParamInfo::~ParamInfo ( )

virtual

Member Function Documentation

decreaseMax()

void gstlrn::ParamInfo::decreaseMax

(

double

value

)

getAbsoluteMaxValue()

double gstlrn::ParamInfo::getAbsoluteMaxValue ( ) const

inline

getAbsoluteMinValue()

double gstlrn::ParamInfo::getAbsoluteMinValue ( ) const

inline

getAddress()

size_t gstlrn::ParamInfo::getAddress ( ) const

inline

getName()

String gstlrn::ParamInfo::getName ( ) const

inline

getUserMax()

double gstlrn::ParamInfo::getUserMax ( ) const

inline

getUserMin()

double gstlrn::ParamInfo::getUserMin ( ) const

inline

getValue()

double gstlrn::ParamInfo::getValue ( ) const

inline

increaseMin()

void gstlrn::ParamInfo::increaseMin

(

double

value

)

isFixed()

bool gstlrn::ParamInfo::isFixed ( ) const

inline

operator=()

ParamInfo & gstlrn::ParamInfo::operator=

(

const ParamInfo &

other

)

setAddress()

void gstlrn::ParamInfo::setAddress ( Id  addr ) const

inline

setFixed()

void gstlrn::ParamInfo::setFixed ( bool  isFixed )

inline

setMaxValue()

void gstlrn::ParamInfo::setMaxValue

(

double

value

)

setMinValue()

void gstlrn::ParamInfo::setMinValue

(

double

value

)

setValue()

void gstlrn::ParamInfo::setValue

(

double

value

)

toString()

String gstlrn::ParamInfo::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Reimplemented from gstlrn::AStringable.

---

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

• include/Basic/ParamInfo.hpp
• src/Basic/ParamInfo.cpp