#include <COptMethodSS.h>

Inheritance diagram for COptMethodSS:

Public Member Functions
	COptMethodSS (const CDataContainer *pParent, const CTaskEnum::Method &methodType=CTaskEnum::Method::ScatterSearch, const CTaskEnum::Task &taskType=CTaskEnum::Task::optimization)

	COptMethodSS (const COptMethodSS &src, const CDataContainer *pParent)

virtual bool	elevateChildren ()

virtual bool	optimise ()

virtual	~COptMethodSS ()

Public Member Functions inherited from COptPopulationMethod
	COptPopulationMethod (const CDataContainer *pParent, const CTaskEnum::Method &methodType, const CTaskEnum::Task &taskType, const bool &parallel)

	COptPopulationMethod (const COptPopulationMethod &src, const CDataContainer *pParent)

C_INT32	getCurrentGeneration ()

C_INT32	getNumGenerations ()

const CVector< C_FLOAT64 > &	getObjectiveValues ()

const std::vector< CVector< C_FLOAT64 > * > &	getPopulation ()

C_INT32	getPopulationSize ()

void	initObjects ()

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

virtual	~COptPopulationMethod ()

Public Member Functions inherited from COptMethod
	COptMethod (const CDataContainer *pParent, const CTaskEnum::Method &methodType, const CTaskEnum::Task &taskType, const bool &parallel)

	COptMethod (const COptMethod &src, const CDataContainer *pParent)

virtual const CVector< C_FLOAT64 > *	getBestParameters () const

virtual C_FLOAT64	getBestValue () const

virtual const CVector< C_FLOAT64 > *	getCurrentParameters () const

virtual C_FLOAT64	getCurrentValue () const

virtual unsigned C_INT32	getMaxLogVerbosity () const

const COptLog &	getMethodLog () const

virtual bool	isValidProblem (const CCopasiProblem *pProblem)

void	setProblem (COptProblem *problem)

virtual	~COptMethod ()

Public Member Functions inherited from CCopasiMethod
	CCopasiMethod (const CCopasiMethod &src, const CDataContainer *pParent)

virtual void	clearCallBack ()

const CProcessReportLevel &	getCallBack () const

CMathContainer *	getMathContainer () const

const CTaskEnum::Method &	getSubType () const

const CTaskEnum::Task &	getType () const

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

CCopasiMethod &	operator= (const CCopasiMethod &rhs)

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

virtual bool	setCallBack (CProcessReportLevel callBack)

void	setMathContainer (CMathContainer *pContainer)

virtual	~CCopasiMethod ()

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

void	addParameter (CCopasiParameter *pParameter)

bool	addParameter (const CCopasiParameter &parameter)

bool	addParameter (const std::string &name, const CCopasiParameter::Type type, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)

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

virtual bool	applyData (const CData &data, CUndoData::CChangeSet &changes)

CCopasiParameterGroup *	assertGroup (const std::string &name, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)

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

index_iterator	beginIndex () const

const_name_iterator	beginName () const

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

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

void	clear ()

virtual void	createUndoData (CUndoData &undoData, const CUndoData::Type &type, const CData &oldData=CData(), const CCore::Framework &framework=CCore::Framework::ParticleNumbers) const

index_iterator	endIndex () const

const_name_iterator	endName () const

CCopasiParameterGroup &	getElementTemplates ()

const CCopasiParameterGroup &	getElementTemplates () const

CCopasiParameterGroup *	getGroup (const size_t &index)

const CCopasiParameterGroup *	getGroup (const size_t &index) const

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

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

virtual size_t	getIndex (const CDataObject *pObject) const

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

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

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

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

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

CCopasiParameter *	getParameter (const size_t &index)

const CCopasiParameter *	getParameter (const size_t &index) const

CCopasiParameter *	getParameter (std::string name)

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

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

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

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

template<class CType >
CType &	getValue (const size_t &index)

template<class CType >
const CType &	getValue (const size_t &index) const

template<class CType >
CType &	getValue (const std::string &name)

template<class CType >
const CType &	getValue (const std::string &name) const

bool	haveTemplate () const

virtual CUndoObjectInterface *	insert (const CData &data)

CCopasiParameterGroup &	operator= (const CCopasiParameterGroup &rhs)

virtual bool	remove (CDataObject *pObject)

bool	removeParameter (CCopasiParameter *pParameter)

bool	removeParameter (const size_t &index)

bool	removeParameter (const std::string &name)

virtual void	setUserInterfaceFlag (const UserInterfaceFlag &flag)

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

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

size_t	size (const UserInterfaceFlag &require=UserInterfaceFlag::None, const UserInterfaceFlag &exclude=UserInterfaceFlag::None) const

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

bool	swap (index_iterator &from, index_iterator &to)

virtual CData	toData () const

virtual void	updateIndex (const size_t &index, const CUndoObjectInterface *pUndoObject)

virtual	~CCopasiParameterGroup ()

Public Member Functions inherited from CCopasiParameter
	CCopasiParameter (const CCopasiParameter &src, const CDataContainer *pParent)

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

virtual CCommonName	getCN () const override

template<class CType >
const CType &	getDefault () const

virtual const std::string &	getKey () const override

virtual std::string	getObjectDisplayName () const override

const CCopasiParameter::Type &	getType () const

const UserInterfaceFlag &	getUserInterfaceFlag () const

template<class CType >
std::vector< std::pair< CType, CType > > &	getValidValues ()

template<class CType >
const std::vector< std::pair< CType, CType > > &	getValidValues () const

void *	getValidValuesPointer () const

template<class CType >
CType &	getValue ()

template<class CType >
const CType &	getValue () const

virtual void *	getValuePointer () const override

CDataObject *	getValueReference () const

bool	hasValidValues () const

bool	isBasic () const

bool	isDefault () const

bool	isEditable () const

bool	isUnsupported () const

bool	isValidValue (const bool &value) const

bool	isValidValue (const C_FLOAT64 &value) const

bool	isValidValue (const C_INT32 &value) const

bool	isValidValue (const CCommonName &value) const

template<class CType >
bool	isValidValue (const CType &) const

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

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

bool	isValidValue (const unsigned C_INT32 &value) const

CCopasiParameter &	operator= (const CCopasiParameter &rhs)

template<class CType >
bool	setDefault (const CType &defaultValue)

bool	setDefault (const std::vector< CCopasiParameter * > &defaultValue)

virtual bool	setObjectParent (const CDataContainer *pParent) override

template<class CType , class Enum >
bool	setValidValues (const CEnumAnnotation< CType, Enum > &validValues)

template<class CType >
bool	setValidValues (const std::vector< std::pair< CType, CType > > &validValues)

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

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

virtual	~CCopasiParameter ()

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

virtual bool	appendDeletedDependentData (CUndoData &undoData) const

	CDataContainer (const CDataContainer &src, const CDataContainer *pParent)

	CDataContainer (const std::string &name, const CDataContainer *pParent=NO_PARENT, const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)

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

void	getDescendants (CDataObject::DataObjectSet &descendants, const bool &recursive=false) const

virtual objectMap &	getObjects ()

virtual const objectMap &	getObjects () const

virtual const std::string	getUnits () const override

virtual const CDataObject *	getValueObject () const override

void	objectRenamed (CDataObject *pObject, const std::string &oldName)

virtual	~CDataContainer ()

Public Member Functions inherited from CDataObject
void	addIssue (const CIssue &issue)

void	addReference (const CDataContainer *pReference)

virtual void	calculateValue () override

	CDataObject (const CDataObject &src, const CDataContainer *pParent=NULL)

virtual void	destruct () override

virtual const CDataObject *	getDataObject () const override

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

CDataModel *	getObjectDataModel () const

const CObjectInterface *	getObjectFromCN (const CCommonName &cn) const

const std::string &	getObjectName () const

CDataContainer *	getObjectParent () const

const std::string &	getObjectType () const

virtual const CObjectInterface::ObjectSet &	getPrerequisites () const override

virtual const CValidity &	getValidity () const override

bool	hasFlag (const Flag &flag) const

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

bool	prerequisitsContains (const DataObjectSet &objects) const

void	removeIssue (const CIssue &issue)

void	removeReference (const CDataContainer *pReference)

bool	setObjectName (const std::string &name)

void	validityChanged (const CValidity &changedValidity) override

void	validityRemoved (const CValidity &changedValidity)

virtual	~CDataObject ()

Public Member Functions inherited from CObjectInterface
	CObjectInterface ()

	CObjectInterface (const CObjectInterface &src)

virtual	~CObjectInterface ()

Public Member Functions inherited from CUndoObjectInterface
	CUndoObjectInterface ()

	CUndoObjectInterface (const CUndoObjectInterface &src)

bool	generateUuid ()

const xg::Guid &	getUuid () const

bool	setUuid (const std::string &uuid)

bool	setUuid (const xg::Guid &uuid)

virtual	~CUndoObjectInterface ()

Private Member Functions
bool	childLocalMin (void)

virtual bool	cleanup ()

bool	closerChild (C_INT32 i, C_INT32 j, C_FLOAT64 dist)

bool	closerRefSet (C_INT32 i, C_INT32 j, C_FLOAT64 dist)

bool	combination (void)

	COptMethodSS ()

bool	creation (void)

bool	evaluate (const CVector< C_FLOAT64 > &individual)

bool	inforefset (C_INT32 type, C_INT32 element)

virtual bool	initialize ()

void	initObjects ()

bool	localmin (CVector< C_FLOAT64 > &solution, C_FLOAT64 &fval)

bool	randomize (C_INT32 i)

bool	serializechildren (size_t first, size_t last)

bool	serializepool (size_t first, size_t last)

bool	serializeprob (void)

bool	serializerefset (C_INT32 first, C_INT32 last)

bool	serializevector (CVector< C_FLOAT64 > x, C_FLOAT64 xval)

void	sortRefSet (C_INT32 lower, C_INT32 upper)

Private Attributes
size_t	mBestIndex

C_FLOAT64	mBestValue

std::vector< CVector< C_FLOAT64 > * >	mChild

bool	mChildrenGenerated

CVector< C_FLOAT64 >	mChildVal

C_FLOAT64	mCloseValue

C_FLOAT64	mEvaluationValue

std::vector< CVector< C_INT32 > * >	mFreq

unsigned C_INT32	mLocalFreq

unsigned C_INT32	mLocalIter

unsigned C_INT32	mLocalStored

COptMethod *	mpLocalMinimizer {NULL}

std::vector< CVector< C_FLOAT64 > * >	mPool

size_t	mPoolSize

CVector< C_FLOAT64 >	mPoolVal

COptProblem *	mpOptProblemLocal {NULL}

CVector< C_FLOAT64 >	mProb

unsigned C_INT32	mStopAfterStalledGenerations

CVector< C_INT32 >	mStuck

Additional Inherited Members
Public Types inherited from CCopasiParameterGroup
typedef CDataObjectMap::const_type_iterator< CCopasiParameter >	const_name_iterator

typedef std::vector< CCopasiParameter * >	elements

typedef elements::iterator	index_iterator

typedef CDataObjectMap::type_iterator< CCopasiParameter >	name_iterator

Public Types inherited from CCopasiParameter
enum class	eUserInterfaceFlag { editable , basic , unsupported , __SIZE }

enum class	Type { DOUBLE = 0 , UDOUBLE , INT , UINT , BOOL , GROUP , STRING , CN , KEY , FILE , EXPRESSION , INVALID , __SIZE }

typedef CFlags< eUserInterfaceFlag >	UserInterfaceFlag

Public Types inherited from CDataContainer
typedef CDataObjectMap	objectMap

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

enum	Flag { Container , Vector , Matrix , NameVector , Reference , ValueBool , ValueInt , ValueInt64 , ValueDbl , NonUniqueName , StaticString , ValueString , Separator , DisplayName , ModelEntity , Array , DataModel , Root , Gui , __SIZE }

Public Types inherited from CObjectInterface
typedef std::vector< const CDataContainer * >	ContainerList

typedef std::set< const CObjectInterface * >	ObjectSet

Static Public Member Functions inherited from CCopasiParameter
static void	allocateValidValues (const Type &type, void *&pValidValues)

static void	allocateValue (const Type &type, void *&pValue)

static void	assignValue (const Type &type, void &pValue, const void pNewValue)

static void	deleteValidValues (const Type &type, void *&pValidValues)

static void	deleteValue (const Type &type, void *&pValue)

static CCopasiParameter *	fromData (const CData &data, CUndoObjectInterface *pParent)

Static Public Member Functions inherited from CDataContainer
static CDataContainer *	fromData (const CData &data, CUndoObjectInterface *pParent)

Static Public Member Functions inherited from CDataObject
static CDataObject *	fromData (const CData &data, CUndoObjectInterface *pParent)

static void	sanitizeObjectName (std::string &name)

Static Public Member Functions inherited from CObjectInterface
static const CDataObject *	DataObject (const CObjectInterface *pInterface)

static CObjectInterface *	GetObjectFromCN (const ContainerList &listOfContainer, const CCommonName &objName)

Static Public Member Functions inherited from CUndoObjectInterface
template<class CType >
static CType *	fromData (const CData &, CUndoObjectInterface *)

Static Public Attributes inherited from CCopasiParameter
static const CEnumAnnotation< std::string, Type >	TypeName

static const CEnumAnnotation< std::string, Type >	XMLType

Static Public Attributes inherited from CDataContainer
static const CObjectInterface::ContainerList	EmptyList

Protected Member Functions inherited from COptMethod
virtual void	signalMathContainerChanged ()

Protected Member Functions inherited from CCopasiMethod
	CCopasiMethod (const CCopasiMethod &src)

	CCopasiMethod (const CDataContainer *pParent, const CTaskEnum::Method &methodType, const CTaskEnum::Task &taskType)

Protected Member Functions inherited from CCopasiParameterGroup
	CCopasiParameterGroup ()

Protected Member Functions inherited from CCopasiParameter
	CCopasiParameter (const CCopasiParameter &src)

Protected Member Functions inherited from CDataContainer
template<class CType >
CDataMatrixReference< CType > *	addMatrixReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)

template<class CType >
CDataObjectReference< CType > *	addObjectReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)

template<class CType >
CDataVectorReference< CType > *	addVectorReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)

	CDataContainer (const CDataContainer &src)

void	initObjects ()

Protected Member Functions inherited from CDataObject
	CDataObject ()

	CDataObject (const std::string &name, const CDataContainer pParent=static_cast< CDataContainer >((void *) 0), const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)

Static Protected Member Functions inherited from COptMethod
static std::pair< C_FLOAT64, bool >	objectiveValue (COptProblem *pProblem, const CVectorCore< C_FLOAT64 > &parameters)

static void	reflect (COptProblem *pProblem, const C_FLOAT64 &bestValue, C_FLOAT64 &objectiveValue)

Protected Attributes inherited from COptPopulationMethod
unsigned C_INT32	mCurrentGeneration

unsigned C_INT32	mGenerations

size_t	mhGenerations

std::vector< CVector< C_FLOAT64 > * >	mIndividuals

unsigned C_INT32	mPopulationSize

CRandomContext	mRandomContext

CVector< C_FLOAT64 >	mValues

size_t	mVariableSize

Protected Attributes inherited from COptMethod
unsigned C_INT32	mLogVerbosity

CMathContext	mMathContext

COptLog	mMethodLog

bool	mParallel

COptTask *	mpParentTask

COptProblemContext	mProblemContext

Protected Attributes inherited from CCopasiMethod
CMathContainer *	mpContainer

CProcessReportLevel	mProcessReport

Protected Attributes inherited from CCopasiParameter
std::string	mKey

void *	mpDefault

void *	mpValidValues

void *	mpValue

CDataObject *	mpValueReference

UserInterfaceFlag	mUserInterfaceFlag

Protected Attributes inherited from CDataContainer
objectMap	mObjects

Protected Attributes inherited from CDataObject
ObjectSet	mPrerequisits

std::set< CDataContainer * >	mReferences

Protected Attributes inherited from CObjectInterface
CValidity	mValidity

Constructor & Destructor Documentation

◆ COptMethodSS() [1/3]

COptMethodSS::COptMethodSS	(	const CDataContainer *	pParent,
		const CTaskEnum::Method &	methodType = `CTaskEnum::Method::ScatterSearch`,
		const CTaskEnum::Task &	taskType = `CTaskEnum::Task::optimization`
	)

Specific constructor

Parameters

const	CDataContainer * pParent
const	CTaskEnum::Method & methodType (default: ScatterSearch)
const	CTaskEnum::Task & taskType (default: optimization)

References CCopasiParameterGroup::assertParameter(), C_INT32, CCopasiParameter::editable, initObjects(), CRandom::mt19937, and CCopasiParameter::UINT.

◆ COptMethodSS() [2/3]

COptMethodSS::COptMethodSS	(	const COptMethodSS &	src,
		const CDataContainer *	pParent
	)

Copy Constructor

Parameters

const	COptMethodSS & src
const	CDataContainer * pParent (default: NULL)

References initObjects().

◆ ~COptMethodSS()

COptMethodSS::~COptMethodSS ( )

virtual

Destructor

References cleanup().

◆ COptMethodSS() [3/3]

COptMethodSS::COptMethodSS ( )

private

Default Constructor

Member Function Documentation

◆ childLocalMin()

bool COptMethodSS::childLocalMin ( void )

private

minimize the best child if within criteria

Returns: bool continue

References C_FLOAT64, C_INT32, closerChild(), localmin(), mChild, mChildVal, mCloseValue, mLocalIter, mLocalStored, mPool, mPoolVal, COptPopulationMethod::mPopulationSize, and mStuck.

Referenced by optimise().

◆ cleanup()

bool COptMethodSS::cleanup ( )

privatevirtual

Cleanup arrays and pointers.

Returns: bool success

Reimplemented from COptPopulationMethod.

References COptPopulationMethod::cleanup(), mChild, mFreq, mpLocalMinimizer, mPool, mpOptProblemLocal, and pdelete.

Referenced by initialize(), optimise(), and ~COptMethodSS().

◆ closerChild()

bool COptMethodSS::closerChild	(	C_INT32	i,
		C_INT32	j,
		C_FLOAT64	dist
	)

private

check if two child vectors are close (one vector in mChild, the other in mPool, where previous child are stored)

References C_FLOAT64, C_INT32, mChild, mPool, and COptPopulationMethod::mVariableSize.

Referenced by childLocalMin().

◆ closerRefSet()

bool COptMethodSS::closerRefSet	(	C_INT32	i,
		C_INT32	j,
		C_FLOAT64	dist
	)

private

check if two vectors in RefSet are close

References C_FLOAT64, C_INT32, COptPopulationMethod::mIndividuals, and COptPopulationMethod::mVariableSize.

Referenced by optimise().

◆ combination()

bool COptMethodSS::combination ( void )

private

create new individuals with the combination method

Returns: bool continue

References C_FLOAT64, C_INT32, COptItem::checkConstraint(), evaluate(), COptItem::getLowerBoundValue(), COptItem::getUpperBoundValue(), CContext< Data >::master(), max, mChild, mChildrenGenerated, mChildVal, mEvaluationValue, min, COptPopulationMethod::mIndividuals, COptPopulationMethod::mPopulationSize, COptMethod::mProblemContext, COptPopulationMethod::mRandomContext, mStuck, COptPopulationMethod::mValues, COptPopulationMethod::mVariableSize, and CVector< CType >::resize().

Referenced by optimise().

◆ creation()

bool COptMethodSS::creation ( void )

private

Initialise the population

Returns: bool continue

References C_FLOAT64, C_INT32, COptItem::checkConstraint(), evaluate(), COptItem::getLowerBoundValue(), COptItem::getStartValue(), COptItem::getUpperBoundValue(), CContext< Data >::master(), max, mEvaluationValue, mFreq, min, COptPopulationMethod::mIndividuals, mPool, mPoolSize, mPoolVal, COptPopulationMethod::mPopulationSize, mProb, COptMethod::mProblemContext, COptPopulationMethod::mRandomContext, mStuck, COptPopulationMethod::mValues, COptPopulationMethod::mVariableSize, and sortRefSet().

Referenced by optimise().

◆ elevateChildren()

bool COptMethodSS::elevateChildren ( )

virtual

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

Returns: bool success

Reimplemented from CCopasiParameterGroup.

◆ evaluate()

bool COptMethodSS::evaluate ( const CVector< C_FLOAT64 > & individual )

private

Evaluate the fitness of one individual

Parameters

const CVector< C_FLOAT64 > & individual

Returns: bool continue

References CContext< Data >::master(), mEvaluationValue, and COptMethod::mProblemContext.

Referenced by combination(), creation(), and randomize().

◆ inforefset()

bool COptMethodSS::inforefset	(	C_INT32	type,
		C_INT32	element
	)

private

write informative messages about the refset

Parameters

size_t type

Returns: bool success

◆ initialize()

bool COptMethodSS::initialize ( )

privatevirtual

Initialize arrays and pointer.

Returns: bool success

Reimplemented from COptPopulationMethod.

Referenced by optimise().

◆ initObjects()

void COptMethodSS::initObjects ( )

private

Initialize contained objects.

References CDataContainer::addObjectReference(), COptPopulationMethod::mCurrentGeneration, and CDataObject::ValueInt.

Referenced by COptMethodSS().

◆ localmin()

bool COptMethodSS::localmin	(	CVector< C_FLOAT64 > &	solution,
		C_FLOAT64 &	fval
	)

private

Find a local minimum

Parameters

CVector<	C_FLOAT64 > & solution
C_FLOAT64	& fval

Returns: bool continue

References C_INT32, COptProblem::getCounters(), COptProblem::getOptItemList(), COptProblem::getSolutionValue(), COptProblem::getSolutionVariables(), CContext< Data >::master(), mpLocalMinimizer, mpOptProblemLocal, COptMethod::mProblemContext, COptPopulationMethod::mVariableSize, COptMethod::optimise(), COptProblem::reset(), and COptProblem::resetCounters().

Referenced by childLocalMin(), and optimise().

◆ optimise()

bool COptMethodSS::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.

References C_FLOAT64, childLocalMin(), cleanup(), closerRefSet(), combination(), creation(), COutputInterface::DURING, CProcessReportLevel::finishItem(), initialize(), localmin(), CContext< Data >::master(), mBestValue, mChild, mChildrenGenerated, mChildVal, mCloseValue, COptPopulationMethod::mCurrentGeneration, COptPopulationMethod::mGenerations, COptPopulationMethod::mhGenerations, COptPopulationMethod::mIndividuals, mLocalFreq, mLocalIter, mLocalStored, COutputInterface::MONITORING, mpLocalMinimizer, mPoolSize, COptPopulationMethod::mPopulationSize, COptMethod::mpParentTask, COptMethod::mProblemContext, CCopasiMethod::mProcessReport, mStopAfterStalledGenerations, mStuck, COptPopulationMethod::mValues, CCopasiTask::output(), CProcessReportLevel::progressItem(), randomize(), CCopasiParameterGroup::setValue(), and sortRefSet().

◆ randomize()

bool COptMethodSS::randomize ( C_INT32 i )

private

randomize an element of the RefSet

References C_FLOAT64, C_INT32, COptItem::checkConstraint(), evaluate(), COptItem::getLowerBoundValue(), COptItem::getUpperBoundValue(), CContext< Data >::master(), max, mEvaluationValue, min, COptPopulationMethod::mIndividuals, COptMethod::mProblemContext, COptPopulationMethod::mRandomContext, mStuck, COptPopulationMethod::mValues, and COptPopulationMethod::mVariableSize.

Referenced by optimise().

◆ serializechildren()

bool COptMethodSS::serializechildren	(	size_t	first,
		size_t	last
	)

private

Serialize the children for debug

Parameters

size_t	first
size_t	last (default: population size)

Returns: bool success

◆ serializepool()

bool COptMethodSS::serializepool	(	size_t	first,
		size_t	last
	)

private

Serialize the pool for debug

Parameters

size_t	first
size_t	last (default: pool size)

Returns: bool success

◆ serializeprob()

bool COptMethodSS::serializeprob ( void )

private

Serialize the probability table for debug

Returns: bool success

◆ serializerefset()

bool COptMethodSS::serializerefset	(	C_INT32	first,
		C_INT32	last
	)

private

Serialize the refset for debug

Parameters

size_t	first
size_t	last (default: population size)

Returns: bool success

◆ serializevector()

bool COptMethodSS::serializevector	(	CVector< C_FLOAT64 >	x,
		C_FLOAT64	xval
	)

private

Serialize a vector to the refset file ,for debug

Parameters

x	the vector
xval	function value for that vector

Returns: bool success

◆ sortRefSet()

void COptMethodSS::sortRefSet	(	C_INT32	lower,
		C_INT32	upper
	)

private

sort the RefSet array between position lower and upper

References C_FLOAT64, C_INT32, COptPopulationMethod::mIndividuals, mStuck, and COptPopulationMethod::mValues.

Referenced by creation(), and optimise().

Member Data Documentation

◆ mBestIndex

size_t COptMethodSS::mBestIndex

private

index of the best value so far

◆ mBestValue

C_FLOAT64 COptMethodSS::mBestValue

private

The best value so far

Referenced by initialize(), and optimise().

◆ mChild

std::vector< CVector < C_FLOAT64 > * > COptMethodSS::mChild

private

Array of children for the candidate solutions in the RefSet.

Referenced by childLocalMin(), cleanup(), closerChild(), combination(), initialize(), and optimise().

◆ mChildrenGenerated

bool COptMethodSS::mChildrenGenerated

private

True if there were children produced

Referenced by combination(), initialize(), and optimise().

◆ mChildVal

CVector< C_FLOAT64 > COptMethodSS::mChildVal

private

Array of objective function values of the Children.

Referenced by childLocalMin(), combination(), initialize(), and optimise().

◆ mCloseValue

C_FLOAT64 COptMethodSS::mCloseValue

private

Threshold to decide a solution is too close to another

Referenced by childLocalMin(), initialize(), and optimise().

◆ mEvaluationValue

C_FLOAT64 COptMethodSS::mEvaluationValue

private

The value of the last evaluation.

Referenced by combination(), creation(), evaluate(), and randomize().

◆ mFreq

std::vector< CVector < C_INT32 > * > COptMethodSS::mFreq

private

Array to store frequencies.

Referenced by cleanup(), creation(), and initialize().

◆ mLocalFreq

unsigned C_INT32 COptMethodSS::mLocalFreq

private

Number of iterations between local searches.

Referenced by initialize(), and optimise().

◆ mLocalIter

unsigned C_INT32 COptMethodSS::mLocalIter

private

Counts iterations between local searches.

Referenced by childLocalMin(), and optimise().

◆ mLocalStored

unsigned C_INT32 COptMethodSS::mLocalStored

private

Number of local minimizations stored

Referenced by childLocalMin(), and optimise().

◆ mpLocalMinimizer

COptMethod* COptMethodSS::mpLocalMinimizer {NULL}

private

a pointer to an opt method used for local minimization

Referenced by cleanup(), initialize(), localmin(), and optimise().

◆ mPool

std::vector< CVector < C_FLOAT64 > * > COptMethodSS::mPool

private

Pool of candidate solutions to be incorporated in RefSet (S in Rodriguez-Fernandez et al.).

Referenced by childLocalMin(), cleanup(), closerChild(), creation(), and initialize().

◆ mPoolSize

size_t COptMethodSS::mPoolSize

private

Size of the Pool.

Referenced by creation(), initialize(), and optimise().

◆ mPoolVal

CVector< C_FLOAT64 > COptMethodSS::mPoolVal

private

Function values of candidate solutions in the Pool.

Referenced by childLocalMin(), creation(), and initialize().

◆ mpOptProblemLocal

COptProblem* COptMethodSS::mpOptProblemLocal {NULL}

private

a pointer to an opt problem used for local minimization

Referenced by cleanup(), initialize(), and localmin().

◆ mProb

CVector<C_FLOAT64> COptMethodSS::mProb

private

Array to store probabilities.

Referenced by creation(), and initialize().

◆ mStopAfterStalledGenerations

unsigned C_INT32 COptMethodSS::mStopAfterStalledGenerations

private

if no improvement was made after # stalled generations stop

Referenced by initialize(), and optimise().

◆ mStuck

CVector< C_INT32 > COptMethodSS::mStuck

private

Array of integers to count number of iterations that candidate solutions have not changed in the RefSet.

Referenced by childLocalMin(), combination(), creation(), initialize(), optimise(), randomize(), and sortRefSet().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ COptMethodSS() [1/3]

◆ COptMethodSS() [2/3]

◆ ~COptMethodSS()

◆ COptMethodSS() [3/3]

Member Function Documentation

◆ childLocalMin()

◆ cleanup()

◆ closerChild()

◆ closerRefSet()

◆ combination()

◆ creation()

◆ elevateChildren()

◆ evaluate()

◆ inforefset()

◆ initialize()

◆ initObjects()

◆ localmin()

◆ optimise()

◆ randomize()

◆ serializechildren()

◆ serializepool()

◆ serializeprob()

◆ serializerefset()

◆ serializevector()

◆ sortRefSet()

Member Data Documentation

◆ mBestIndex

◆ mBestValue

◆ mChild

◆ mChildrenGenerated

◆ mChildVal

◆ mCloseValue

◆ mEvaluationValue

◆ mFreq

◆ mLocalFreq

◆ mLocalIter

◆ mLocalStored

◆ mpLocalMinimizer

◆ mPool

◆ mPoolSize

◆ mPoolVal

◆ mpOptProblemLocal

◆ mProb

◆ mStopAfterStalledGenerations

◆ mStuck