COPASI API  4.16.103
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
CFitConstraint Class Reference

#include <CFitItem.h>

Inheritance diagram for CFitConstraint:
Inheritance graph
[legend]
Collaboration diagram for CFitConstraint:
Collaboration graph
[legend]

Public Member Functions

void calculateConstraintViolation ()
 
 CFitConstraint (const CCopasiContainer *pParent, const std::string &name="FitItem")
 
 CFitConstraint (const CFitConstraint &src, const CCopasiContainer *pParent=NULL)
 
 CFitConstraint (const CCopasiParameterGroup &group, const CCopasiContainer *pParent=NULL)
 
virtual C_INT32 checkConstraint () const
 
virtual C_FLOAT64 getConstraintViolation () const
 
void resetConstraintViolation ()
 
virtual ~CFitConstraint ()
 
- Public Member Functions inherited from CFitItem
bool addCrossValidation (const std::string &key)
 
bool addExperiment (const std::string &key)
 
 CFitItem (const CCopasiContainer *pParent, const std::string &name="FitItem")
 
 CFitItem (const CFitItem &src, const CCopasiContainer *pParent=NULL)
 
 CFitItem (const CCopasiParameterGroup &group, const CCopasiContainer *pParent=NULL)
 
virtual bool compile (const std::vector< CCopasiContainer * > listOfContainer=CCopasiContainer::EmptyList)
 
virtual bool elevateChildren ()
 
const std::string & getCrossValidation (const size_t &index) const
 
size_t getCrossValidationCount () const
 
std::string getCrossValidations () const
 
const std::string & getExperiment (const size_t &index) const
 
size_t getExperimentCount () const
 
std::string getExperiments () const
 
const C_FLOAT64getLocalValue () const
 
virtual const C_FLOAT64getObjectValue () const
 
virtual UpdateMethodgetUpdateMethod () const
 
virtual bool isValid () const
 
bool removeCrossValidation (const size_t &index)
 
bool removeExperiment (const size_t &index)
 
void setLocalValue (const C_FLOAT64 &value)
 
bool updateBounds (std::vector< COptItem * >::iterator it)
 
virtual ~CFitItem ()
 
- Public Member Functions inherited from COptItem
C_INT32 checkConstraint (const C_FLOAT64 &value) const
 
bool checkLowerBound (const C_FLOAT64 &value) const
 
bool checkUpperBound (const C_FLOAT64 &value) const
 
 COptItem (const CCopasiContainer *pParent, const std::string &name="OptimizationItem")
 
 COptItem (const COptItem &src, const CCopasiContainer *pParent=NULL)
 
 COptItem (const CCopasiParameterGroup &group, const CCopasiContainer *pParent=NULL)
 
const C_FLOAT64getLastStartValue () const
 
const std::string getLowerBound () const
 
const C_FLOAT64getLowerBoundValue () const
 
const CCopasiObjectgetObject () const
 
const CCopasiObjectName getObjectCN () const
 
std::string getObjectDisplayName () const
 
C_FLOAT64 getRandomValue (CRandom *pRandom=NULL)
 
const C_FLOAT64getStartValue () const
 
const std::string getUpperBound () const
 
const C_FLOAT64getUpperBoundValue () const
 
void rememberStartValue ()
 
bool setLowerBound (const CCopasiObjectName &lowerBound)
 
bool setObjectCN (const CCopasiObjectName &objectCN)
 
bool setStartValue (const C_FLOAT64 &value)
 
bool setUpperBound (const CCopasiObjectName &upperBound)
 
virtual ~COptItem ()
 
- Public Member Functions inherited from CCopasiParameterGroup
bool addGroup (const std::string &name)
 
bool addParameter (const CCopasiParameter &parameter)
 
bool addParameter (const std::string &name, const CCopasiParameter::Type type)
 
template<class CType >
bool addParameter (const std::string &name, const CCopasiParameter::Type type, const CType &value)
 
void addParameter (CCopasiParameter *pParameter)
 
CCopasiParameterGroupassertGroup (const std::string &name)
 
template<class CType >
CCopasiParameterassertParameter (const std::string &name, const CCopasiParameter::Type type, const CType &defaultValue)
 
index_iterator beginIndex () const
 
name_iterator beginName () const
 
 CCopasiParameterGroup (const CCopasiParameterGroup &src, const CCopasiContainer *pParent=NULL)
 
 CCopasiParameterGroup (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &objectType="ParameterGroup")
 
void clear ()
 
index_iterator endIndex () const
 
name_iterator endName () const
 
CCopasiParameterGroupgetGroup (const std::string &name)
 
const CCopasiParameterGroupgetGroup (const std::string &name) const
 
CCopasiParameterGroupgetGroup (const size_t &index)
 
const CCopasiParameterGroupgetGroup (const size_t &index) const
 
size_t getIndex (const std::string &name) const
 
std::string getKey (const std::string &name) const
 
std::string getKey (const size_t &index) const
 
virtual const std::string & getName (const size_t &index) const
 
virtual const CObjectInterfacegetObject (const CCopasiObjectName &cn) const
 
CCopasiParametergetParameter (const std::string &name)
 
const CCopasiParametergetParameter (const std::string &name) const
 
CCopasiParametergetParameter (const size_t &index)
 
const CCopasiParametergetParameter (const size_t &index) const
 
CCopasiParameter::Type getType (const std::string &name) const
 
CCopasiParameter::Type getType (const size_t &index) const
 
std::string getUniqueParameterName (const CCopasiParameter *pParameter) const
 
const CCopasiParameter::ValuegetValue (const std::string &name) const
 
const CCopasiParameter::ValuegetValue (const size_t &index) const
 
CCopasiParameter::ValuegetValue (const std::string &name)
 
CCopasiParameter::ValuegetValue (const size_t &index)
 
CCopasiParameterGroupoperator= (const CCopasiParameterGroup &rhs)
 
virtual void print (std::ostream *ostream) const
 
bool removeParameter (const std::string &name)
 
bool removeParameter (const size_t &index)
 
template<class CType >
bool setValue (const std::string &name, const CType &value)
 
template<class CType >
bool setValue (const size_t &index, const CType &value)
 
size_t size () const
 
bool swap (const size_t &iFrom, const size_t &iTo)
 
bool swap (index_iterator &from, index_iterator &to)
 
virtual ~CCopasiParameterGroup ()
 
- Public Member Functions inherited from CCopasiParameter
 CCopasiParameter (const CCopasiParameter &src, const CCopasiContainer *pParent=NULL)
 
 CCopasiParameter (const std::string &name, const Type &type, const void *pValue=NULL, const CCopasiContainer *pParent=NULL, const std::string &objectType="Parameter")
 
virtual CCopasiObjectName getCN () const
 
virtual const std::string & getKey () const
 
virtual std::string getObjectDisplayName (bool regular=true, bool richtext=false) const
 
const CCopasiParameter::TypegetType () const
 
const ValuegetValue () const
 
ValuegetValue ()
 
virtual voidgetValuePointer () const
 
CCopasiObjectgetValueReference () const
 
bool isValidValue (const C_FLOAT64 &value) const
 
bool isValidValue (const C_INT32 &value) const
 
bool isValidValue (const unsigned C_INT32 &value) const
 
bool isValidValue (const bool &value) const
 
bool isValidValue (const std::string &value) const
 
bool isValidValue (const CCopasiObjectName &value) const
 
bool isValidValue (const std::vector< CCopasiParameter * > &value) const
 
CCopasiParameteroperator= (const CCopasiParameter &rhs)
 
template<class CType >
bool setValue (const CType &value)
 
bool setValue (const std::vector< CCopasiParameter * > &value)
 
virtual ~CCopasiParameter ()
 
- Public Member Functions inherited from CCopasiContainer
virtual bool add (CCopasiObject *pObject, const bool &adopt=true)
 
 CCopasiContainer (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &type="CN", const unsigned C_INT32 &flag=CCopasiObject::Container)
 
 CCopasiContainer (const CCopasiContainer &src, const CCopasiContainer *pParent=NULL)
 
virtual std::string getChildObjectUnits (const CCopasiObject *pObject) const
 
virtual const objectMapgetObjects () const
 
virtual std::string getUnits () const
 
virtual const CCopasiObjectgetValueObject () const
 
virtual bool remove (CCopasiObject *pObject)
 
virtual ~CCopasiContainer ()
 
- Public Member Functions inherited from CCopasiObject
void addDirectDependency (const CCopasiObject *pObject)
 
 CCopasiObject (const CCopasiObject &src, const CCopasiContainer *pParent=NULL)
 
void clearDirectDependencies ()
 
void clearRefresh ()
 
bool dependsOn (DataObjectSet candidates, const DataObjectSet &context=DataObjectSet()) const
 
void getAllDependencies (DataObjectSet &dependencies, const DataObjectSet &context) const
 
virtual const DataObjectSetgetDirectDependencies (const DataObjectSet &context=DataObjectSet()) const
 
CCopasiContainergetObjectAncestor (const std::string &type) const
 
CCopasiDataModelgetObjectDataModel ()
 
const CCopasiDataModelgetObjectDataModel () const
 
const std::string & getObjectName () const
 
CCopasiContainergetObjectParent () const
 
const std::string & getObjectType () const
 
virtual const
CObjectInterface::ObjectSet
getPrerequisites () const
 
virtual RefreshgetRefresh () const
 
UpdateMethodgetUpdateMethod () const
 
bool hasCircularDependencies (DataObjectSet &candidates, DataObjectSet &verified, const DataObjectSet &context) const
 
bool hasUpdateMethod () const
 
bool isArray () const
 
bool isContainer () const
 
bool isDataModel () const
 
bool isMatrix () const
 
bool isNameVector () const
 
bool isNonUniqueName () const
 
virtual bool isPrerequisiteForContext (const CObjectInterface *pObject, const CMath::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const
 
bool isReference () const
 
bool isRoot () const
 
bool isSeparator () const
 
bool isStaticString () const
 
bool isValueBool () const
 
bool isValueDbl () const
 
bool isValueInt () const
 
bool isValueInt64 () const
 
bool isValueString () const
 
bool isVector () const
 
virtual bool mustBeDeleted (const DataObjectSet &deletedObjects) const
 
void removeDirectDependency (const CCopasiObject *pObject)
 
void setDirectDependencies (const DataObjectSet &directDependencies)
 
bool setObjectName (const std::string &name)
 
virtual bool setObjectParent (const CCopasiContainer *pParent)
 
void setObjectValue (const C_FLOAT64 &value)
 
void setObjectValue (const C_INT32 &value)
 
void setObjectValue (const bool &value)
 
template<class CType >
void setRefresh (CType *pType, void(CType::*method)(void))
 
template<class CType >
void setUpdateMethod (CType *pType, void(CType::*method)(const C_FLOAT64 &))
 
template<class CType >
void setUpdateMethod (CType *pType, void(CType::*method)(const C_INT32 &))
 
template<class CType >
void setUpdateMethod (CType *pType, void(CType::*method)(const bool &))
 
virtual ~CCopasiObject ()
 
- Public Member Functions inherited from CObjectInterface
 CObjectInterface ()
 
virtual ~CObjectInterface ()
 

Protected Member Functions

 CFitConstraint ()
 
- Protected Member Functions inherited from CFitItem
 CFitItem ()
 
- Protected Member Functions inherited from COptItem
 COptItem ()
 
- Protected Member Functions inherited from CCopasiParameterGroup
 CCopasiParameterGroup ()
 
- Protected Member Functions inherited from CCopasiContainer
template<class CType >
CCopasiObjectaddMatrixReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0)
 
template<class CType >
CCopasiObjectaddObjectReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0)
 
template<class CType >
CCopasiObjectaddVectorReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0)
 
void initObjects ()
 
- Protected Member Functions inherited from CCopasiObject
 CCopasiObject ()
 
 CCopasiObject (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &type="CN", const unsigned C_INT32 &flag=0)
 

Private Attributes

C_INT32 mCheckConstraint
 
C_FLOAT64 mConstraintViolation
 

Additional Inherited Members

- Public Types inherited from CCopasiParameterGroup
typedef parameterGroup::iterator index_iterator
 
typedef
CCopasiContainer::objectMap::iterator 
name_iterator
 
typedef std::vector
< CCopasiParameter * > 
parameterGroup
 
- Public Types inherited from CCopasiParameter
enum  Type {
  DOUBLE = 0, UDOUBLE, INT, UINT,
  BOOL, GROUP, STRING, CN,
  KEY, FILE, EXPRESSION, INVALID
}
 
- Public Types inherited from CCopasiContainer
typedef std::multimap
< std::string, CCopasiObject * > 
objectMap
 
- Public Types inherited from CCopasiObject
typedef std::set< const
CCopasiObject * > 
DataObjectSet
 
typedef std::vector< Refresh * > DataUpdateSequence
 
- Public Types inherited from CObjectInterface
typedef std::set< const
CObjectInterface * > 
ObjectSet
 
typedef std::vector
< CObjectInterface * > 
UpdateSequence
 
- Static Public Member Functions inherited from CFitItem
static bool isValid (CCopasiParameterGroup &group)
 
- Static Public Member Functions inherited from COptItem
static bool isValid (CCopasiParameterGroup &group)
 
- Static Public Member Functions inherited from CCopasiObject
static std::vector< Refresh * > buildUpdateSequence (const DataObjectSet &objects, const DataObjectSet &uptoDateObjects, const DataObjectSet &context=DataObjectSet())
 
static void setRenameHandler (CRenameHandler *rh)
 
- Static Public Attributes inherited from CCopasiParameter
static const std::string TypeName []
 
static const char * XMLType []
 
- Static Public Attributes inherited from CCopasiContainer
static const std::vector
< CCopasiContainer * > 
EmptyList
 
- Protected Types inherited from CCopasiObject
enum  Flag {
  Container = 0x1, Vector = 0x2, Matrix = 0x4, NameVector = 0x8,
  Reference = 0x10, ValueBool = 0x20, ValueInt = 0x40, ValueInt64 = 0x80,
  ValueDbl = 0x100, NonUniqueName = 0x200, StaticString = 0x400, ValueString = 0x800,
  Separator = 0x1000, ModelEntity = 0x2000, Array = 0x4000, DataModel = 0x8000,
  Root = 0x10000, Gui = 0x20000
}
 
- Protected Attributes inherited from CFitItem
C_FLOAT64 mLocalValue
 
CCopasiParameterGroupmpGrpAffectedCrossValidations
 
CCopasiParameterGroupmpGrpAffectedExperiments
 
UpdateMethodmpLocalMethod
 
- Protected Attributes inherited from COptItem
C_FLOAT64 mLastStartValue
 
C_FLOAT64 mLowerBound
 
const C_FLOAT64mpLowerBound
 
const CCopasiObjectmpLowerObject
 
UpdateMethodmpMethod
 
const CCopasiObjectmpObject
 
const C_FLOAT64mpObjectValue
 
std::string * mpParmLowerBound
 
std::string * mpParmObjectCN
 
C_FLOAT64mpParmStartValue
 
std::string * mpParmUpperBound
 
const C_FLOAT64mpUpperBound
 
const CCopasiObjectmpUpperObject
 
C_FLOAT64 mUpperBound
 
- Protected Attributes inherited from CCopasiParameter
std::string mKey
 
CCopasiObjectmpValueReference
 
size_t mSize
 
Value mValue
 
- Protected Attributes inherited from CCopasiContainer
objectMap mObjects
 
- Static Protected Attributes inherited from COptItem
static CRandommpRandom = NULL
 
- Static Protected Attributes inherited from CCopasiObject
static CRenameHandlersmpRenameHandler = NULL
 

Detailed Description

Definition at line 243 of file CFitItem.h.

Constructor & Destructor Documentation

CFitConstraint::CFitConstraint ( )
protected

Default constructor

CFitConstraint::CFitConstraint ( const CCopasiContainer pParent,
const std::string &  name = "FitItem" 
)

Specific constructor

Parameters
constCCopasiContainer * pParent
conststd::string & name (default: FitItem)

Definition at line 295 of file CFitItem.cpp.

296  :
297  CFitItem(pParent, name),
298  mCheckConstraint(0),
300 {}
C_FLOAT64 mConstraintViolation
Definition: CFitItem.h:318
C_INT32 mCheckConstraint
Definition: CFitItem.h:313
CFitConstraint::CFitConstraint ( const CFitConstraint src,
const CCopasiContainer pParent = NULL 
)

Copy constructor

Parameters
constCFitItem & src
constCCopasiContainer * pParent (default: src data model)

Definition at line 302 of file CFitItem.cpp.

303  :
304  CFitItem(src, pParent),
307 {}
C_FLOAT64 mConstraintViolation
Definition: CFitItem.h:318
C_INT32 mCheckConstraint
Definition: CFitItem.h:313
CFitConstraint::CFitConstraint ( const CCopasiParameterGroup group,
const CCopasiContainer pParent = NULL 
)

Specific constructor used for reading COPASI files

Parameters
constCCopasiParameterGroup & group
constCCopasiContainer * pParent (default: group data model)

Definition at line 309 of file CFitItem.cpp.

310  :
311  CFitItem(group, pParent),
312  mCheckConstraint(0),
314 {}
C_FLOAT64 mConstraintViolation
Definition: CFitItem.h:318
C_INT32 mCheckConstraint
Definition: CFitItem.h:313
CFitConstraint::~CFitConstraint ( )
virtual

Destructor

Definition at line 316 of file CFitItem.cpp.

316 {}

Member Function Documentation

void CFitConstraint::calculateConstraintViolation ( )

Calculate and save the constraint violation

Definition at line 324 of file CFitItem.cpp.

References mCheckConstraint, mConstraintViolation, COptItem::mpLowerBound, COptItem::mpObjectValue, and COptItem::mpUpperBound.

325 {
327  else if (*mpObjectValue > *mpUpperBound) mCheckConstraint = 1;
328  else mCheckConstraint = 0;
329 
330  switch (mCheckConstraint)
331  {
332  case - 1:
334  break;
335 
336  case 1:
337  mConstraintViolation += *mpObjectValue - *mpUpperBound;
338  break;
339 
340  default:
341  break;
342  }
343 }
const C_FLOAT64 * mpUpperBound
Definition: COptItem.h:323
C_FLOAT64 mConstraintViolation
Definition: CFitItem.h:318
const C_FLOAT64 * mpLowerBound
Definition: COptItem.h:308
const C_FLOAT64 * mpObjectValue
Definition: COptItem.h:298
C_INT32 mCheckConstraint
Definition: CFitItem.h:313
C_INT32 CFitConstraint::checkConstraint ( ) const
virtual

This functions check whether the current value is within the limits of the constraint. The result depends on last performed calculateConstraintViolation, i.e., it may not be trusted.

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

Reimplemented from CFitItem.

Definition at line 345 of file CFitItem.cpp.

References mCheckConstraint.

346 {return mCheckConstraint;}
C_INT32 mCheckConstraint
Definition: CFitItem.h:313
C_FLOAT64 CFitConstraint::getConstraintViolation ( ) const
virtual

Retrieve the magnitude of the constraint violation This is always a positive number or 0. It is the sum of all constraint violation for a single function evaluation.

Returns
C_FLOAT64 constraintViolation;

Reimplemented from CFitItem.

Definition at line 348 of file CFitItem.cpp.

References mConstraintViolation.

349 {return mConstraintViolation;}
C_FLOAT64 mConstraintViolation
Definition: CFitItem.h:318
void CFitConstraint::resetConstraintViolation ( )

Reset the constraint violation

Definition at line 318 of file CFitItem.cpp.

References mCheckConstraint, and mConstraintViolation.

319 {
320  mCheckConstraint = 0;
321  mConstraintViolation = 0.0;
322 }
C_FLOAT64 mConstraintViolation
Definition: CFitItem.h:318
C_INT32 mCheckConstraint
Definition: CFitItem.h:313

Member Data Documentation

C_INT32 CFitConstraint::mCheckConstraint
private

The value that will be returned by checkConstraint

Definition at line 313 of file CFitItem.h.

Referenced by calculateConstraintViolation(), checkConstraint(), and resetConstraintViolation().

C_FLOAT64 CFitConstraint::mConstraintViolation
private

The value that will be returned by getConstraintViolation

Definition at line 318 of file CFitItem.h.

Referenced by calculateConstraintViolation(), getConstraintViolation(), and resetConstraintViolation().


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