COptItem Class Reference

#include <COptItem.h>

Inheritance diagram for COptItem:

Public Member Functions
void	addDependentItem (COptItem *pDependentItem)
virtual void	calculateValue () override
virtual C_INT32	checkConstraint () const
C_INT32	checkConstraint (const C_FLOAT64 &value) const
bool	checkInterval () const
bool	checkIsInitialValue () const
bool	checkLowerBound (const C_FLOAT64 &value) const
bool	checkUpperBound (const C_FLOAT64 &value) const
virtual bool	compile (CObjectInterface::ContainerList listOfContainer=CDataContainer::EmptyList)
	COptItem (const CCopasiParameterGroup &group, const CDataContainer *pParent)
	COptItem (const CDataContainer *pParent, const std::string &name="OptimizationItem")
	COptItem (const COptItem &src, const CDataContainer *pParent)
virtual C_FLOAT64	getConstraintViolation () const
const std::set< COptItem * > &	getDependentItems () const
const CCore::CUpdateSequence &	getIntervalUpdateSequence () const
const C_FLOAT64 &	getLastStartValue () const
const std::string	getLowerBound () const
const C_FLOAT64 *	getLowerBoundValue () const
const CObjectInterface *	getObject () const
const CCommonName	getObjectCN () const
std::string	getObjectDisplayName () const override
virtual const C_FLOAT64 *	getObjectValue () const
C_FLOAT64	getRandomValue (CRandom &Random) const
const C_FLOAT64 &	getStartValue () const
const std::string	getUpperBound () const
const C_FLOAT64 *	getUpperBoundValue () const
virtual void *	getValuePointer () const override
bool	influencesIntervals () const
virtual bool	isValid () const
void	rememberStartValue ()
void	setIntervalUpdateSequence (const CCore::CUpdateSequence &updateSequence)
bool	setLowerBound (const CCommonName &lowerBound)
bool	setObjectCN (const CCommonName &objectCN)
bool	setStartValue (const C_FLOAT64 &value)
bool	setUpperBound (const CCommonName &upperBound)
void	updatePrerequisites (const std::vector< COptItem * > &influencingIntervals)
virtual	~COptItem ()
Public Member Functions inherited from CCopasiParameterGroup
bool	addGroup (const std::string &name)
void	addParameter (CCopasiParameter *pParameter)
bool	addParameter (const CCopasiParameter &parameter)
bool	addParameter (const std::string &name, const CCopasiParameter::Type type, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)
template<class CType >
bool	addParameter (const std::string &name, const CCopasiParameter::Type type, const CType &value, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)
virtual bool	applyData (const CData &data, CUndoData::CChangeSet &changes)
CCopasiParameterGroup *	assertGroup (const std::string &name, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)
template<class CType >
CType *	assertParameter (const std::string &name, const CCopasiParameter::Type type, const CType &defaultValue, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)
index_iterator	beginIndex () const
const_name_iterator	beginName () const
	CCopasiParameterGroup (const CCopasiParameterGroup &src, const CDataContainer *pParent=NULL)
	CCopasiParameterGroup (const std::string &name, const CDataContainer *pParent=NO_PARENT, const std::string &objectType="ParameterGroup")
void	clear ()
virtual void	createUndoData (CUndoData &undoData, const CUndoData::Type &type, const CData &oldData=CData(), const CCore::Framework &framework=CCore::Framework::ParticleNumbers) const
virtual bool	elevateChildren ()
index_iterator	endIndex () const
const_name_iterator	endName () const
CCopasiParameterGroup &	getElementTemplates ()
const CCopasiParameterGroup &	getElementTemplates () const
CCopasiParameterGroup *	getGroup (const size_t &index)
const CCopasiParameterGroup *	getGroup (const size_t &index) const
CCopasiParameterGroup *	getGroup (const std::string &name)
const CCopasiParameterGroup *	getGroup (const std::string &name) const
virtual size_t	getIndex (const CDataObject *pObject) const
size_t	getIndex (const std::string &name) const
std::string	getKey (const size_t &index) const
std::string	getKey (const std::string &name) const
virtual const std::string &	getName (const size_t &index) const
virtual const CObjectInterface *	getObject (const CCommonName &cn) const
CCopasiParameter *	getParameter (const size_t &index)
const CCopasiParameter *	getParameter (const size_t &index) const
CCopasiParameter *	getParameter (std::string name)
const CCopasiParameter *	getParameter (std::string name) const
CCopasiParameter::Type	getType (const size_t &index) const
CCopasiParameter::Type	getType (const std::string &name) const
std::string	getUniqueParameterName (const CCopasiParameter *pParameter) const
template<class CType >
CType &	getValue (const size_t &index)
template<class CType >
const CType &	getValue (const size_t &index) const
template<class CType >
CType &	getValue (const std::string &name)
template<class CType >
const CType &	getValue (const std::string &name) const
bool	haveTemplate () const
virtual CUndoObjectInterface *	insert (const CData &data)
CCopasiParameterGroup &	operator= (const CCopasiParameterGroup &rhs)
virtual void	print (std::ostream *ostream) const
virtual bool	remove (CDataObject *pObject)
bool	removeParameter (CCopasiParameter *pParameter)
bool	removeParameter (const size_t &index)
bool	removeParameter (const std::string &name)
virtual void	setUserInterfaceFlag (const UserInterfaceFlag &flag)
template<class CType >
bool	setValue (const size_t &index, const CType &value)
template<class CType >
bool	setValue (const std::string &name, const CType &value)
size_t	size (const UserInterfaceFlag &require=UserInterfaceFlag::None, const UserInterfaceFlag &exclude=UserInterfaceFlag::None) const
bool	swap (const size_t &iFrom, const size_t &iTo)
bool	swap (index_iterator &from, index_iterator &to)
virtual CData	toData () const
virtual void	updateIndex (const size_t &index, const CUndoObjectInterface *pUndoObject)
virtual	~CCopasiParameterGroup ()
Public Member Functions inherited from CCopasiParameter
	CCopasiParameter (const CCopasiParameter &src, const CDataContainer *pParent)
	CCopasiParameter (const std::string &name, const Type &type, const void *pValue=NULL, const CDataContainer *pParent=NO_PARENT, const std::string &objectType="Parameter")
virtual CCommonName	getCN () const override
template<class CType >
const CType &	getDefault () const
virtual const std::string &	getKey () const override
const CCopasiParameter::Type &	getType () const
const UserInterfaceFlag &	getUserInterfaceFlag () const
template<class CType >
std::vector< std::pair< CType, CType > > &	getValidValues ()
template<class CType >
const std::vector< std::pair< CType, CType > > &	getValidValues () const
void *	getValidValuesPointer () const
template<class CType >
CType &	getValue ()
template<class CType >
const CType &	getValue () const
CDataObject *	getValueReference () const
bool	hasValidValues () const
bool	isBasic () const
bool	isDefault () const
bool	isEditable () const
bool	isUnsupported () const
bool	isValidValue (const bool &value) const
bool	isValidValue (const C_FLOAT64 &value) const
bool	isValidValue (const C_INT32 &value) const
bool	isValidValue (const CCommonName &value) const
template<class CType >
bool	isValidValue (const CType &) const
bool	isValidValue (const std::string &value) const
bool	isValidValue (const std::vector< CCopasiParameter * > &value) const
bool	isValidValue (const unsigned C_INT32 &value) const
CCopasiParameter &	operator= (const CCopasiParameter &rhs)
template<class CType >
bool	setDefault (const CType &defaultValue)
bool	setDefault (const std::vector< CCopasiParameter * > &defaultValue)
virtual bool	setObjectParent (const CDataContainer *pParent) override
template<class CType , class Enum >
bool	setValidValues (const CEnumAnnotation< CType, Enum > &validValues)
template<class CType >
bool	setValidValues (const std::vector< std::pair< CType, CType > > &validValues)
template<class CType >
bool	setValue (const CType &value)
bool	setValue (const std::vector< CCopasiParameter * > &value)
virtual	~CCopasiParameter ()
Public Member Functions inherited from CDataContainer
virtual bool	add (CDataObject *pObject, const bool &adopt=true)
virtual bool	appendDeletedDependentData (CUndoData &undoData) const
	CDataContainer (const CDataContainer &src, const CDataContainer *pParent)
	CDataContainer (const std::string &name, const CDataContainer *pParent=NO_PARENT, const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)
virtual std::string	getChildObjectUnits (const CDataObject *pObject) const
void	getDescendants (CDataObject::DataObjectSet &descendants, const bool &recursive=false) const
virtual objectMap &	getObjects ()
virtual const objectMap &	getObjects () const
virtual const std::string	getUnits () const override
virtual const CDataObject *	getValueObject () const override
void	objectRenamed (CDataObject *pObject, const std::string &oldName)
virtual	~CDataContainer ()
Public Member Functions inherited from CDataObject
void	addIssue (const CIssue &issue)
void	addReference (const CDataContainer *pReference)
	CDataObject (const CDataObject &src, const CDataContainer *pParent=NULL)
virtual void	destruct () override
virtual const CDataObject *	getDataObject () const override
CDataContainer *	getObjectAncestor (const std::string &type) const
CDataModel *	getObjectDataModel () const
const CObjectInterface *	getObjectFromCN (const CCommonName &cn) const
const std::string &	getObjectName () const
CDataContainer *	getObjectParent () const
const std::string &	getObjectType () const
virtual const CObjectInterface::ObjectSet &	getPrerequisites () const override
virtual const CValidity &	getValidity () const override
bool	hasFlag (const Flag &flag) const
virtual bool	isPrerequisiteForContext (const CObjectInterface *pObject, const CCore::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const override
bool	prerequisitsContains (const DataObjectSet &objects) const
void	removeIssue (const CIssue &issue)
void	removeReference (const CDataContainer *pReference)
bool	setObjectName (const std::string &name)
void	validityChanged (const CValidity &changedValidity) override
void	validityRemoved (const CValidity &changedValidity)
virtual	~CDataObject ()
Public Member Functions inherited from CObjectInterface
	CObjectInterface ()
	CObjectInterface (const CObjectInterface &src)
virtual	~CObjectInterface ()
Public Member Functions inherited from CUndoObjectInterface
	CUndoObjectInterface ()
	CUndoObjectInterface (const CUndoObjectInterface &src)
bool	generateUuid ()
const xg::Guid &	getUuid () const
bool	setUuid (const std::string &uuid)
bool	setUuid (const xg::Guid &uuid)
virtual	~CUndoObjectInterface ()

Static Public Member Functions
static bool	isValid (CCopasiParameterGroup &group)
Static Public Member Functions inherited from CCopasiParameter
static void	allocateValidValues (const Type &type, void *&pValidValues)
static void	allocateValue (const Type &type, void *&pValue)
static void	assignValue (const Type &type, void *&pValue, const void *pNewValue)
static void	deleteValidValues (const Type &type, void *&pValidValues)
static void	deleteValue (const Type &type, void *&pValue)
static CCopasiParameter *	fromData (const CData &data, CUndoObjectInterface *pParent)
Static Public Member Functions inherited from CDataContainer
static CDataContainer *	fromData (const CData &data, CUndoObjectInterface *pParent)
Static Public Member Functions inherited from CDataObject
static CDataObject *	fromData (const CData &data, CUndoObjectInterface *pParent)
static void	sanitizeObjectName (std::string &name)
Static Public Member Functions inherited from CObjectInterface
static const CDataObject *	DataObject (const CObjectInterface *pInterface)
static CObjectInterface *	GetObjectFromCN (const ContainerList &listOfContainer, const CCommonName &objName)
Static Public Member Functions inherited from CUndoObjectInterface
template<class CType >
static CType *	fromData (const CData &, CUndoObjectInterface *)

Protected Member Functions
	COptItem ()
	COptItem (const COptItem &src)
Protected Member Functions inherited from CCopasiParameterGroup
	CCopasiParameterGroup ()
Protected Member Functions inherited from CCopasiParameter
	CCopasiParameter (const CCopasiParameter &src)
Protected Member Functions inherited from CDataContainer
template<class CType >
CDataMatrixReference< CType > *	addMatrixReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
template<class CType >
CDataObjectReference< CType > *	addObjectReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
template<class CType >
CDataVectorReference< CType > *	addVectorReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
	CDataContainer (const CDataContainer &src)
void	initObjects ()
Protected Member Functions inherited from CDataObject
	CDataObject ()
	CDataObject (const std::string &name, const CDataContainer *pParent=static_cast< CDataContainer * >((void *) 0), const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)

Protected Attributes
std::set< COptItem * >	mDependentItems
C_FLOAT64	mInterval
C_FLOAT64	mLastStartValue
C_FLOAT64	mLowerBound
const C_FLOAT64 *	mpLowerBound
const CObjectInterface *	mpLowerObject
const CObjectInterface *	mpObject
const C_FLOAT64 *	mpObjectValue
std::string *	mpParmLowerBound
std::string *	mpParmObjectCN
C_FLOAT64 *	mpParmStartValue
std::string *	mpParmUpperBound
const C_FLOAT64 *	mpUpperBound
const CObjectInterface *	mpUpperObject
CCore::CUpdateSequence	mUpdateInterval
C_FLOAT64	mUpperBound
Protected Attributes inherited from CCopasiParameter
std::string	mKey
void *	mpDefault
void *	mpValidValues
void *	mpValue
CDataObject *	mpValueReference
UserInterfaceFlag	mUserInterfaceFlag
Protected Attributes inherited from CDataContainer
objectMap	mObjects
Protected Attributes inherited from CDataObject
ObjectSet	mPrerequisits
std::set< CDataContainer * >	mReferences
Protected Attributes inherited from CObjectInterface
CValidity	mValidity

Private Member Functions
bool	compileLowerBound (const CObjectInterface::ContainerList &listOfContainer)
bool	compileUpperBound (const CObjectInterface::ContainerList &listOfContainer)
void	initializeParameter ()

Friends
std::ostream &	operator<< (std::ostream &os, const COptItem &o)

Additional Inherited Members
Public Types inherited from CCopasiParameterGroup
typedef CDataObjectMap::const_type_iterator< CCopasiParameter >	const_name_iterator
typedef std::vector< CCopasiParameter * >	elements
typedef elements::iterator	index_iterator
typedef CDataObjectMap::type_iterator< CCopasiParameter >	name_iterator
Public Types inherited from CCopasiParameter
enum class	eUserInterfaceFlag { editable , basic , unsupported , __SIZE }
enum class	Type {   DOUBLE = 0 , UDOUBLE , INT , UINT ,   BOOL , GROUP , STRING , CN ,   KEY , FILE , EXPRESSION , INVALID ,   __SIZE }
typedef CFlags< eUserInterfaceFlag >	UserInterfaceFlag
Public Types inherited from CDataContainer
typedef CDataObjectMap	objectMap
Public Types inherited from CDataObject
typedef std::set< const CDataObject * >	DataObjectSet
enum	Flag {   Container , Vector , Matrix , NameVector ,   Reference , ValueBool , ValueInt , ValueInt64 ,   ValueDbl , NonUniqueName , StaticString , ValueString ,   Separator , DisplayName , ModelEntity , Array ,   DataModel , Root , Gui , __SIZE }
Public Types inherited from CObjectInterface
typedef std::vector< const CDataContainer * >	ContainerList
typedef std::set< const CObjectInterface * >	ObjectSet
Static Public Attributes inherited from CCopasiParameter
static const CEnumAnnotation< std::string, Type >	TypeName
static const CEnumAnnotation< std::string, Type >	XMLType
Static Public Attributes inherited from CDataContainer
static const CObjectInterface::ContainerList	EmptyList

Constructor & Destructor Documentation

COptItem() [1/5]

COptItem::COptItem ( )

protected

Default constructor

COptItem() [2/5]

COptItem::COptItem ( const COptItem &  src )

protected

COptItem() [3/5]

COptItem::COptItem	(	const CDataContainer *	pParent,
		const std::string &	name = "OptimizationItem"
	)

Specific constructor

Parameters

const	CDataContainer * pParent
const	std::string & name (default: OptimizationItem)

References initializeParameter().

COptItem() [4/5]

COptItem::COptItem	(	const COptItem &	src,
		const CDataContainer *	pParent
	)

Copy constructor

Parameters

const	COptItem & src
const	CDataContainer * pParent (default: src data model)

References initializeParameter().

COptItem() [5/5]

COptItem::COptItem	(	const CCopasiParameterGroup &	group,
		const CDataContainer *	pParent
	)

Specific constructor used for reading COPASI files

Parameters

const	CCopasiParameterGroup & group
const	CDataContainer * pParent (default: group data model)

References initializeParameter().

~COptItem()

COptItem::~COptItem ( )

virtual

Destructor

Member Function Documentation

addDependentItem()

void COptItem::addDependentItem

(

COptItem *

pDependentItem

)

References mDependentItems.

Referenced by COptProblem::initialize().

calculateValue()

void COptItem::calculateValue ( )

overridevirtual

Calculate the objects value.

Reimplemented from CDataObject.

References mInterval, mpLowerBound, and mpUpperBound.

checkConstraint() [1/2]

C_INT32 COptItem::checkConstraint ( ) const

virtual

This functions check whether the current value is within the limits of the optimization item.

Returns

C_INT32 result (-1: to small, 0: within boundaries, 1 to large)

Reimplemented in CFitItem, and CFitConstraint.

References mpLowerBound, mpObjectValue, and mpUpperBound.

Referenced by COptMethodHookeJeeves::bestNearby(), COptMethodSS::combination(), COptMethodPS::create(), COptMethodEP::creation(), COptMethodSRES::creation(), COptMethodDE::creation(), COptMethodGA::creation(), COptMethodSS::creation(), getConstraintViolation(), COptMethodPS::move(), COptMethodSRES::mutate(), COptMethodGA::mutate(), COptMethodEP::mutate(), COptMethodCoranaWalk::optimise(), COptMethodDE::optimise(), COptMethodGA::optimise(), COptMethodHookeJeeves::optimise(), COptMethodLevenbergMarquardt::optimise(), COptMethodNelderMead::optimise(), COptMethodNL2SOL::optimise(), COptMethodPraxis::optimise(), COptMethodPS::optimise(), COptMethodSA::optimise(), COptMethodStatistics::optimise(), COptMethodSteepestDescent::optimise(), COptMethodTruncatedNewton::optimise(), CRandomSearch::optimise(), COptMethodSS::randomize(), and COptMethodDE::replicate().

checkConstraint() [2/2]

C_INT32 COptItem::checkConstraint

(

const C_FLOAT64 &

value

)

const

This functions check whether the value is within the limits of the optimization item.

Parameters

const

C_FLOAT64 & value

Returns

C_INT32 result (-1: to small, 0: within boundaries, 1 to large)

References mpLowerBound, and mpUpperBound.

checkInterval()

bool COptItem::checkInterval

(

)

const

Checks whether we have a valid interval.

Returns

bool fulfills

References mpLowerBound, and mpUpperBound.

checkIsInitialValue()

bool COptItem::checkIsInitialValue

(

)

const

Checks whether we have a valid initial value item.

Returns

bool fulfills

References CCopasiMessage::ERROR, CObjectInterface::getObjectDisplayName(), MCOptimization, mpLowerObject, mpObject, and mpUpperObject.

checkLowerBound()

bool COptItem::checkLowerBound

(

const C_FLOAT64 &

value

)

const

Checks whether the value fulfills the lower bound constraint.

Parameters

const

C_FLOAT64 & value

Returns

bool fulfills

References mpLowerBound.

Referenced by COptMethodEP::creation(), COptMethodSRES::creation(), and CRandomSearch::optimise().

checkUpperBound()

bool COptItem::checkUpperBound

(

const C_FLOAT64 &

value

)

const

Checks whether the value fulfills the upper bound constraint.

Parameters

const

C_FLOAT64 & value

Returns

bool fulfills

References mpUpperBound.

Referenced by COptMethodEP::creation(), COptMethodSRES::creation(), and CRandomSearch::optimise().

compile()

bool COptItem::compile ( CObjectInterface::ContainerList  listOfContainer = CDataContainer::EmptyList )

virtual

Compile the optimization item. This function must be called before any of the check functions are called.

Parameters

const

CObjectInterface::ContainerList listOfContainer

Returns

bool success

Reimplemented in CFitItem.

References C_FLOAT64, compileLowerBound(), compileUpperBound(), CObjectInterface::DataObject(), CCopasiMessage::ERROR, CDataObject::getObjectDataModel(), CObjectInterface::getObjectDisplayName(), CObjectInterface::GetObjectFromCN(), CObjectInterface::getValuePointer(), CDataObject::hasFlag(), MCOptimization, mDependentItems, mpLowerBound, mpLowerObject, mpObject, mpObjectValue, mpParmLowerBound, mpParmObjectCN, mpParmStartValue, mpParmUpperBound, CDataObject::mPrerequisits, mpUpperBound, mpUpperObject, NaN, and CDataObject::ValueDbl.

Referenced by CFitItem::compile(), and getRandomValue().

compileLowerBound()

bool COptItem::compileLowerBound ( const CObjectInterface::ContainerList &  listOfContainer )

private

Compile the lower bound to hold the value given by the bound

Parameters

const

CObjectInterface::ContainerList & listOfContainer

Returns

bool success

References C_FLOAT64, CObjectInterface::DataObject(), CObjectInterface::GetObjectFromCN(), CObjectInterface::getValuePointer(), CDataObject::hasFlag(), isNumber(), max, mLowerBound, mpLowerBound, mpLowerObject, mpParmLowerBound, strToDouble(), and CDataObject::ValueDbl.

Referenced by compile(), and setLowerBound().

compileUpperBound()

bool COptItem::compileUpperBound ( const CObjectInterface::ContainerList &  listOfContainer )

private

Compile the upper bound to hold the value given by the bound

Parameters

const

CObjectInterface::ContainerList & listOfContainer

Returns

bool success

References C_FLOAT64, CObjectInterface::DataObject(), CObjectInterface::GetObjectFromCN(), CObjectInterface::getValuePointer(), CDataObject::hasFlag(), isNumber(), max, mpParmUpperBound, mpUpperBound, mpUpperObject, mUpperBound, strToDouble(), and CDataObject::ValueDbl.

Referenced by compile(), and setUpperBound().

getConstraintViolation()

C_FLOAT64 COptItem::getConstraintViolation ( ) const

virtual

Retrieve the magnitude of the constraint violation This is always a positive number

Returns

C_FLOAT64 constraintViolation;

Reimplemented in CFitItem, and CFitConstraint.

References checkConstraint(), mpLowerBound, mpObjectValue, and mpUpperBound.

getDependentItems()

const std::set< COptItem * > & COptItem::getDependentItems

(

)

const

References mDependentItems.

Referenced by COptProblem::adjustStartValue().

getIntervalUpdateSequence()

const CCore::CUpdateSequence & COptItem::getIntervalUpdateSequence

(

)

const

References mUpdateInterval.

getLastStartValue()

const C_FLOAT64 & COptItem::getLastStartValue

(

)

const

Retrieve the start value use in the last optimization.

Returns

const C_FLOAT64 & startValue

References mLastStartValue.

getLowerBound()

const std::string COptItem::getLowerBound

(

)

const

Retrieve the lower bound.

Returns

const std::string lowerBound

References mpParmLowerBound.

Referenced by isValid(), and CFitItem::updateBounds().

getLowerBoundValue()

const C_FLOAT64* COptItem::getLowerBoundValue ( ) const

inline

Retrieve the value of the lower bound.

Returns

const C_FLOAT64 * lowerBoundValue

References mpLowerBound.

Referenced by COptProblem::adjustStartValue(), COptMethodHookeJeeves::bestNearby(), COptMethodSS::combination(), COptMethodPS::create(), COptMethodEP::creation(), COptMethodSRES::creation(), COptMethodDE::creation(), COptMethodGA::creation(), COptMethodGASR::creation(), COptMethodSS::creation(), COptMethodSRES::initialize(), COptMethodPS::move(), COptMethodSRES::mutate(), COptMethodGA::mutate(), COptMethodEP::mutate(), COptMethodCoranaWalk::optimise(), COptMethodDE::optimise(), COptMethodGA::optimise(), COptMethodHookeJeeves::optimise(), COptMethodLevenbergMarquardt::optimise(), COptMethodNelderMead::optimise(), COptMethodNL2SOL::optimise(), COptMethodPraxis::optimise(), COptMethodPS::optimise(), COptMethodSA::optimise(), COptMethodStatistics::optimise(), COptMethodSteepestDescent::optimise(), COptMethodTruncatedNewton::optimise(), CRandomSearch::optimise(), COptMethodSS::randomize(), COptMethodDE::replicate(), and ResultData::updateFitItemsFromOptItems().

getObject()

const CObjectInterface * COptItem::getObject

(

)

const

Retrieve the item object. This may only be called after compile

Returns

const CObjectInterface *

References mpObject.

Referenced by COptProblem::adjustStartValue(), CMathDependencyGraph::getDOTNodeId(), and CFitProblem::initialize().

getObjectCN()

const CCommonName COptItem::getObjectCN

(

)

const

Retrieve the object of the optimization item.

Returns

const CCommonName objectCN

References mpParmObjectCN.

getObjectDisplayName()

std::string COptItem::getObjectDisplayName ( ) const

overridevirtual

Retrieve the display name of the optimization item.

Returns

std::string displayName

Reimplemented from CCopasiParameter.

References CObjectInterface::DataObject(), CObjectInterface::getObjectDisplayName(), CDataObject::getObjectDisplayName(), CDataObject::getObjectFromCN(), CDataObject::getValuePointer(), mpObject, and mpParmObjectCN.

Referenced by ResultData::appliesTo(), CFitProblem::initialize(), and ResultData::updateFitItemsFromOptItems().

getObjectValue()

const C_FLOAT64 * COptItem::getObjectValue ( ) const

virtual

Retrieve the value of the optimization object.

Returns

const C_FLOAT64 * objectValue

Reimplemented in CFitItem.

References mpObjectValue.

getRandomValue()

C_FLOAT64 COptItem::getRandomValue

(

CRandom &

Random

)

const

Retrieve a random value in the interval (lower bound, upper bound). Optionally one may provide a random number generator to be used to create the random value.

Parameters

CRandom

& Random

Returns

C_FLOAT64 randomValue

References C_FLOAT64, compile(), CRandom::getRandomCC(), CRandom::getRandomNormal(), max, min, mpLowerBound, mpUpperBound, and NaN.

Referenced by CRandomSearch::optimise().

getStartValue()

const C_FLOAT64 & COptItem::getStartValue

(

)

const

Retrieve the start value of the optimization object.

Returns

const C_FLOAT64 & startValue

References C_FLOAT64, CObjectInterface::DataObject(), CDataObject::getObjectFromCN(), CDataObject::getValuePointer(), mpObjectValue, mpParmObjectCN, mpParmStartValue, and NaN.

Referenced by COptProblem::adjustStartValue(), COptMethodEP::creation(), COptMethodSRES::creation(), COptMethodSS::creation(), COptMethodCoranaWalk::optimise(), COptMethodDE::optimise(), COptMethodGA::optimise(), COptMethodHookeJeeves::optimise(), COptMethodLevenbergMarquardt::optimise(), COptMethodNelderMead::optimise(), COptMethodNL2SOL::optimise(), COptMethodPraxis::optimise(), COptMethodPS::optimise(), COptMethodSA::optimise(), COptMethodStatistics::optimise(), COptMethodSteepestDescent::optimise(), COptMethodTruncatedNewton::optimise(), CRandomSearch::optimise(), rememberStartValue(), setLowerBound(), setUpperBound(), and ResultData::updateFitItemsFromOptItems().

getUpperBound()

const std::string COptItem::getUpperBound

(

)

const

Retrieve the upper bound.

Returns

const std::string upperBound

References mpParmUpperBound.

Referenced by isValid(), and CFitItem::updateBounds().

getUpperBoundValue()

const C_FLOAT64* COptItem::getUpperBoundValue ( ) const

inline

Retrieve the value of the upper bound.

Returns

const C_FLOAT64 * upperBoundValue

References mpUpperBound.

Referenced by COptProblem::adjustStartValue(), COptMethodHookeJeeves::bestNearby(), COptMethodSS::combination(), COptMethodPS::create(), COptMethodEP::creation(), COptMethodSRES::creation(), COptMethodDE::creation(), COptMethodGA::creation(), COptMethodGASR::creation(), COptMethodSS::creation(), COptMethodSRES::initialize(), COptMethodPS::move(), COptMethodSRES::mutate(), COptMethodGA::mutate(), COptMethodEP::mutate(), COptMethodCoranaWalk::optimise(), COptMethodDE::optimise(), COptMethodGA::optimise(), COptMethodHookeJeeves::optimise(), COptMethodLevenbergMarquardt::optimise(), COptMethodNelderMead::optimise(), COptMethodNL2SOL::optimise(), COptMethodPraxis::optimise(), COptMethodPS::optimise(), COptMethodSA::optimise(), COptMethodStatistics::optimise(), COptMethodSteepestDescent::optimise(), COptMethodTruncatedNewton::optimise(), CRandomSearch::optimise(), COptMethodSS::randomize(), COptMethodDE::replicate(), and ResultData::updateFitItemsFromOptItems().

getValuePointer()

void * COptItem::getValuePointer ( ) const

overridevirtual

Retrieve a pointer to the value of the object

Reimplemented from CCopasiParameter.

References C_FLOAT64, and mInterval.

influencesIntervals()

bool COptItem::influencesIntervals

(

)

const

Check whether the item influences other intervals

Returns

bool influencesIntervals

References mDependentItems.

initializeParameter()

void COptItem::initializeParameter ( )

private

Allocates all group parameters and assures that they are properly initialized.

References CCopasiParameterGroup::assertParameter(), CCopasiParameter::CN, CCopasiParameter::DOUBLE, mpParmLowerBound, mpParmObjectCN, mpParmStartValue, mpParmUpperBound, and NaN.

Referenced by COptItem().

isValid() [1/2]

bool COptItem::isValid ( ) const

virtual

Check the validity of the optimization item.

Reimplemented in CFitItem.

References getLowerBound(), getUpperBound(), mpParmObjectCN, setLowerBound(), setObjectCN(), and setUpperBound().

Referenced by CFitItem::isValid(), and isValid().

isValid() [2/2]

bool COptItem::isValid ( CCopasiParameterGroup &  group )

static

Check whether the group describes a valid optimization item.

Returns

bool isValid

References isValid(), and NO_PARENT.

rememberStartValue()

void COptItem::rememberStartValue

(

)

Remember the current start value

References getStartValue(), and mLastStartValue.

setIntervalUpdateSequence()

void COptItem::setIntervalUpdateSequence

(

const CCore::CUpdateSequence &

updateSequence

)

References mUpdateInterval.

setLowerBound()

bool COptItem::setLowerBound

(

const CCommonName &

lowerBound

)

Set the lower bound.

Parameters

const

CCommonName & lowerBound

Returns

bool success

References C_FLOAT64, compileLowerBound(), CDataContainer::EmptyList, getStartValue(), isNumber(), mpParmLowerBound, and strToDouble().

Referenced by isValid().

setObjectCN()

bool COptItem::setObjectCN

(

const CCommonName &

objectCN

)

Set the object of the optimization item.

Parameters

const

CCommonName & objectCN

Returns

bool success

References CObjectInterface::DataObject(), CCopasiMessage::ERROR, CDataObject::getObjectFromCN(), CDataObject::hasFlag(), MCOptimization, mpParmObjectCN, and CDataObject::ValueDbl.

Referenced by CFitProblem::addFitConstraint(), CFitProblem::addFitItem(), COptProblem::addOptConstraint(), COptProblem::addOptItem(), and isValid().

setStartValue()

bool COptItem::setStartValue

(

const C_FLOAT64 &

value

)

Set the value start value.

Parameters

const

C_FLOAT64 & startValue

Returns

bool success

References mpParmStartValue.

Referenced by COptProblem::adjustStartValue(), CFitItem::elevateChildren(), and ResultData::setOptItemStartValues().

setUpperBound()

bool COptItem::setUpperBound

(

const CCommonName &

upperBound

)

Set the upper bound.

Parameters

const

CCommonName & upperBound

Returns

bool success

References C_FLOAT64, compileUpperBound(), CDataContainer::EmptyList, getStartValue(), isNumber(), mpParmUpperBound, and strToDouble().

Referenced by isValid().

updatePrerequisites()

void COptItem::updatePrerequisites

(

const std::vector< COptItem * > &

influencingIntervals

)

Update the prerequisites to point to the optimization items controlling the boundary object

Parameters

const

std::vector< COptItem * > & influencingIntervals

References CDataObject::mPrerequisits.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const COptItem &  o  )

friend

Output stream operator

Parameters

ostream	& os
const	COptItem & A

Returns

ostream & os

Member Data Documentation

mDependentItems

std::set< COptItem * > COptItem::mDependentItems

protected

Referenced by addDependentItem(), compile(), getDependentItems(), and influencesIntervals().

mInterval

C_FLOAT64 COptItem::mInterval

protected

A value indicating whether the interval is valid

Referenced by calculateValue(), and getValuePointer().

mLastStartValue

C_FLOAT64 COptItem::mLastStartValue

protected

The start value use for last calculation

Referenced by getLastStartValue(), and rememberStartValue().

mLowerBound

C_FLOAT64 COptItem::mLowerBound

protected

The value of the lower bound (only if not on object)

Referenced by compileLowerBound().

mpLowerBound

const C_FLOAT64* COptItem::mpLowerBound

protected

A pointer to the lower bound value

Referenced by CFitConstraint::calculateConstraintViolation(), calculateValue(), checkConstraint(), CFitItem::checkConstraint(), checkInterval(), checkLowerBound(), compile(), compileLowerBound(), getConstraintViolation(), CFitItem::getConstraintViolation(), getLowerBoundValue(), getRandomValue(), and CFitItem::updateBounds().

mpLowerObject

const CObjectInterface* COptItem::mpLowerObject

protected

A pointer to the object for the lower bound

Referenced by checkIsInitialValue(), compile(), compileLowerBound(), and CFitItem::updateBounds().

mpObject

const CObjectInterface* COptItem::mpObject

protected

A pointer to the object

Referenced by checkIsInitialValue(), compile(), getObject(), and getObjectDisplayName().

mpObjectValue

const C_FLOAT64* COptItem::mpObjectValue

protected

A pointer to the object value

Referenced by CFitConstraint::calculateConstraintViolation(), checkConstraint(), compile(), getConstraintViolation(), getObjectValue(), and getStartValue().

mpParmLowerBound

std::string* COptItem::mpParmLowerBound

protected

A pointer to the value of the CCopasiParameter holding the LowerBound

Referenced by compile(), compileLowerBound(), getLowerBound(), initializeParameter(), and setLowerBound().

mpParmObjectCN

std::string* COptItem::mpParmObjectCN

protected

A pointer to the value of the CCopasiParameter holding the ObjectCN

Referenced by compile(), getObjectCN(), getObjectDisplayName(), getStartValue(), initializeParameter(), isValid(), and setObjectCN().

mpParmStartValue

C_FLOAT64* COptItem::mpParmStartValue

protected

A pointer to the value of the CCopasiParameter holding the start value

Referenced by compile(), CFitItem::compile(), getStartValue(), initializeParameter(), and setStartValue().

mpParmUpperBound

std::string* COptItem::mpParmUpperBound

protected

A pointer to the value of the CCopasiParameter holding the UpperBound

Referenced by compile(), compileUpperBound(), getUpperBound(), initializeParameter(), and setUpperBound().

mpUpperBound

const C_FLOAT64* COptItem::mpUpperBound

protected

A pointer to the upper bound value

Referenced by CFitConstraint::calculateConstraintViolation(), calculateValue(), checkConstraint(), CFitItem::checkConstraint(), checkInterval(), checkUpperBound(), compile(), compileUpperBound(), getConstraintViolation(), CFitItem::getConstraintViolation(), getRandomValue(), getUpperBoundValue(), and CFitItem::updateBounds().

mpUpperObject

const CObjectInterface* COptItem::mpUpperObject

protected

A pointer to the object for the upper bound

Referenced by checkIsInitialValue(), compile(), compileUpperBound(), and CFitItem::updateBounds().

mUpdateInterval

CCore::CUpdateSequence COptItem::mUpdateInterval

protected

Referenced by getIntervalUpdateSequence(), and setIntervalUpdateSequence().

mUpperBound

C_FLOAT64 COptItem::mUpperBound

protected

The value of the upper bound (only if not on object)

Referenced by compileUpperBound().

---

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

• COptItem.h
• COptItem.cpp