CFitConstraint Class Reference

#include <CFitItem.h>

Inheritance diagram for CFitConstraint:

List of all members.

Public Member Functions
	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	~CFitConstraint ()
void	resetConstraintViolation ()
void	calculateConstraintViolation ()
virtual C_INT32	checkConstraint () const
virtual C_FLOAT64	getConstraintViolation () const
Protected Member Functions
	CFitConstraint ()

---

Constructor & Destructor Documentation

CFitConstraint::CFitConstraint

(

)

[protected]

Default constructor

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

Specific constructor

Parameters:

const	CCopasiContainer * pParent
const	std::string & name (default: FitItem)

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

Copy constructor

Parameters:

const	CFitItem & src
const	CCopasiContainer * pParent (default: src data model)

CFitConstraint::CFitConstraint	(	const CCopasiParameterGroup &	group,
		const CCopasiContainer *	pParent = NULL
	)

Specific constructor used for reading COPASI files

Parameters:

const	CCopasiParameterGroup & group
const	CCopasiContainer * pParent (default: group data model)

CFitConstraint::~CFitConstraint

(

)

[virtual]

Destructor

---

Member Function Documentation

void CFitConstraint::calculateConstraintViolation

(

)

Calculate and save the constraint violation

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.

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.

void CFitConstraint::resetConstraintViolation

(

)

Reset the constraint violation

---

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

• copasi/parameterFitting/CFitItem.h
• copasi/parameterFitting/CFitItem.cpp