ParaSolverTerminationState Class Reference

class ParaSolverTerminationState (Solver termination state in a ParaSolver) More...

#include <paraSolverTerminationState.h>

Inheritance diagram for ParaSolverTerminationState:

Public Member Functions
	ParaSolverTerminationState ()
	default constructor More...
	ParaSolverTerminationState (int inInterrupted, int inRank, int inNParaTasksReceived, int inNParaTasksSolved, double inRunningTime, double inIdleTimeToFirstParaTask, double inIdleTimeBetweenParaTasks, double inIddleTimeAfterLastParaTask, double inIdleTimeToWaitNotificationId, double inIdleTimeToWaitAckCompletion, double inIdleTimeToWaitToken, double inDetTime)
	constructor More...
virtual	~ParaSolverTerminationState ()
	destructor More...
virtual std::string	toString (ParaInitiator *initiator)=0
	stringfy ParaSolverTerminationState object More...
int	getInterruptedMode ()
	getter of interrupted flag More...
double	getDeterministicTime ()
	getter of deterministic time More...
virtual void	write (gzstream::ogzstream &out)=0
	write ParaSolverTerminationState to checkpoint file More...
virtual bool	read (ParaComm *comm, gzstream::igzstream &in)=0
	read ParaSolverTerminationState from checkpoint file More...
virtual void	send (ParaComm *comm, int destination, int tag)=0
	send this object More...
virtual void	receive (ParaComm *comm, int source, int tag)=0
	receive this object More...

Protected Attributes
int	interrupted
	indicate that this solver is interrupted or not. 0: not interrupted, 1: interrupted, 2: checkpoint, 3: racing-ramp up More...
int	rank
int	nParaTasksReceived
	number of ParaTasks received in this ParaSolver More...
int	nParaTasksSolved
double	runningTime
	this solver running time More...
double	idleTimeToFirstParaTask
	idle time to start solving the first ParaTask More...
double	idleTimeBetweenParaTasks
	idle time between ParaTasks processing More...
double	idleTimeAfterLastParaTask
	idle time after the last ParaTask was solved More...
double	idleTimeToWaitNotificationId
	idle time to wait notification Id messages More...
double	idleTimeToWaitAckCompletion
	idle time to wait ack completion message More...
double	idleTimeToWaitToken
double	detTime
	deterministic time, -1: should be non-deterministic More...

Detailed Description

class ParaSolverTerminationState (Solver termination state in a ParaSolver)

Definition at line 53 of file paraSolverTerminationState.h.

Constructor & Destructor Documentation

ParaSolverTerminationState() [1/2]

ParaSolverTerminationState

(

)

default constructor

Definition at line 88 of file paraSolverTerminationState.h.

ParaSolverTerminationState() [2/2]

ParaSolverTerminationState	(	int	inInterrupted,
		int	inRank,
		int	inNParaTasksReceived,
		int	inNParaTasksSolved,
		double	inRunningTime,
		double	inIdleTimeToFirstParaTask,
		double	inIdleTimeBetweenParaTasks,
		double	inIddleTimeAfterLastParaTask,
		double	inIdleTimeToWaitNotificationId,
		double	inIdleTimeToWaitAckCompletion,
		double	inIdleTimeToWaitToken,
		double	inDetTime
	)

constructor

Parameters

inInterrupted	indicate that this solver is interrupted or not. 0: not interrupted, 1: interrupted 2: checkpoint, 3: racing-ramp up
inRank	rank of this solver
inNParaTasksReceived	number of ParaTasks received in this ParaSolver
inNParaTasksSolved	number of ParaTasks solved ( received ) in this ParaSolver
inRunningTime	this solver running time
inIdleTimeToFirstParaTask	idle time to start solving the first ParaTask
inIdleTimeBetweenParaTasks	idle time between ParaTasks processing
inIddleTimeAfterLastParaTask	idle time after the last ParaTask was solved
inIdleTimeToWaitNotificationId	idle time to wait notification Id messages
inIdleTimeToWaitAckCompletion	idle time to wait ack completion message
inIdleTimeToWaitToken	idle time to wait token
inDetTime	deterministic time, -1: should be non-deterministic

Definition at line 108 of file paraSolverTerminationState.h.

~ParaSolverTerminationState()

virtual ~ParaSolverTerminationState ( )

virtual

destructor

Definition at line 144 of file paraSolverTerminationState.h.

Member Function Documentation

getDeterministicTime()

double getDeterministicTime

(

)

getter of deterministic time

Returns

deterministic time

Definition at line 171 of file paraSolverTerminationState.h.

References ParaSolverTerminationState::detTime.

Referenced by BbParaLoadCoordinator::processRacingRampUpTagCompletionOfCalculation(), BbParaLoadCoordinator::processTagSelfSplitTermStateForInterruption(), ParaLoadCoordinator::processTagTerminated(), and BbParaLoadCoordinator::processTagTermStateForInterruption().

getInterruptedMode()

int getInterruptedMode

(

)

getter of interrupted flag

Returns

true if it is interrupted, false otherwise

Definition at line 161 of file paraSolverTerminationState.h.

References ParaSolverTerminationState::interrupted.

Referenced by BbParaLoadCoordinator::processTagSelfSplitTermStateForInterruption(), ParaLoadCoordinator::processTagTerminated(), and BbParaLoadCoordinator::processTagTermStateForInterruption().

read()

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

pure virtual

read ParaSolverTerminationState from checkpoint file

Parameters

comm	communicator used
in	gzstream to input

Implemented in BbParaSolverTerminationState.

Referenced by BbParaLoadCoordinator::writePreviousStatisticsInformation().

receive()

virtual void receive ( ParaComm *  comm, int  source, int  tag  )

pure virtual

receive this object

Parameters

comm	communicator used
source	source rank
tag	TagTerminated

Implemented in BbParaSolverTerminationStateMpi, and BbParaSolverTerminationStateTh.

Referenced by BbParaLoadCoordinator::processRacingRampUpTagCompletionOfCalculation(), BbParaLoadCoordinator::processTagSelfSplitTermStateForInterruption(), ParaLoadCoordinator::processTagTerminated(), and BbParaLoadCoordinator::processTagTermStateForInterruption().

send()

virtual void send ( ParaComm *  comm, int  destination, int  tag  )

pure virtual

send this object

Parameters

comm	communicator used
destination	destination rank
tag	TagTerminated

Implemented in BbParaSolverTerminationStateMpi, and BbParaSolverTerminationStateTh.

Referenced by BbParaSolver::sendCompletionOfCalculation(), BbParaSolver::sendCompletionOfCalculationWithoutSolving(), BbParaSolver::sendSolverTerminationState(), and ScipParaSolver::~ScipParaSolver().

toString()

virtual std::string toString ( ParaInitiator *  initiator )

pure virtual

stringfy ParaSolverTerminationState object

Returns

string to show inside of ParaSolverTerminationState object

Parameters

initiator

pointer to ParaInitiator object

Implemented in BbParaSolverTerminationState.

Referenced by BbParaLoadCoordinator::processRacingRampUpTagCompletionOfCalculation(), ParaLoadCoordinator::processTagTerminated(), BbParaLoadCoordinator::processTagTermStateForInterruption(), and BbParaLoadCoordinator::writePreviousStatisticsInformation().

write()

virtual void write ( gzstream::ogzstream &  out )

pure virtual

write ParaSolverTerminationState to checkpoint file

Parameters

out	gzstream to output

Implemented in BbParaSolverTerminationState.

Referenced by BbParaSolverPool::writeSolverStatisticsToCheckpointFile().

Member Data Documentation

detTime

double detTime

protected

deterministic time, -1: should be non-deterministic

Definition at line 81 of file paraSolverTerminationState.h.

Referenced by BbParaSolverTerminationStateMpi::createDatatype(), BbParaSolverTerminationStateTh::createDatatype(), ParaSolverTerminationState::getDeterministicTime(), and BbParaSolverTerminationStateTh::receive().

idleTimeAfterLastParaTask

double idleTimeAfterLastParaTask

protected

idle time after the last ParaTask was solved

Definition at line 74 of file paraSolverTerminationState.h.

Referenced by BbParaSolverTerminationStateMpi::createDatatype(), BbParaSolverTerminationStateTh::createDatatype(), BbParaSolverTerminationState::read(), BbParaSolverTerminationStateTh::receive(), BbParaSolverTerminationState::toString(), and BbParaSolverTerminationState::write().

idleTimeBetweenParaTasks

double idleTimeBetweenParaTasks

protected

idle time between ParaTasks processing

Definition at line 73 of file paraSolverTerminationState.h.

Referenced by BbParaSolverTerminationStateMpi::createDatatype(), BbParaSolverTerminationStateTh::createDatatype(), BbParaSolverTerminationState::read(), BbParaSolverTerminationStateTh::receive(), BbParaSolverTerminationState::toString(), and BbParaSolverTerminationState::write().

idleTimeToFirstParaTask

double idleTimeToFirstParaTask

protected

idle time to start solving the first ParaTask

Definition at line 72 of file paraSolverTerminationState.h.

Referenced by BbParaSolverTerminationStateMpi::createDatatype(), BbParaSolverTerminationStateTh::createDatatype(), BbParaSolverTerminationState::read(), BbParaSolverTerminationStateTh::receive(), BbParaSolverTerminationState::toString(), and BbParaSolverTerminationState::write().

idleTimeToWaitAckCompletion

double idleTimeToWaitAckCompletion

protected

idle time to wait ack completion message

Definition at line 76 of file paraSolverTerminationState.h.

Referenced by BbParaSolverTerminationStateMpi::createDatatype(), BbParaSolverTerminationStateTh::createDatatype(), BbParaSolverTerminationStateTh::receive(), and BbParaSolverTerminationState::toString().

idleTimeToWaitNotificationId

double idleTimeToWaitNotificationId

protected

idle time to wait notification Id messages

Definition at line 75 of file paraSolverTerminationState.h.

Referenced by BbParaSolverTerminationStateMpi::createDatatype(), BbParaSolverTerminationStateTh::createDatatype(), BbParaSolverTerminationState::read(), BbParaSolverTerminationStateTh::receive(), BbParaSolverTerminationState::toString(), and BbParaSolverTerminationState::write().

idleTimeToWaitToken

double idleTimeToWaitToken

protected

idle time to wait token

times for root task process

Definition at line 77 of file paraSolverTerminationState.h.

Referenced by BbParaSolverTerminationStateMpi::createDatatype(), BbParaSolverTerminationStateTh::createDatatype(), BbParaSolverTerminationState::read(), BbParaSolverTerminationStateTh::receive(), BbParaSolverTerminationState::toString(), and BbParaSolverTerminationState::write().

interrupted

int interrupted

protected

indicate that this solver is interrupted or not. 0: not interrupted, 1: interrupted, 2: checkpoint, 3: racing-ramp up

Definition at line 57 of file paraSolverTerminationState.h.

Referenced by BbParaSolverTerminationStateMpi::createDatatype(), BbParaSolverTerminationStateTh::createDatatype(), ParaSolverTerminationState::getInterruptedMode(), BbParaSolverTerminationState::read(), BbParaSolverTerminationStateMpi::receive(), BbParaSolverTerminationStateTh::receive(), BbParaSolverTerminationStateMpi::send(), BbParaSolverTerminationState::toString(), and BbParaSolverTerminationState::write().

nParaTasksReceived

int nParaTasksReceived

protected

number of ParaTasks received in this ParaSolver

Definition at line 66 of file paraSolverTerminationState.h.

Referenced by BbParaSolverTerminationStateMpi::createDatatype(), BbParaSolverTerminationStateTh::createDatatype(), BbParaSolverTerminationState::read(), BbParaSolverTerminationStateTh::receive(), BbParaSolverTerminationState::toString(), and BbParaSolverTerminationState::write().

nParaTasksSolved

int nParaTasksSolved

protected

number of ParaTasks solved ( received ) in this ParaSolvere

times of this solver

Definition at line 67 of file paraSolverTerminationState.h.

Referenced by BbParaSolverTerminationStateMpi::createDatatype(), BbParaSolverTerminationStateTh::createDatatype(), BbParaSolverTerminationState::read(), BbParaSolverTerminationStateTh::receive(), BbParaSolverTerminationState::toString(), and BbParaSolverTerminationState::write().

rank

int rank

protected

rank of this solver

Counters related to this ParaSolver

Definition at line 62 of file paraSolverTerminationState.h.

Referenced by BbParaSolverTerminationStateMpi::createDatatype(), BbParaSolverTerminationStateTh::createDatatype(), BbParaSolverTerminationState::read(), BbParaSolverTerminationStateTh::receive(), BbParaSolverTerminationState::toString(), and BbParaSolverTerminationState::write().

runningTime

double runningTime

protected

this solver running time

Definition at line 71 of file paraSolverTerminationState.h.

Referenced by BbParaSolverTerminationStateMpi::createDatatype(), BbParaSolverTerminationStateTh::createDatatype(), BbParaSolverTerminationState::read(), BbParaSolverTerminationStateTh::receive(), BbParaSolverTerminationState::toString(), and BbParaSolverTerminationState::write().