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

#include <CEFMMethod.h>

Inheritance diagram for CEFMMethod:
CCopasiMethod CCopasiParameterGroup CCopasiParameter CCopasiContainer CCopasiObject CBitPatternMethod CBitPatternTreeMethod CEFMAlgorithm

List of all members.

Public Member Functions

 CEFMMethod (const CEFMMethod &src, const CCopasiContainer *pParent=NULL)
virtual ~CEFMMethod ()
virtual bool calculate ()
virtual bool initialize ()
virtual bool isValidProblem (const CCopasiProblem *pProblem)

Static Public Member Functions

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

Protected Member Functions

 CEFMMethod (const CCopasiTask::Type &taskType, const SubType &subType, const CCopasiContainer *pParent=NULL)

Protected Attributes

std::vector< CFluxMode > * mpFluxModes
std::vector< const CReaction * > * mpReorderedReactions

Constructor & Destructor Documentation

CEFMMethod::CEFMMethod ( 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)
CEFMMethod::CEFMMethod ( const CEFMMethod src,
const CCopasiContainer pParent = NULL 
)

Copy constructor

Parameters:
constCEFMMethod & src
constCCopasiContainer * pParent (default: NULL)
CEFMMethod::~CEFMMethod ( ) [virtual]

Destructor


Member Function Documentation

bool CEFMMethod::calculate ( 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 CBitPatternMethod, CBitPatternTreeMethod, and CEFMAlgorithm.

CEFMMethod * CEFMMethod::createMethod ( CCopasiMethod::SubType  subType = CCopasiMethod::RandomSearch) [static]

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

CEFMMethod 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

bool CEFMMethod::initialize ( ) [virtual]

Initialize arrays and pointer.

Returns:
bool success

Reimplemented in CBitPatternMethod, CBitPatternTreeMethod, and CEFMAlgorithm.

bool CEFMMethod::isValidProblem ( const CCopasiProblem pProblem) [virtual]

Check if the method is suitable for this problem

Returns:
bool suitability of the method

Reimplemented from CCopasiMethod.


Member Data Documentation

std::vector< CFluxMode >* CEFMMethod::mpFluxModes [protected]

The resulting elementary flux modes

std::vector< const CReaction * >* CEFMMethod::mpReorderedReactions [protected]

Reactions in the order used in the analysis


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