#include <COptMethodTruncatedNewton.h>

Inheritance diagram for COptMethodTruncatedNewton:

Collaboration diagram for COptMethodTruncatedNewton:

Public Member Functions
	COptMethodTruncatedNewton (const COptMethodTruncatedNewton &src, const CCopasiContainer *pParent=NULL)

virtual bool	optimise ()

virtual	~COptMethodTruncatedNewton ()

Public Member Functions inherited from COptMethod
	COptMethod (const COptMethod &src, const CCopasiContainer *pParent=NULL)

bool	isBounded (void)

virtual bool	isValidProblem (const CCopasiProblem *pProblem)

void	setProblem (COptProblem *problem)

virtual	~COptMethod ()

Public Member Functions inherited from CCopasiMethod
	CCopasiMethod (const CCopasiMethod &src, const CCopasiContainer *pParent=NULL)

const CCopasiMethod::SubType &	getSubType () const

const CCopasiTask::Type &	getType () const

virtual void	load (CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::SEARCH)

virtual void	print (std::ostream *ostream) const

virtual void	printResult (std::ostream *ostream) const

virtual bool	setCallBack (CProcessReport *pCallBack)

virtual	~CCopasiMethod ()

Public Member Functions inherited from CCopasiParameterGroup
bool	addGroup (const std::string &name)

bool	addParameter (const CCopasiParameter &parameter)

bool	addParameter (const std::string &name, const CCopasiParameter::Type type)

template<class CType >
bool	addParameter (const std::string &name, const CCopasiParameter::Type type, const CType &value)

void	addParameter (CCopasiParameter *pParameter)

CCopasiParameterGroup *	assertGroup (const std::string &name)

template<class CType >
CCopasiParameter *	assertParameter (const std::string &name, const CCopasiParameter::Type type, const CType &defaultValue)

index_iterator	beginIndex () const

name_iterator	beginName () const

	CCopasiParameterGroup (const CCopasiParameterGroup &src, const CCopasiContainer *pParent=NULL)

	CCopasiParameterGroup (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &objectType="ParameterGroup")

void	clear ()

virtual bool	elevateChildren ()

index_iterator	endIndex () const

name_iterator	endName () const

CCopasiParameterGroup *	getGroup (const std::string &name)

const CCopasiParameterGroup *	getGroup (const std::string &name) const

CCopasiParameterGroup *	getGroup (const size_t &index)

const CCopasiParameterGroup *	getGroup (const size_t &index) const

size_t	getIndex (const std::string &name) const

std::string	getKey (const std::string &name) const

std::string	getKey (const size_t &index) const

virtual const std::string &	getName (const size_t &index) const

virtual const CObjectInterface *	getObject (const CCopasiObjectName &cn) const

CCopasiParameter *	getParameter (const std::string &name)

const CCopasiParameter *	getParameter (const std::string &name) const

CCopasiParameter *	getParameter (const size_t &index)

const CCopasiParameter *	getParameter (const size_t &index) const

CCopasiParameter::Type	getType (const std::string &name) const

CCopasiParameter::Type	getType (const size_t &index) const

std::string	getUniqueParameterName (const CCopasiParameter *pParameter) const

const CCopasiParameter::Value &	getValue (const std::string &name) const

const CCopasiParameter::Value &	getValue (const size_t &index) const

CCopasiParameter::Value &	getValue (const std::string &name)

CCopasiParameter::Value &	getValue (const size_t &index)

CCopasiParameterGroup &	operator= (const CCopasiParameterGroup &rhs)

bool	removeParameter (const std::string &name)

bool	removeParameter (const size_t &index)

template<class CType >
bool	setValue (const std::string &name, const CType &value)

template<class CType >
bool	setValue (const size_t &index, const CType &value)

size_t	size () const

bool	swap (const size_t &iFrom, const size_t &iTo)

bool	swap (index_iterator &from, index_iterator &to)

virtual	~CCopasiParameterGroup ()

Public Member Functions inherited from CCopasiParameter
	CCopasiParameter (const CCopasiParameter &src, const CCopasiContainer *pParent=NULL)

	CCopasiParameter (const std::string &name, const Type &type, const void pValue=NULL, const CCopasiContainer pParent=NULL, const std::string &objectType="Parameter")

virtual CCopasiObjectName	getCN () const

virtual const std::string &	getKey () const

virtual std::string	getObjectDisplayName (bool regular=true, bool richtext=false) const

const CCopasiParameter::Type &	getType () const

const Value &	getValue () const

Value &	getValue ()

virtual void *	getValuePointer () const

CCopasiObject *	getValueReference () const

bool	isValidValue (const C_FLOAT64 &value) const

bool	isValidValue (const C_INT32 &value) const

bool	isValidValue (const unsigned C_INT32 &value) const

bool	isValidValue (const bool &value) const

bool	isValidValue (const std::string &value) const

bool	isValidValue (const CCopasiObjectName &value) const

bool	isValidValue (const std::vector< CCopasiParameter * > &value) const

CCopasiParameter &	operator= (const CCopasiParameter &rhs)

template<class CType >
bool	setValue (const CType &value)

bool	setValue (const std::vector< CCopasiParameter * > &value)

virtual	~CCopasiParameter ()

Public Member Functions inherited from CCopasiContainer
virtual bool	add (CCopasiObject *pObject, const bool &adopt=true)

	CCopasiContainer (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &type="CN", const unsigned C_INT32 &flag=CCopasiObject::Container)

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

virtual std::string	getChildObjectUnits (const CCopasiObject *pObject) const

virtual const objectMap &	getObjects () const

virtual std::string	getUnits () const

virtual const CCopasiObject *	getValueObject () const

virtual bool	remove (CCopasiObject *pObject)

virtual	~CCopasiContainer ()

Public Member Functions inherited from CCopasiObject
void	addDirectDependency (const CCopasiObject *pObject)

	CCopasiObject (const CCopasiObject &src, const CCopasiContainer *pParent=NULL)

void	clearDirectDependencies ()

void	clearRefresh ()

bool	dependsOn (DataObjectSet candidates, const DataObjectSet &context=DataObjectSet()) const

void	getAllDependencies (DataObjectSet &dependencies, const DataObjectSet &context) const

virtual const DataObjectSet &	getDirectDependencies (const DataObjectSet &context=DataObjectSet()) const

CCopasiContainer *	getObjectAncestor (const std::string &type) const

CCopasiDataModel *	getObjectDataModel ()

const CCopasiDataModel *	getObjectDataModel () const

const std::string &	getObjectName () const

CCopasiContainer *	getObjectParent () const

const std::string &	getObjectType () const

virtual const CObjectInterface::ObjectSet &	getPrerequisites () const

virtual Refresh *	getRefresh () const

UpdateMethod *	getUpdateMethod () const

bool	hasCircularDependencies (DataObjectSet &candidates, DataObjectSet &verified, const DataObjectSet &context) const

bool	hasUpdateMethod () const

bool	isArray () const

bool	isContainer () const

bool	isDataModel () const

bool	isMatrix () const

bool	isNameVector () const

bool	isNonUniqueName () const

virtual bool	isPrerequisiteForContext (const CObjectInterface *pObject, const CMath::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const

bool	isReference () const

bool	isRoot () const

bool	isSeparator () const

bool	isStaticString () const

bool	isValueBool () const

bool	isValueDbl () const

bool	isValueInt () const

bool	isValueInt64 () const

bool	isValueString () const

bool	isVector () const

virtual bool	mustBeDeleted (const DataObjectSet &deletedObjects) const

void	removeDirectDependency (const CCopasiObject *pObject)

void	setDirectDependencies (const DataObjectSet &directDependencies)

bool	setObjectName (const std::string &name)

virtual bool	setObjectParent (const CCopasiContainer *pParent)

void	setObjectValue (const C_FLOAT64 &value)

void	setObjectValue (const C_INT32 &value)

void	setObjectValue (const bool &value)

template<class CType >
void	setRefresh (CType pType, void(CType::method)(void))

template<class CType >
void	setUpdateMethod (CType pType, void(CType::method)(const C_FLOAT64 &))

template<class CType >
void	setUpdateMethod (CType pType, void(CType::method)(const C_INT32 &))

template<class CType >
void	setUpdateMethod (CType pType, void(CType::method)(const bool &))

virtual	~CCopasiObject ()

Public Member Functions inherited from CObjectInterface
	CObjectInterface ()

virtual	~CObjectInterface ()

Private Member Functions
virtual bool	cleanup ()

	COptMethodTruncatedNewton (const CCopasiContainer *pParent=NULL)

const C_FLOAT64 &	evaluate ()

bool	evaluateFunction (C_INT n, C_FLOAT64 x, C_FLOAT64 *f)

virtual bool	initialize ()

void	initObjects ()

C_INT	sFun (C_INT , C_FLOAT64 , C_FLOAT64 , C_FLOAT64 )

Private Attributes
CVector< C_FLOAT64 >	mBest

C_FLOAT64	mBestValue

bool	mContinue

CVector< C_FLOAT64 >	mCurrent

C_FLOAT64	mEvaluationValue

CVector< C_FLOAT64 >	mGradient

unsigned C_INT32	mhIteration

unsigned C_INT32	mIteration

CTruncatedNewton *	mpCTruncatedNewton

FTruncatedNewton *	mpTruncatedNewton

C_INT	mVariableSize

Friends
COptMethod *	COptMethod::createMethod (CCopasiMethod::SubType subType)

Additional Inherited Members
Public Types inherited from CCopasiMethod
enum	SubType { unset = 0, RandomSearch, RandomSearchMaster, SimulatedAnnealing, CoranaWalk, DifferentialEvolution, ScatterSearch, GeneticAlgorithm, EvolutionaryProgram, SteepestDescent, HybridGASA, GeneticAlgorithmSR, HookeJeeves, LevenbergMarquardt, NelderMead, SRES, Statistics, ParticleSwarm, Praxis, TruncatedNewton, Newton, deterministic, LSODAR, directMethod, stochastic, tauLeap, adaptiveSA, hybrid, hybridLSODA, hybridODE45, DsaLsodar, tssILDM, tssILDMModified, tssCSP, mcaMethodReder, scanMethod, lyapWolf, sensMethod, EFMAlgorithm, EFMBitPatternTreeAlgorithm, EFMBitPatternAlgorithm, Householder, crossSectionMethod, linearNoiseApproximation }

Public Types inherited from CCopasiParameterGroup
typedef parameterGroup::iterator	index_iterator

typedef CCopasiContainer::objectMap::iterator	name_iterator

typedef std::vector < CCopasiParameter * >	parameterGroup

Public Types inherited from CCopasiParameter
enum	Type { DOUBLE = 0, UDOUBLE, INT, UINT, BOOL, GROUP, STRING, CN, KEY, FILE, EXPRESSION, INVALID }

Public Types inherited from CCopasiContainer
typedef std::multimap < std::string, CCopasiObject * >	objectMap

Public Types inherited from CCopasiObject
typedef std::set< const CCopasiObject * >	DataObjectSet

typedef std::vector< Refresh * >	DataUpdateSequence

Public Types inherited from CObjectInterface
typedef std::set< const CObjectInterface * >	ObjectSet

typedef std::vector < CObjectInterface * >	UpdateSequence

Static Public Member Functions inherited from COptMethod
static COptMethod *	createMethod (CCopasiMethod::SubType subType=CCopasiMethod::RandomSearch)

Static Public Member Functions inherited from CCopasiObject
static std::vector< Refresh * >	buildUpdateSequence (const DataObjectSet &objects, const DataObjectSet &uptoDateObjects, const DataObjectSet &context=DataObjectSet())

static void	setRenameHandler (CRenameHandler *rh)

Static Public Attributes inherited from CCopasiMethod
static const std::string	SubTypeName []

static const char *	XMLSubType []

Static Public Attributes inherited from CCopasiParameter
static const std::string	TypeName []

static const char *	XMLType []

Static Public Attributes inherited from CCopasiContainer
static const std::vector < CCopasiContainer * >	EmptyList

Protected Types inherited from CCopasiObject
enum	Flag { Container = 0x1, Vector = 0x2, Matrix = 0x4, NameVector = 0x8, Reference = 0x10, ValueBool = 0x20, ValueInt = 0x40, ValueInt64 = 0x80, ValueDbl = 0x100, NonUniqueName = 0x200, StaticString = 0x400, ValueString = 0x800, Separator = 0x1000, ModelEntity = 0x2000, Array = 0x4000, DataModel = 0x8000, Root = 0x10000, Gui = 0x20000 }

Protected Member Functions inherited from COptMethod
	COptMethod (const CCopasiTask::Type &taskType, const SubType &subType, const CCopasiContainer *pParent=NULL)

Protected Member Functions inherited from CCopasiMethod
	CCopasiMethod (const CCopasiTask::Type &taskType, const SubType &subType, const CCopasiContainer *pParent=NULL)

Protected Member Functions inherited from CCopasiParameterGroup
	CCopasiParameterGroup ()

Protected Member Functions inherited from CCopasiContainer
template<class CType >
CCopasiObject *	addMatrixReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0)

template<class CType >
CCopasiObject *	addObjectReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0)

template<class CType >
CCopasiObject *	addVectorReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0)

void	initObjects ()

Protected Member Functions inherited from CCopasiObject
	CCopasiObject ()

	CCopasiObject (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &type="CN", const unsigned C_INT32 &flag=0)

Protected Attributes inherited from COptMethod
const bool	mBounds

const std::vector< COptItem * > *	mpOptContraints

const std::vector< COptItem * > *	mpOptItem

COptProblem *	mpOptProblem

COptTask *	mpParentTask

const std::vector < UpdateMethod * > *	mpSetCalculateVariable

Protected Attributes inherited from CCopasiMethod
CProcessReport *	mpCallBack

Protected Attributes inherited from CCopasiParameter
std::string	mKey

CCopasiObject *	mpValueReference

size_t	mSize

Value	mValue

Protected Attributes inherited from CCopasiContainer
objectMap	mObjects

Static Protected Attributes inherited from CCopasiObject
static CRenameHandler *	smpRenameHandler = NULL

Detailed Description

Definition at line 34 of file COptMethodTruncatedNewton.h.

Constructor & Destructor Documentation

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

Copy Constructor

Parameters

const	COptMethodTruncatedNewton & src
const	CCopasiContainer * pParent (default: NULL)

Definition at line 39 of file COptMethodTruncatedNewton.cpp.

References initObjects().

                                      :
     COptMethod(src, pParent),
     mpTruncatedNewton(new FTruncatedNewtonTemplate<COptMethodTruncatedNewton>(this, &COptMethodTruncatedNewton::sFun)),
     mpCTruncatedNewton(new CTruncatedNewton())
 {initObjects();}

COptMethodTruncatedNewton::~COptMethodTruncatedNewton ( )

virtual

Destructor

Definition at line 46 of file COptMethodTruncatedNewton.cpp.

References cleanup(), mpCTruncatedNewton, mpTruncatedNewton, and pdelete.

 {
   pdelete(mpTruncatedNewton);
   pdelete(mpCTruncatedNewton);
   cleanup();
 }

COptMethodTruncatedNewton::COptMethodTruncatedNewton ( const CCopasiContainer * pParent = NULL )

private

Default Constructor

Parameters

const CCopasiContainer * pParent (default: NULL)

Definition at line 33 of file COptMethodTruncatedNewton.cpp.

References initObjects().

                                                                                     :
     COptMethod(CCopasiTask::optimization, CCopasiMethod::TruncatedNewton, pParent),
     mpTruncatedNewton(new FTruncatedNewtonTemplate<COptMethodTruncatedNewton>(this, &COptMethodTruncatedNewton::sFun)),
     mpCTruncatedNewton(new CTruncatedNewton())
 {initObjects();}

Member Function Documentation

bool COptMethodTruncatedNewton::cleanup ( )

privatevirtual

Cleanup arrays and pointers.

Returns: bool success

Reimplemented from COptMethod.

Definition at line 256 of file COptMethodTruncatedNewton.cpp.

Referenced by initialize(), and ~COptMethodTruncatedNewton().

 {
   return true;
 }

const C_FLOAT64 & COptMethodTruncatedNewton::evaluate ( )

private

Evaluate the objective function

Returns: bool continue

Definition at line 313 of file COptMethodTruncatedNewton.cpp.

References COptProblem::calculate(), COptProblem::checkFunctionalConstraints(), COptProblem::checkParametricConstraints(), COptProblem::getCalculateValue(), mBestValue, mContinue, mEvaluationValue, and COptMethod::mpOptProblem.

Referenced by optimise(), and sFun().

 {
   // We do not need to check whether the parametric constraints are fulfilled
   // since the parameters are created within the bounds.
   mContinue = mpOptProblem->calculate();
   mEvaluationValue = mpOptProblem->getCalculateValue();
 
   // when we leave the either the parameter or functional domain
   // we penalize the objective value by forcing it to be larger
   // than the best value recorded so far.
   if (mEvaluationValue < mBestValue &&
       (!mpOptProblem->checkParametricConstraints() ||
        !mpOptProblem->checkFunctionalConstraints()))
     mEvaluationValue = mBestValue + mBestValue - mEvaluationValue;
 
   return mEvaluationValue;
 }

bool COptMethodTruncatedNewton::evaluateFunction	(	C_INT *	n,
		C_FLOAT64 *	x,
		C_FLOAT64 *	f
	)

private

objective function evaluation for specified parameters

bool COptMethodTruncatedNewton::initialize ( )

privatevirtual

Initialize arrays and pointer.

Returns: bool success

Reimplemented from COptMethod.

Definition at line 239 of file COptMethodTruncatedNewton.cpp.

References C_INT, cleanup(), COptMethod::initialize(), mBest, mBestValue, mContinue, mCurrent, mGradient, COptMethod::mpOptItem, mVariableSize, and CVector< CType >::resize().

Referenced by optimise().

 {
   cleanup();
 
   if (!COptMethod::initialize()) return false;
 
   mVariableSize = (C_INT) mpOptItem->size();
   mCurrent.resize(mVariableSize);
   mBest.resize(mVariableSize);
 
   mContinue = true;
   mBestValue = std::numeric_limits<C_FLOAT64>::infinity();
   mGradient.resize(mVariableSize);
 
   return true;
 }

void COptMethodTruncatedNewton::initObjects ( )

private

Initialize contained objects.

Definition at line 53 of file COptMethodTruncatedNewton.cpp.

References CCopasiContainer::addObjectReference(), mIteration, and CCopasiObject::ValueInt.

Referenced by COptMethodTruncatedNewton().

 {
   addObjectReference("Current Iteration", mIteration, CCopasiObject::ValueInt);
 }

bool COptMethodTruncatedNewton::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 from COptMethod.

Definition at line 58 of file COptMethodTruncatedNewton.cpp.

References CVectorCore< CType >::array(), C_FLOAT64, C_INT, COptItem::checkConstraint(), COutputInterface::DURING, evaluate(), fatalError, COptItem::getLowerBoundValue(), COptItem::getStartValue(), COptItem::getUpperBoundValue(), initialize(), max, mBest, mBestValue, mContinue, mCurrent, mEvaluationValue, mGradient, mpCTruncatedNewton, COptMethod::mpOptProblem, COptMethod::mpParentTask, mpTruncatedNewton, mVariableSize, CCopasiTask::output(), COptProblem::setSolution(), and CTruncatedNewton::tnbc_().

 {
   if (!initialize()) return false;
 
   C_FLOAT64 fest;
   C_INT lw, ierror = 0;
   lw = 14 * mVariableSize;
 
   CVector< C_FLOAT64 > up(mVariableSize);
   CVector< C_FLOAT64 > low(mVariableSize);
   CVector< C_INT > iPivot(mVariableSize);
   CVector< C_FLOAT64 > dwork(lw);
 
   up = std::numeric_limits< C_FLOAT64 >::max();
   low = - std::numeric_limits< C_FLOAT64 >::max();
 
   // initial point is the first guess but we have to make sure that
   // we are within the parameter domain
   C_INT i, repeat;
 
   for (i = 0; i < mVariableSize; i++)
     {
       const COptItem & OptItem = *(*mpOptItem)[i];
 
       // :TODO: In COPASI the bounds are not necessarry fixed.
       // Since evaluate checks for boundaries and constraints this is not
       // needed. The question remaining is how does tnbc_ handle unconstraint problems?
       // low[i] = *OptItem.getLowerBoundValue();
       // up[i] = *OptItem.getUpperBoundValue();
 
       mCurrent[i] = OptItem.getStartValue();
 
       switch (OptItem.checkConstraint(mCurrent[i]))
         {
           case - 1:
             mCurrent[i] = *OptItem.getLowerBoundValue();
             break;
 
           case 1:
             mCurrent[i] = *OptItem.getUpperBoundValue();
             break;
 
           case 0:
             break;
         }
 
       // set the value
       (*(*mpSetCalculateVariable)[i])(mCurrent[i]);
     }
 
   // Report the first value as the current best
   mBestValue = evaluate();
   mBest = mCurrent;
   mContinue = mpOptProblem->setSolution(mBestValue, mBest);
 
   repeat = 0;
 
   while (repeat < 10 && mContinue)
     {
       repeat++;
 
       // estimate minimum is 1/10 initial function value
       fest = (1 - pow(0.9, (C_FLOAT64) repeat)) * mEvaluationValue;
       ierror = 0;
 
       // minimise
       try
         {
           mpCTruncatedNewton->tnbc_(&ierror, &mVariableSize, mCurrent.array(), &fest, mGradient.array(), dwork.array(),
                                     &lw, mpTruncatedNewton, low.array(), up.array(), iPivot.array());
           mEvaluationValue = fest;
         }
 
       // This signals that the user opted to interupt
       catch (bool)
         {
           break;
         }
 
       if (ierror < 0)
         fatalError(); // Invalid parameter values.
 
       // The way the method is currently implemented may lead to parameters just outside the boundaries.
       // We need to check whether the current value is within the boundaries or whether the corrected
       // leads to an improved solution.
 
       bool withinBounds = true;
 
       for (i = 0; i < mVariableSize; i++)
         {
           const COptItem & OptItem = *(*mpOptItem)[i];
 
           //force it to be within the bounds
           switch (OptItem.checkConstraint(mCurrent[i]))
             {
               case - 1:
                 withinBounds = false;
                 mCurrent[i] = *OptItem.getLowerBoundValue();
                 break;
 
               case 1:
                 withinBounds = false;
                 mCurrent[i] = *OptItem.getUpperBoundValue();
                 break;
 
               case 0:
                 break;
             }
 
           (*(*mpSetCalculateVariable)[i])(mCurrent[i]);
         }
 
       evaluate();
 
       // Is the corrected value better than solution?
       if (mEvaluationValue < mBestValue)
         {
           // We found a new best value lets report it.
           // and store that value
           mBest = mCurrent;
           mBestValue = mEvaluationValue;
 
           mContinue = mpOptProblem->setSolution(mBestValue, mBest);
 
           // We found a new best value lets report it.
           mpParentTask->output(COutputInterface::DURING);
         }
 
       // We found a solution
       if (withinBounds)
         break;
 
       // Choosing another starting point will be left to the user
 #ifdef XXXX
 
       // Try another starting point
       for (i = 0; i < mVariableSize; i++)
         {
           mCurrent[i] *= 1.2;
           const COptItem & OptItem = *(*mpOptItem)[i];
 
           //force it to be within the bounds
           switch (OptItem.checkConstraint(mCurrent[i]))
             {
               case - 1:
                 mCurrent[i] = *OptItem.getLowerBoundValue();
                 break;
 
               case 1:
                 mCurrent[i] = *OptItem.getUpperBoundValue();
                 break;
 
               case 0:
                 break;
             }
 
           (*(*mpSetCalculateVariable)[i])(mCurrent[i]);
         }
 
       evaluate();
 
       // Check whether we improved
       if (mEvaluationValue < mBestValue)
         {
           // We found a new best value lets report it.
           // and store that value
           mBest = mCurrent;
           mBestValue = mEvaluationValue;
 
           mContinue = mpOptProblem->setSolution(mBestValue, mBest);
 
           // We found a new best value lets report it.
           mpParentTask->output(COutputInterface::DURING);
         }
 
 #endif // XXXX
     }
 
   return true;
 }

C_INT COptMethodTruncatedNewton::sFun	(	C_INT *	n,
		C_FLOAT64 *	x,
		C_FLOAT64 *	f,
		C_FLOAT64 *	g
	)

private

callback function for evaluation of objective function and its gradient

Definition at line 263 of file COptMethodTruncatedNewton.cpp.

References C_INT, COutputInterface::DURING, evaluate(), mBest, mBestValue, mContinue, mEvaluationValue, COptMethod::mpOptProblem, COptMethod::mpParentTask, COptMethod::mpSetCalculateVariable, CCopasiTask::output(), and COptProblem::setSolution().

 {
   C_INT i;
 
   // set the parameter values
   for (i = 0; i < *n; i++)
     (*(*mpSetCalculateVariable)[i])(x[i]);
 
   //carry out the function evaluation
   *f = evaluate();
 
   // Check whether we improved
   if (mEvaluationValue < mBestValue)
     {
       // We found a new best value lets report it.
       // and store that value
       for (i = 0; i < *n; i++)
         mBest[i] = x[i];
 
       mBestValue = mEvaluationValue;
       mContinue = mpOptProblem->setSolution(mBestValue, mBest);
 
       // We found a new best value lets report it.
       mpParentTask->output(COutputInterface::DURING);
     }
 
   // Calculate the gradient
   for (i = 0; i < *n && mContinue; i++)
     {
       if (x[i] != 0.0)
         {
           (*(*mpSetCalculateVariable)[i])(x[i] * 1.001);
           g[i] = (evaluate() - *f) / (x[i] * 0.001);
         }
 
       else
         {
           (*(*mpSetCalculateVariable)[i])(1e-7);
           g[i] = (evaluate() - *f) / 1e-7;
         }
 
       (*(*mpSetCalculateVariable)[i])(x[i]);
     }
 
   if (!mContinue)
     throw bool(mContinue);
 
   return 0;
 }