CFitProblem Class Reference

#include <CFitProblem.h>

Inheritance diagram for CFitProblem:

List of all members.

Public Member Functions
	CFitProblem (const CCopasiTask::Type &type=CCopasiTask::parameterFitting, const CCopasiContainer *pParent=NULL)
	CFitProblem (const CFitProblem &src, const CCopasiContainer *pParent=NULL)
virtual	~CFitProblem ()
virtual bool	elevateChildren ()
virtual bool	setModel (CModel *pModel)
virtual bool	setCallBack (CProcessReport *pCallBack)
virtual bool	initialize ()
virtual bool	calculate ()
virtual bool	restore (const bool &updateModel)
virtual bool	checkFunctionalConstraints ()
virtual void	print (std::ostream *ostream) const
virtual void	printResult (std::ostream *ostream) const
bool	setResidualsRequired (const bool &required)
const CVector< C_FLOAT64 > &	getResiduals () const
virtual bool	calculateStatistics (const C_FLOAT64 &factor=1.0e-003, const C_FLOAT64 &resolution=1.0e-009)
const C_FLOAT64 &	getRMS () const
const C_FLOAT64 &	getStdDeviation () const
const CVector< C_FLOAT64 > &	getVariableStdDeviations () const
CArrayAnnotation &	getFisherInformation () const
CArrayAnnotation &	getCorrelations () const
const CExperimentSet &	getExperiementSet () const
bool	restoreTrajectoryProblem ()
Friends
std::ostream &	operator<< (std::ostream &os, const CFitProblem &o)

---

Constructor & Destructor Documentation

CFitProblem::CFitProblem	(	const CCopasiTask::Type &	type = CCopasiTask::parameterFitting,
		const CCopasiContainer *	pParent = NULL
	)

Default constructor

Parameters:

const	CCopasiTask::Type & type (default: parameterFitting)
const	CCopasiContainer * pParent (default: NULL)

CFitProblem::CFitProblem	(	const CFitProblem &	src,
		const CCopasiContainer *	pParent = NULL
	)

Copy constructor.

Parameters:

const

CFitProblem & src CCopasiContainer * pParent (default: NULL)

CFitProblem::~CFitProblem

(

)

[virtual]

Destructor

---

Member Function Documentation

bool CFitProblem::calculate

(

void

)

[virtual]

Do the calculation based on CalculateVariables and fill CalculateResults with the results.

Returns:

bool continue

Reimplemented from COptProblem.

bool CFitProblem::calculateStatistics	(	const C_FLOAT64 &	factor = 1.0e-003,
		const C_FLOAT64 &	resolution = 1.0e-009
	)		[virtual]

Calculate the statistics for the problem

Parameters:

const	C_FLOAT64 & factor (Default: 1.0e-003)
const	C_FLOAT64 & resolution (Default: 1.0e-009)

Reimplemented from COptProblem.

bool CFitProblem::checkFunctionalConstraints

(

)

[virtual]

Check whether all functional constraints are fullfilled.

Returns:

bool fullfilled

Reimplemented from COptProblem.

bool CFitProblem::elevateChildren

(

)

[virtual]

This methods must be called to elevate subgroups to derived objects. The default implementation does nothing.

Returns:

bool success

Reimplemented from COptProblem.

CArrayAnnotation & CFitProblem::getCorrelations

(

)

const

Retreive the correlations of the solution variables.

Returns:

CArrayAnnotation & variableCorrelations

const CExperimentSet & CFitProblem::getExperiementSet

(

)

const

Retreive the experiment set.

Returns:

const CExperimentSet & experiementSet

CArrayAnnotation & CFitProblem::getFisherInformation

(

)

const

Retreive the Fisher Information Matrix of the solution variables.

Returns:

CArrayAnnotation & variableCorrelations

const CVector< C_FLOAT64 > & CFitProblem::getResiduals

(

)

const

Retrieve the vector of residuals

Returns:

const CVector< C_FLOAT64 > & residuals

const C_FLOAT64 & CFitProblem::getRMS

(

)

const

Retreive the root mean square of the objective value.

Returns:

const C_FLOAT64 & RMS

const C_FLOAT64 & CFitProblem::getStdDeviation

(

)

const

Retreive the std. deviation of the objective value.

Returns:

const C_FLOAT64 & stdDeviation

const CVector< C_FLOAT64 > & CFitProblem::getVariableStdDeviations

(

)

const

Retreive the std. deviation for each solution variable.

Returns:

const CVector< C_FLOAT64 > & variableStdDeviations

bool CFitProblem::initialize

(

)

[virtual]

Do all neccessary initialization so that calls to caluclate will be successful. This is called once from CCopasiTask::process()

Returns:

bool succes

Reimplemented from COptProblem.

void CFitProblem::print

(

std::ostream *

ostream

)

const [virtual]

This is the output method for any object. The default implementation provided with CCopasiObject uses the ostream operator<< of the object to print the object.To overide this default behaviour one needs to reimplement the virtual print function.

Parameters:

std::ostream

* ostream

Reimplemented from COptProblem.

void CFitProblem::printResult

(

std::ostream *

ostream

)

const [virtual]

This is the output method for any result of a problem. The default implementation provided with CCopasiProblem. Does only print "Not implmented." To overide this default behaviour one needs to reimplement the virtual printResult function.

Parameters:

std::ostream

* ostream

Reimplemented from COptProblem.

bool CFitProblem::restore

(

const bool &

updateModel

)

[virtual]

Do all neccessary restore procedures so that the model is in the same state as before const bool & updateModel

Returns:

bool succes

Reimplemented from COptProblem.

bool CFitProblem::restoreTrajectoryProblem

(

)

Restore the trajectory problem

Returns:

bool succes

bool CFitProblem::setCallBack

(

CProcessReport *

pCallBack

)

[virtual]

Set the call back of the problem

Parameters:

CProcessReport

* pCallBack

Returns:

bool succes

Reimplemented from COptProblem.

bool CFitProblem::setModel

(

CModel *

pModel

)

[virtual]

Set the model of the problem

Parameters:

CModel

* pModel

Returns:

bool succes

Reimplemented from COptProblem.

bool CFitProblem::setResidualsRequired

(

const bool &

required

)

Set residual required

Parameters:

const

bool & required

Returns:

bool success

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const CFitProblem &	o
	)		[friend]

Output stream operator

Parameters:

ostream	& os
const	CFitProblem & A

Returns:

ostream & os

---

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

• copasi/parameterFitting/CFitProblem.h
• copasi/parameterFitting/CFitProblem.cpp