ParaSolution Class Reference

class for solution More...

#include <paraSolution.h>

Inheritance diagram for ParaSolution:

Public Member Functions
	ParaSolution ()
	DO NOT HAVE DATA MEMBER!! More...
virtual	~ParaSolution ()
	destructor More...
virtual double	getObjectiveFunctionValue ()=0
	get objective function value More...
virtual ParaSolution *	clone (ParaComm *comm)=0
	create clone of this object More...
virtual void	bcast (ParaComm *comm, int root)=0
	broadcast solution data More...
virtual void	send (ParaComm *comm, int destination)=0
	send solution data More...
virtual void	receive (ParaComm *comm, int source)=0
	receive solution data More...
virtual void	write (gzstream::ogzstream &out)=0
	function to write ParaSolution object to checkpoint file More...
virtual bool	read (ParaComm *comm, gzstream::igzstream &in)=0
	function to read ParaSolution object from checkpoint file More...
virtual const std::string	toString ()
	stringfy ParaSolution object More...

Detailed Description

class for solution

This class should NOT have any data member.

Definition at line 53 of file paraSolution.h.

Constructor & Destructor Documentation

ParaSolution()

ParaSolution

(

)

DO NOT HAVE DATA MEMBER!!

default constructor

Definition at line 65 of file paraSolution.h.

~ParaSolution()

virtual ~ParaSolution ( )

virtual

destructor

Definition at line 73 of file paraSolution.h.

Member Function Documentation

bcast()

virtual void bcast ( ParaComm *  comm, int  root  )

pure virtual

broadcast solution data

Parameters

comm	communicator used
root	root rank for broadcast

Implemented in ScipParaSolutionMpi, and ScipParaSolutionTh.

Referenced by ScipParaSolver::ScipParaSolver(), and ScipParaInitiator::sendSolverInitializationMessage().

clone()

virtual ParaSolution * clone ( ParaComm *  comm )

pure virtual

create clone of this object

Returns

pointer to ParaSolution object

Implemented in ScipParaSolutionMpi, and ScipParaSolutionTh.

Referenced by ScipParaInitiator::readSolutionFromCheckpointFile(), and BbParaLoadCoordinator::updateSolution().

getObjectiveFunctionValue()

virtual double getObjectiveFunctionValue ( )

pure virtual

get objective function value

Returns

objective function value

Implemented in ScipParaSolution, and BbParaSolution.

Referenced by BbParaSolver::processTagSolution(), BbParaSolver::saveIfImprovedSolutionWasFound(), BbParaSolver::sendIfImprovedSolutionWasFound(), BbParaSolver::sendLocalSolution(), BbParaSolver::sendSolverState(), and BbParaSolver::updateGlobalBestIncumbentSolution().

read()

virtual bool read ( ParaComm *  comm, gzstream::igzstream &  in  )

pure virtual

function to read ParaSolution object from checkpoint file

Parameters

comm	communicator used
in	gzstream for input

Implemented in ScipParaSolution.

receive()

virtual void receive ( ParaComm *  comm, int  source  )

pure virtual

receive solution data

Parameters

comm	communicator used
source	source rank

Implemented in ScipParaSolutionMpi, and ScipParaSolutionTh.

Referenced by BbParaLoadCoordinator::processTagSolution(), and BbParaSolver::processTagSolution().

send()

virtual void send ( ParaComm *  comm, int  destination  )

pure virtual

send solution data

Parameters

comm	communicator used
destination	destination rank

Implemented in ScipParaSolutionMpi, and ScipParaSolutionTh.

Referenced by BbParaLoadCoordinator::processRacingRampUpTagSolverState(), BbParaLoadCoordinator::processTagSolverState(), BbParaSolver::sendIfImprovedSolutionWasFound(), BbParaSolver::sendLocalSolution(), and BbParaLoadCoordinator::warmStart().

toString()

virtual const std::string toString ( )

virtual

stringfy ParaSolution object

Returns

string to show inside of this object

Reimplemented in ScipParaSolution.

Definition at line 140 of file paraSolution.h.

write()

virtual void write ( gzstream::ogzstream &  out )

pure virtual

function to write ParaSolution object to checkpoint file

Parameters

out	gzstream for output

Implemented in ScipParaSolution.