#include <AlpsModel.h>

Inheritance diagram for AlpsModel:

Collaboration diagram for AlpsModel:

Public Member Functions
	AlpsModel ()
	Default construtor. More...

virtual	~AlpsModel ()
	Destructor. More...

AlpsKnowledgeBroker *	getKnowledgeBroker ()
	Get knowledge broker. More...

void	setKnowledgeBroker (AlpsKnowledgeBroker *b)
	Set knowledge broker. More...

std::string	getDataFile () const
	Get the input file. More...

void	setDataFile (std::string infile)
	Set the data file. More...

AlpsParams *	AlpsPar ()
	Access Alps Parameters. More...

virtual void	readInstance (const char *dateFile)
	Read in the instance data. More...

virtual void	readParameters (const int argnum, const char const arglist)
	Read in Alps parameters. More...

void	writeParameters (std::ostream &outstream) const
	Write out parameters. More...

virtual bool	setupSelf ()
	Do necessary work to make model ready for use, such as classify variable and constraint types. More...

virtual void	preprocess ()
	Preprocessing the model. More...

virtual void	postprocess ()
	Postprocessing results. More...

virtual AlpsTreeNode *	createRoot ()
	Create the root node. More...

virtual void	modelLog ()
	Problem specific log. More...

virtual void	nodeLog (AlpsTreeNode *node, bool force)
	Node log. More...

virtual bool	fathomAllNodes ()
	Return true if all nodes on this process can be fathomed. More...

AlpsReturnStatus	encodeAlps (AlpsEncoded *encoded) const
	Pack Alps portion of node into an encoded object. More...

AlpsReturnStatus	decodeAlps (AlpsEncoded &encoded)
	Unpack Alps portion of node from an encoded object. More...

virtual void	decodeToSelf (AlpsEncoded &encoded)
	Decode model data from the encoded form and fill member data. More...

virtual void	registerKnowledge ()
	Register knowledge class. More...

virtual void	sendGeneratedKnowledge ()
	Send generated knowledge. More...

virtual void	receiveGeneratedKnowledge ()
	Receive generated knowledge. More...

virtual AlpsEncoded *	packSharedKnowlege ()
	Pack knowledge to be shared with others into an encoded object. More...

virtual void	unpackSharedKnowledge (AlpsEncoded &)
	Unpack and store shared knowledge from an encoded object. More...

Public Member Functions inherited from AlpsKnowledge
	AlpsKnowledge ()

virtual	~AlpsKnowledge ()

KnowledgeType	getType ()

void	setType (KnowledgeType t)

virtual AlpsEncoded *	encode () const
	This method should encode the content of the object and return a pointer to the encoded form. More...

virtual AlpsReturnStatus	encode (AlpsEncoded *encoded)
	Pack into a encode object. More...

virtual AlpsKnowledge *	decode (AlpsEncoded &encoded) const
	This method should decode and return a pointer to a brand new object, i.e., the method must create a new object on the heap from the decoded data instead of filling up the object for which the method was invoked. More...

AlpsEncoded *	getEncoded () const
	Get/set encoded. More...

void	setEncoded (AlpsEncoded *e)

Protected Attributes
AlpsKnowledgeBroker *	broker_
	Knowledge broker. More...

std::string	dataFile_
	Data file. More...

AlpsParams *	AlpsPar_
	The parameter set that is used in Alps. More...

Protected Attributes inherited from AlpsKnowledge
KnowledgeType	type_

Private Member Functions
	AlpsModel (const AlpsModel &)

AlpsModel &	operator= (const AlpsModel &)

Detailed Description

Definition at line 36 of file AlpsModel.h.

Constructor & Destructor Documentation

AlpsModel::AlpsModel ( const AlpsModel & )

private

AlpsModel::AlpsModel ( )

inline

Default construtor.

Definition at line 57 of file AlpsModel.h.

virtual AlpsModel::~AlpsModel ( )

inlinevirtual

Destructor.

Definition at line 62 of file AlpsModel.h.

Member Function Documentation

AlpsModel& AlpsModel::operator= ( const AlpsModel & )

private

AlpsKnowledgeBroker* AlpsModel::getKnowledgeBroker ( )

inline

Get knowledge broker.

Definition at line 65 of file AlpsModel.h.

void AlpsModel::setKnowledgeBroker ( AlpsKnowledgeBroker * b )

inline

Set knowledge broker.

Definition at line 68 of file AlpsModel.h.

std::string AlpsModel::getDataFile ( ) const

inline

Get the input file.

Definition at line 71 of file AlpsModel.h.

void AlpsModel::setDataFile ( std::string infile )

inline

Set the data file.

Definition at line 74 of file AlpsModel.h.

AlpsParams* AlpsModel::AlpsPar ( )

inline

Access Alps Parameters.

Definition at line 77 of file AlpsModel.h.

virtual void AlpsModel::readInstance ( const char * dateFile )

inlinevirtual

Read in the instance data.

At Alps level, nothing to do.

Reimplemented in AbcModel, and KnapModel.

Definition at line 80 of file AlpsModel.h.

virtual void AlpsModel::readParameters	(	const int	argnum,
		const char const	arglist
	)

virtual

Read in Alps parameters.

Reimplemented in AbcModel, and KnapModel.

void AlpsModel::writeParameters ( std::ostream & outstream ) const

Write out parameters.

virtual bool AlpsModel::setupSelf ( )

inlinevirtual

Do necessary work to make model ready for use, such as classify variable and constraint types.

Reimplemented in AbcModel.

Definition at line 93 of file AlpsModel.h.

virtual void AlpsModel::preprocess ( )

inlinevirtual

Preprocessing the model.

Definition at line 96 of file AlpsModel.h.

virtual void AlpsModel::postprocess ( )

inlinevirtual

Postprocessing results.

Definition at line 99 of file AlpsModel.h.

virtual AlpsTreeNode* AlpsModel::createRoot ( )

inlinevirtual

Create the root node.

Default: do nothing

Definition at line 102 of file AlpsModel.h.

virtual void AlpsModel::modelLog ( )

inlinevirtual

Problem specific log.

Definition at line 108 of file AlpsModel.h.

virtual void AlpsModel::nodeLog	(	AlpsTreeNode *	node,
		bool	force
	)

virtual

Node log.

virtual bool AlpsModel::fathomAllNodes ( )

inlinevirtual

Return true if all nodes on this process can be fathomed.

Definition at line 114 of file AlpsModel.h.

AlpsReturnStatus AlpsModel::encodeAlps ( AlpsEncoded * encoded ) const

Pack Alps portion of node into an encoded object.

AlpsReturnStatus AlpsModel::decodeAlps ( AlpsEncoded & encoded )

Unpack Alps portion of node from an encoded object.

virtual void AlpsModel::decodeToSelf ( AlpsEncoded & encoded )

inlinevirtual

Decode model data from the encoded form and fill member data.

Reimplemented in AbcModel, and KnapModel.

Definition at line 127 of file AlpsModel.h.

virtual void AlpsModel::registerKnowledge ( )

inlinevirtual

Register knowledge class.

Definition at line 130 of file AlpsModel.h.

virtual void AlpsModel::sendGeneratedKnowledge ( )

inlinevirtual

Send generated knowledge.

Definition at line 133 of file AlpsModel.h.

virtual void AlpsModel::receiveGeneratedKnowledge ( )

inlinevirtual

Receive generated knowledge.

Definition at line 136 of file AlpsModel.h.

virtual AlpsEncoded* AlpsModel::packSharedKnowlege ( )

inlinevirtual

Pack knowledge to be shared with others into an encoded object.

Return NULL means that no knowledge can be shared.

Definition at line 140 of file AlpsModel.h.

virtual void AlpsModel::unpackSharedKnowledge ( AlpsEncoded & )

inlinevirtual

Unpack and store shared knowledge from an encoded object.

Definition at line 147 of file AlpsModel.h.

Member Data Documentation

AlpsKnowledgeBroker* AlpsModel::broker_

protected

Knowledge broker.

Definition at line 46 of file AlpsModel.h.

std::string AlpsModel::dataFile_

protected

Data file.

Definition at line 49 of file AlpsModel.h.

AlpsParams* AlpsModel::AlpsPar_

protected

The parameter set that is used in Alps.

Definition at line 52 of file AlpsModel.h.

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

/tmp/CHiPPS-Alps-1.5.6/Alps/src/AlpsModel.h

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation