copasi API  0.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
COptMethod Class Reference

#include <COptMethod.h>

Inheritance diagram for COptMethod:
CCopasiMethod CCopasiParameterGroup CCopasiParameter CCopasiContainer CCopasiObject CFitMethod COptMethodEP COptMethodGA COptMethodGASR COptMethodHookeJeeves COptMethodLevenbergMarquardt COptMethodNelderMead COptMethodPraxis COptMethodPS COptMethodSA COptMethodSRES COptMethodStatistics COptMethodSteepestDescent COptMethodTruncatedNewton CRandomSearch

List of all members.

Public Member Functions

 COptMethod (const COptMethod &src, const CCopasiContainer *pParent=NULL)
virtual ~COptMethod ()
virtual bool optimise ()
bool isBounded (void)
void setProblem (COptProblem *problem)
virtual bool initialize ()
virtual bool isValidProblem (const CCopasiProblem *pProblem)

Static Public Member Functions

static COptMethodcreateMethod (CCopasiMethod::SubType subType=CCopasiMethod::RandomSearch)

Protected Member Functions

 COptMethod (const CCopasiTask::Type &taskType, const SubType &subType, const CCopasiContainer *pParent=NULL)
virtual bool cleanup ()

Protected Attributes

COptProblemmpOptProblem
COptTaskmpParentTask
const bool mBounds
const std::vector
< UpdateMethod * > * 
mpSetCalculateVariable
const std::vector< COptItem * > * mpOptItem
const std::vector< COptItem * > * mpOptContraints

Detailed Description

:pos 36.4,4.15


Constructor & Destructor Documentation

COptMethod::COptMethod ( const CCopasiTask::Type taskType,
const SubType subType,
const CCopasiContainer pParent = NULL 
) [protected]

Specific constructor

Parameters:
constCCopasiTask::Type & type
constCCopasiMethod::SubType & subType
constCCopasiContainer * pParent (default: NULL)
COptMethod::COptMethod ( const COptMethod src,
const CCopasiContainer pParent = NULL 
)

Copy constructor

Parameters:
constCOptMethod & src
constCCopasiContainer * pParent (default: NULL)
COptMethod::~COptMethod ( ) [virtual]

Destructor


Member Function Documentation

bool COptMethod::cleanup ( ) [protected, virtual]

Cleanup arrays and pointers.

Returns:
bool success
COptMethod * COptMethod::createMethod ( CCopasiMethod::SubType  subType = CCopasiMethod::RandomSearch) [static]

Create a optimization method. Note: the returned object has to be released after use with delete

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

Reimplemented in CFitMethod.

bool COptMethod::initialize ( ) [virtual]

Initialize arrays and pointer.

Returns:
bool success

Reimplemented in CFitMethod.

bool COptMethod::isBounded ( void  )

Returns True if this method is capable of handling adjustable parameter boundary constraints, False otherwise

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.

Reimplemented in CFitMethod.

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, COptMethodEP, COptMethodStatistics, COptMethodSteepestDescent, COptMethodPraxis, COptMethodTruncatedNewton, COptMethodGASR, COptMethodGA, COptMethodLevenbergMarquardt, COptMethodNelderMead, COptMethodPS, COptMethodSA, COptMethodHookeJeeves, and COptMethodSRES.

void COptMethod::setProblem ( COptProblem problem)

Set the problem to be optmised

Parameters:
COptProblem *problem

Member Data Documentation

const bool COptMethod::mBounds [protected]
const std::vector< COptItem * >* COptMethod::mpOptContraints [protected]

A vector of pointers to the functional constraints

const std::vector< COptItem * >* COptMethod::mpOptItem [protected]

A vector of pointers to the optimization parameter

:route 0,2; h,36.4,4.15,33.95,4.15,23.0576

const std::vector< UpdateMethod * >* COptMethod::mpSetCalculateVariable [protected]

A vector of pointers to the update methods for the optimization parameters


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines