COPASI API  4.40.278
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
COptMethod Class Reference

#include <COptMethod.h>

Inheritance diagram for COptMethod:
[legend]

Public Member Functions

 COptMethod (const CDataContainer *pParent, const CTaskEnum::Method &methodType, const CTaskEnum::Task &taskType, const bool &parallel)
 
 COptMethod (const COptMethod &src, const CDataContainer *pParent)
 
virtual const CVector< C_FLOAT64 > * getBestParameters () const
 
virtual C_FLOAT64 getBestValue () const
 
virtual const CVector< C_FLOAT64 > * getCurrentParameters () const
 
virtual C_FLOAT64 getCurrentValue () const
 
virtual unsigned C_INT32 getMaxLogVerbosity () const
 
const COptLog & getMethodLog () const
 
virtual bool initialize ()
 
virtual bool isValidProblem (const CCopasiProblem *pProblem)
 
virtual bool optimise ()
 
void setProblem (COptProblem *problem)
 
virtual ~COptMethod ()
 
- Public Member Functions inherited from CCopasiMethod
 CCopasiMethod (const CCopasiMethod &src, const CDataContainer *pParent)
 
virtual void clearCallBack ()
 
const CProcessReportLevel & getCallBack () const
 
CMathContainer * getMathContainer () const
 
const CTaskEnum::Method & getSubType () const
 
const CTaskEnum::Task & getType () const
 
virtual void load (CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::SEARCH)
 
CCopasiMethod & operator= (const CCopasiMethod &rhs)
 
virtual void print (std::ostream *ostream) const
 
virtual void printResult (std::ostream *ostream) const
 
virtual bool setCallBack (CProcessReportLevel callBack)
 
void setMathContainer (CMathContainer *pContainer)
 
virtual ~CCopasiMethod ()
 
- 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 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
 
virtual std::string getObjectDisplayName () 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
 
virtual void * getValuePointer () const override
 
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)
 
virtual void calculateValue () override
 
 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 ()
 

Protected Member Functions

virtual bool cleanup ()
 
virtual void signalMathContainerChanged ()
 
- Protected Member Functions inherited from CCopasiMethod
 CCopasiMethod (const CCopasiMethod &src)
 
 CCopasiMethod (const CDataContainer *pParent, const CTaskEnum::Method &methodType, const CTaskEnum::Task &taskType)
 
- 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)
 

Static Protected Member Functions

static std::pair< C_FLOAT64, bool > objectiveValue (COptProblem *pProblem, const CVectorCore< C_FLOAT64 > &parameters)
 
static void reflect (COptProblem *pProblem, const C_FLOAT64 &bestValue, C_FLOAT64 &objectiveValue)
 

Protected Attributes

unsigned C_INT32 mLogVerbosity
 
CMathContext mMathContext
 
COptLog mMethodLog
 
bool mParallel
 
COptTask * mpParentTask
 
COptProblemContext mProblemContext
 
- Protected Attributes inherited from CCopasiMethod
CMathContainer * mpContainer
 
CProcessReportLevel mProcessReport
 
- 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

 COptMethod ()
 

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 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 *)
 
- 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

◆ COptMethod() [1/3]

COptMethod::COptMethod ( )
private

Default constructor.

◆ COptMethod() [2/3]

COptMethod::COptMethod ( const CDataContainer *  pParent,
const CTaskEnum::Method &  methodType,
const CTaskEnum::Task &  taskType,
const bool &  parallel 
)

Specific constructor

Parameters
constCDataContainer * pParent
constCTaskEnum::Method & methodType
constCTaskEnum::Task & taskType
constbool & parallel

COptMethod class This class describes the interface to all optimization methods. The various method like RandomSearch or GA have to be derived from this class.

Created for COPASI by Stefan Hoops 2002

References CCopasiParameterGroup::assertParameter(), C_INT32, CCopasiParameter::editable, and CCopasiParameter::UINT.

◆ COptMethod() [3/3]

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

Copy constructor

Parameters
constCOptMethod & src
constCDataContainer * pParent (default: NULL)

References CContext< Data >::master(), mMathContext, mProblemContext, CPointerContext< Data >::setMaster(), CPointerContextWithParent< Data >::setMaster(), and CPointerMathContext< Data >::setMathContext().

◆ ~COptMethod()

COptMethod::~COptMethod ( )
virtual

Destructor

Member Function Documentation

◆ cleanup()

bool COptMethod::cleanup ( )
protectedvirtual

Cleanup arrays and pointers.

Returns
bool success

Reimplemented in COptPopulationMethod, COptMethodTruncatedNewton, COptMethodSteepestDescent, COptMethodSS, COptMethodSRES, COptMethodSA, COptMethodPS, COptMethodPraxis, COptMethodNL2SOL, COptMethodNelderMead, COptMethodLevenbergMarquardt, COptMethodHookeJeeves, COptMethodGASR, COptMethodGA, COptMethodEP, COptMethodDE, and COptMethodCoranaWalk.

Referenced by COptMethodStatistics::initialize(), CRandomSearch::initialize(), COptMethodStatistics::~COptMethodStatistics(), and CRandomSearch::~CRandomSearch().

◆ getBestParameters()

const CVector< C_FLOAT64 > * COptMethod::getBestParameters ( ) const
virtual
Returns
a the best parameters found

Reimplemented in CRandomSearch, COptMethodTruncatedNewton, COptMethodSteepestDescent, COptMethodStatistics, COptMethodSA, COptMethodPraxis, COptMethodNL2SOL, COptMethodNelderMead, COptMethodLevenbergMarquardt, COptMethodHookeJeeves, and COptMethodCoranaWalk.

◆ getBestValue()

C_FLOAT64 COptMethod::getBestValue ( ) const
virtual
Returns
the objective value

Reimplemented in CRandomSearch, COptMethodTruncatedNewton, COptMethodSteepestDescent, COptMethodStatistics, COptMethodSA, COptMethodPraxis, COptMethodNL2SOL, COptMethodNelderMead, COptMethodLevenbergMarquardt, COptMethodHookeJeeves, and COptMethodCoranaWalk.

◆ getCurrentParameters()

const CVector< C_FLOAT64 > * COptMethod::getCurrentParameters ( ) const
virtual
Returns
a the current guess for parameters

Reimplemented in CRandomSearch, COptMethodTruncatedNewton, COptMethodSteepestDescent, COptMethodStatistics, COptMethodSA, COptMethodPraxis, COptMethodNL2SOL, COptMethodNelderMead, COptMethodLevenbergMarquardt, COptMethodHookeJeeves, and COptMethodCoranaWalk.

◆ getCurrentValue()

C_FLOAT64 COptMethod::getCurrentValue ( ) const
virtual
Returns
the objective value

Reimplemented in CRandomSearch, COptMethodTruncatedNewton, COptMethodSteepestDescent, COptMethodStatistics, COptMethodSA, COptMethodPraxis, COptMethodNL2SOL, COptMethodNelderMead, COptMethodLevenbergMarquardt, COptMethodHookeJeeves, and COptMethodCoranaWalk.

◆ getMaxLogVerbosity()

unsigned C_INT32 COptMethod::getMaxLogVerbosity ( ) const
virtual

Returns the maximum verbosity (0 - Basic; 1 - Iterative; 2 - Detailed) at which the method can log.

Reimplemented in CRandomSearch, COptMethodTruncatedNewton, COptMethodSteepestDescent, COptMethodSRES, COptMethodSA, COptMethodPS, COptMethodPraxis, COptMethodNL2SOL, COptMethodNelderMead, COptMethodLevenbergMarquardt, COptMethodHookeJeeves, COptMethodGASR, COptMethodGA, COptMethodEP, COptMethodDE, and COptMethodCoranaWalk.

◆ getMethodLog()

const COptLog & COptMethod::getMethodLog ( ) const

Retrieve the log of the solution

References mMethodLog.

◆ initialize()

bool COptMethod::initialize ( )
virtual

Initialize arrays and pointer.

Returns
bool success

Reimplemented in CRandomSearch, COptPopulationMethod, COptMethodTruncatedNewton, COptMethodSteepestDescent, COptMethodStatistics, COptMethodSS, COptMethodSRES, COptMethodSA, COptMethodPS, COptMethodPraxis, COptMethodNL2SOL, COptMethodNelderMead, COptMethodLevenbergMarquardt, COptMethodHookeJeeves, COptMethodGASR, COptMethodGA, COptMethodEP, COptMethodDE, and COptMethodCoranaWalk.

References CContext< Data >::beginThread(), CContext< Data >::endThread(), CDataObject::getObjectParent(), CContext< Data >::isThread(), CContext< Data >::master(), mLogVerbosity, mMathContext, mMethodLog, mpParentTask, mProblemContext, CPointerMathContext< Data >::setMathContext(), and CMathContext::sync().

Referenced by COptMethodCoranaWalk::initialize(), COptMethodHookeJeeves::initialize(), COptMethodLevenbergMarquardt::initialize(), COptMethodNelderMead::initialize(), COptMethodNL2SOL::initialize(), COptMethodPraxis::initialize(), COptMethodSA::initialize(), COptMethodStatistics::initialize(), COptMethodSteepestDescent::initialize(), COptMethodTruncatedNewton::initialize(), COptPopulationMethod::initialize(), and CRandomSearch::initialize().

◆ isValidProblem()

bool COptMethod::isValidProblem ( const CCopasiProblem *  pProblem)
virtual

Check if the method is suitable for this problem

Returns
bool suitability of the method

Reimplemented from CCopasiMethod.

References CCopasiMessage::EXCEPTION, and CCopasiMethod::isValidProblem().

◆ objectiveValue()

std::pair< C_FLOAT64, bool > COptMethod::objectiveValue ( COptProblem *  pProblem,
const CVectorCore< C_FLOAT64 > &  parameters 
)
staticprotected

Calculate the objective value for the provided parameter set

Parameters
COptProblem* pProblem
constCVectorCore< C_FLOAT64 > & parameters
Returns
std::pair< C_FLOAT64 objectiveValue, bool continue >

References COptProblem::calculate(), COptProblem::getCalculateValue(), and COptProblem::setParameters().

Referenced by reflect().

◆ optimise()

bool COptMethod::optimise ( void  )
virtual

Execute the optimization algorithm calling simulation routine when needed. It is noted that this procedure can give feedback of its progress by the callback function set with SetCallback. @ return success;

Reimplemented in CRandomSearch, COptMethodTruncatedNewton, COptMethodSteepestDescent, COptMethodStatistics, COptMethodSS, COptMethodSRES, COptMethodSA, COptMethodPS, COptMethodPraxis, COptMethodNL2SOL, COptMethodNelderMead, COptMethodLevenbergMarquardt, COptMethodHookeJeeves, COptMethodGASR, COptMethodGA, COptMethodEP, COptMethodDE, and COptMethodCoranaWalk.

Referenced by COptMethodSS::localmin(), COptTask::process(), CFitTask::process(), and TestOptimization().

◆ reflect()

void COptMethod::reflect ( COptProblem *  pProblem,
const C_FLOAT64 &  bestValue,
C_FLOAT64 &  objectiveValue 
)
staticprotected

Reflect the objective value if it is outside the parametric or functional domain

Parameters
COptProblem* pProblem
constC_FLOAT64 & bestValue
C_FLOAT64& objectiveValue

References COptProblem::checkFunctionalConstraints(), COptProblem::checkParametricConstraints(), and objectiveValue().

◆ setProblem()

void COptMethod::setProblem ( COptProblem *  problem)

Set the problem to be optimized

Parameters
COptProblem *problem

References mMathContext, mProblemContext, CPointerContextWithParent< Data >::setMaster(), and CPointerMathContext< Data >::setMathContext().

Referenced by COptMethodSS::initialize(), COptTask::initialize(), and TestOptimization().

◆ signalMathContainerChanged()

void COptMethod::signalMathContainerChanged ( )
protectedvirtual

Signal that the math container has changed

Reimplemented from CCopasiMethod.

References mMathContext, CCopasiMethod::mpContainer, mProblemContext, CPointerContext< Data >::setMaster(), and CPointerMathContext< Data >::setMathContext().

Member Data Documentation

◆ mLogVerbosity

unsigned C_INT32 COptMethod::mLogVerbosity
protected

Define the current verbosity for the log

Referenced by COptMethodEP::creation(), COptMethodSRES::creation(), COptMethodPS::dumpStatus(), initialize(), COptMethodDE::initialize(), COptMethodGASR::initialize(), COptMethodPS::initialize(), COptMethodSRES::initialize(), COptMethodCoranaWalk::optimise(), COptMethodDE::optimise(), COptMethodEP::optimise(), COptMethodGA::optimise(), COptMethodGASR::optimise(), COptMethodHookeJeeves::optimise(), COptMethodLevenbergMarquardt::optimise(), COptMethodNelderMead::optimise(), COptMethodNL2SOL::optimise(), COptMethodPraxis::optimise(), COptMethodPS::optimise(), COptMethodSA::optimise(), COptMethodSRES::optimise(), COptMethodSteepestDescent::optimise(), COptMethodTruncatedNewton::optimise(), CRandomSearch::optimise(), and COptMethodTruncatedNewton::sFun().

◆ mMathContext

CMathContext COptMethod::mMathContext
protected

A thread specific math container

Referenced by COptMethod(), initialize(), setProblem(), and signalMathContainerChanged().

◆ mMethodLog

COptLog COptMethod::mMethodLog
protected

The Log created during parameter estimation

Referenced by COptMethodEP::creation(), COptMethodSRES::creation(), getMethodLog(), initialize(), COptMethodDE::initialize(), COptMethodGASR::initialize(), COptMethodPS::initialize(), COptMethodSRES::initialize(), COptMethodCoranaWalk::optimise(), COptMethodDE::optimise(), COptMethodEP::optimise(), COptMethodGA::optimise(), COptMethodGASR::optimise(), COptMethodHookeJeeves::optimise(), COptMethodLevenbergMarquardt::optimise(), COptMethodNelderMead::optimise(), COptMethodNL2SOL::optimise(), COptMethodPraxis::optimise(), COptMethodPS::optimise(), COptMethodSA::optimise(), COptMethodSRES::optimise(), COptMethodSteepestDescent::optimise(), COptMethodTruncatedNewton::optimise(), CRandomSearch::optimise(), and COptMethodTruncatedNewton::sFun().

◆ mParallel

bool COptMethod::mParallel
protected

Boolean indicating whether this method con use parallel execution.

◆ mpParentTask

COptTask* COptMethod::mpParentTask
protected

The parent task

Referenced by COptMethodNL2SOL::calcr(), COptMethodPS::create(), COptMethodPraxis::evaluateFunction(), initialize(), COptMethodPS::move(), COptMethodCoranaWalk::optimise(), COptMethodDE::optimise(), COptMethodEP::optimise(), COptMethodGA::optimise(), COptMethodGASR::optimise(), COptMethodHookeJeeves::optimise(), COptMethodLevenbergMarquardt::optimise(), COptMethodNelderMead::optimise(), COptMethodNL2SOL::optimise(), COptMethodPraxis::optimise(), COptMethodPS::optimise(), COptMethodSA::optimise(), COptMethodSRES::optimise(), COptMethodSS::optimise(), COptMethodStatistics::optimise(), COptMethodSteepestDescent::optimise(), COptMethodTruncatedNewton::optimise(), CRandomSearch::optimise(), and COptMethodTruncatedNewton::sFun().

◆ mProblemContext

COptProblemContext COptMethod::mProblemContext
protected

A thread specific problem

Referenced by COptMethodHookeJeeves::bestNearby(), COptMethodNL2SOL::calcr(), COptMethodSS::combination(), COptMethod(), COptMethodPS::create(), COptMethodEP::creation(), COptMethodSRES::creation(), COptMethodDE::creation(), COptMethodGA::creation(), COptMethodGASR::creation(), COptMethodSS::creation(), COptMethodSteepestDescent::descentLine(), COptMethodCoranaWalk::evaluate(), COptMethodHookeJeeves::evaluate(), COptMethodLevenbergMarquardt::evaluate(), COptMethodNelderMead::evaluate(), COptMethodNL2SOL::evaluate(), COptMethodPraxis::evaluate(), COptMethodPS::evaluate(), COptMethodSA::evaluate(), COptMethodSteepestDescent::evaluate(), COptMethodTruncatedNewton::evaluate(), COptMethodDE::evaluate(), COptMethodEP::evaluate(), COptMethodGA::evaluate(), COptMethodGASR::evaluate(), COptMethodSRES::evaluate(), COptMethodSS::evaluate(), COptMethodStatistics::evaluate(), CRandomSearch::evaluate(), COptMethodPraxis::evaluateFunction(), COptMethodLevenbergMarquardt::gradient(), COptMethodSteepestDescent::gradient(), COptMethodLevenbergMarquardt::hessian(), initialize(), COptMethodCoranaWalk::initialize(), COptMethodEP::initialize(), COptMethodHookeJeeves::initialize(), COptMethodLevenbergMarquardt::initialize(), COptMethodNelderMead::initialize(), COptMethodNL2SOL::initialize(), COptMethodPraxis::initialize(), COptMethodSA::initialize(), COptMethodSRES::initialize(), COptMethodSS::initialize(), COptMethodStatistics::initialize(), COptMethodSteepestDescent::initialize(), COptMethodTruncatedNewton::initialize(), COptPopulationMethod::initialize(), CRandomSearch::initialize(), COptMethodSS::localmin(), COptMethodPS::move(), COptMethodSRES::mutate(), COptMethodGA::mutate(), COptMethodGASR::mutate(), COptMethodEP::mutate(), COptMethodCoranaWalk::optimise(), COptMethodDE::optimise(), COptMethodEP::optimise(), COptMethodGA::optimise(), COptMethodGASR::optimise(), COptMethodHookeJeeves::optimise(), COptMethodLevenbergMarquardt::optimise(), COptMethodNelderMead::optimise(), COptMethodNL2SOL::optimise(), COptMethodPraxis::optimise(), COptMethodPS::optimise(), COptMethodSA::optimise(), COptMethodSRES::optimise(), COptMethodSS::optimise(), COptMethodStatistics::optimise(), COptMethodSteepestDescent::optimise(), COptMethodTruncatedNewton::optimise(), CRandomSearch::optimise(), COptMethodGASR::phi(), COptMethodSRES::phi(), COptMethodSS::randomize(), COptMethodDE::replicate(), setProblem(), COptMethodTruncatedNewton::sFun(), and signalMathContainerChanged().

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