ScipParaRacingRampUpParamSet Class Reference

#include <scipParaRacingRampUpParamSet.h>

Inheritance diagram for ScipParaRacingRampUpParamSet:

Public Member Functions
	ScipParaRacingRampUpParamSet ()
	ScipParaRacingRampUpParamSet (int inTerminationCriteria, int inNNodesLeft, double inTimeLimit, int inScipRacingParamSeed, int inPermuteProbSeed, int inGenerateBranchOrderSeed, ScipDiffParamSet *inScipDiffParamSet)
virtual	~ScipParaRacingRampUpParamSet ()
int	getPermuteProbSeed ()
int	getGenerateBranchOrderSeed ()
ScipDiffParamSet *	getScipDiffParamSet ()
int	getScipRacingParamSeed ()
void	write (gzstream::ogzstream &out)
bool	read (UG::ParaComm *comm, gzstream::igzstream &in)
const std::string	toString ()
int	getStrategy ()
Public Member Functions inherited from BbParaRacingRampUpParamSet
	BbParaRacingRampUpParamSet ()
	default constructor More...
	BbParaRacingRampUpParamSet (int inTerminationCriteria, int inNNodesLeft, double inTimeLimit)
	constructor More...
virtual	~BbParaRacingRampUpParamSet ()
	destructor More...
int	getTerminationCriteria ()
	get termination criteria More...
int	getStopRacingNNodesLeft ()
	get stop racing number of nodes left More...
double	getStopRacingTimeLimit ()
	get stop racing time limimt More...
virtual void	setWinnerRank (int rank)
	set winner rank TODO: this function and also getWinnerRank should be removed More...
virtual int	send (ParaComm *comm, int destination)=0
	send BbParaRacingRampUpParamSet More...
virtual int	receive (ParaComm *comm, int source)=0
	receive BbParaRacingRampUpParamSet More...
virtual void	write (gzstream::ogzstream &out)=0
	write to checkpoint file More...
virtual bool	read (ParaComm *comm, gzstream::igzstream &in)=0
	read from checkpoint file More...
virtual const std::string	toString ()=0
	stringfy BbParaRacingRampUpParamSet More...
virtual int	getStrategy ()=0
	get strategy More...
Public Member Functions inherited from ParaRacingRampUpParamSet
	ParaRacingRampUpParamSet ()
	default constructor More...
	ParaRacingRampUpParamSet (int inTerminationCriteria)
	constructor More...
virtual	~ParaRacingRampUpParamSet ()
	destructor More...
int	getTerminationCriteria ()
	get termination criteria More...
virtual void	setWinnerRank (int rank)
	set winner rank TODO: this function and also getWinnerRank should be removed More...
virtual int	send (ParaComm *comm, int destination)=0
	send ParaRacingRampUpParamSet More...
virtual int	receive (ParaComm *comm, int source)=0
	receive ParaRacingRampUpParamSet More...
virtual void	write (gzstream::ogzstream &out)=0
	write to checkpoint file More...
virtual bool	read (ParaComm *comm, gzstream::igzstream &in)=0
	read from checkpoint file More...
virtual const std::string	toString ()=0
	stringfy ParaRacingRampUpParamSet More...
virtual int	getStrategy ()=0
	get strategy More...

Protected Attributes
int	scipRacingParamSeed
int	permuteProbSeed
int	generateBranchOrderSeed
int	scipDiffParamSetInfo
ScipDiffParamSet *	scipDiffParamSet
Protected Attributes inherited from BbParaRacingRampUpParamSet
int	nNodesLeft
	stop racing number of nodes left More...
double	timeLimit
	stop racing time limit More...
Protected Attributes inherited from ParaRacingRampUpParamSet
int	terminationCriteria
	termination criteria of racing ramp-up : 0: number of nodes left, 1: time limit meaning must be defined in a derived class More...

Detailed Description

The racing ramp-up parameter set for SCIP solver

Definition at line 49 of file scipParaRacingRampUpParamSet.h.

Constructor & Destructor Documentation

ScipParaRacingRampUpParamSet() [1/2]

ScipParaRacingRampUpParamSet

(

)

default constructor

Definition at line 59 of file scipParaRacingRampUpParamSet.h.

ScipParaRacingRampUpParamSet() [2/2]

ScipParaRacingRampUpParamSet	(	int	inTerminationCriteria,
		int	inNNodesLeft,
		double	inTimeLimit,
		int	inScipRacingParamSeed,
		int	inPermuteProbSeed,
		int	inGenerateBranchOrderSeed,
		ScipDiffParamSet *	inScipDiffParamSet
	)

Definition at line 66 of file scipParaRacingRampUpParamSet.h.

References ScipParaRacingRampUpParamSet::scipDiffParamSetInfo.

~ScipParaRacingRampUpParamSet()

virtual ~ScipParaRacingRampUpParamSet ( )

virtual

destructor

Definition at line 83 of file scipParaRacingRampUpParamSet.h.

References ScipParaRacingRampUpParamSet::scipDiffParamSet.

Member Function Documentation

getGenerateBranchOrderSeed()

int getGenerateBranchOrderSeed

(

)

getter of generateBranchOrderSeed

Definition at line 97 of file scipParaRacingRampUpParamSet.h.

References ScipParaRacingRampUpParamSet::generateBranchOrderSeed.

Referenced by ScipParaSolver::setRacingParams().

getPermuteProbSeed()

int getPermuteProbSeed

(

)

getter of permuteProbSeed

Definition at line 90 of file scipParaRacingRampUpParamSet.h.

References ScipParaRacingRampUpParamSet::permuteProbSeed.

Referenced by ScipParaSolver::setRacingParams(), and ScipParaSolver::setWinnerRacingParams().

getScipDiffParamSet()

ScipDiffParamSet * getScipDiffParamSet

(

)

getter of ScipDiffParamSet

Definition at line 104 of file scipParaRacingRampUpParamSet.h.

References ScipParaRacingRampUpParamSet::scipDiffParamSet.

Referenced by ScipParaSolver::setRacingParams().

getScipRacingParamSeed()

int getScipRacingParamSeed

(

)

Definition at line 110 of file scipParaRacingRampUpParamSet.h.

References ScipParaRacingRampUpParamSet::scipRacingParamSeed.

Referenced by ScipParaSolver::setRacingParams().

getStrategy()

int getStrategy ( )

virtual

Implements BbParaRacingRampUpParamSet.

Definition at line 143 of file scipParaRacingRampUpParamSet.h.

References ScipParaRacingRampUpParamSet::scipRacingParamSeed.

read()

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

virtual

read scipParaRacingRampUpParamSet

Implements BbParaRacingRampUpParamSet.

Definition at line 62 of file scipParaRacingRampUpParamSet.cpp.

References comm, DEF_SCIP_PARA_COMM, ScipParaRacingRampUpParamSet::generateBranchOrderSeed, ScipParaRacingRampUpParamSet::permuteProbSeed, ScipDiffParamSet::read(), ScipParaRacingRampUpParamSet::scipDiffParamSet, ScipParaRacingRampUpParamSet::scipDiffParamSetInfo, and ScipParaRacingRampUpParamSet::scipRacingParamSeed.

toString()

const std::string toString ( )

virtual

stringfy ScipParaRacingRampUpParamSet

Implements BbParaRacingRampUpParamSet.

Definition at line 130 of file scipParaRacingRampUpParamSet.h.

References ScipParaRacingRampUpParamSet::generateBranchOrderSeed, ScipParaRacingRampUpParamSet::permuteProbSeed, ScipParaRacingRampUpParamSet::scipDiffParamSet, ScipParaRacingRampUpParamSet::scipDiffParamSetInfo, ScipParaRacingRampUpParamSet::scipRacingParamSeed, and ScipDiffParamSet::toString().

write()

void write ( gzstream::ogzstream &  out )

virtual

write scipParaRacingRampUpParamSet

Implements BbParaRacingRampUpParamSet.

Definition at line 46 of file scipParaRacingRampUpParamSet.cpp.

References ScipParaRacingRampUpParamSet::generateBranchOrderSeed, ScipParaRacingRampUpParamSet::permuteProbSeed, ScipParaRacingRampUpParamSet::scipDiffParamSet, ScipParaRacingRampUpParamSet::scipDiffParamSetInfo, ScipParaRacingRampUpParamSet::scipRacingParamSeed, and ScipDiffParamSet::write().

Member Data Documentation

generateBranchOrderSeed

int generateBranchOrderSeed

protected

seed to generate branching order

Definition at line 54 of file scipParaRacingRampUpParamSet.h.

Referenced by ScipParaRacingRampUpParamSetMpi::createDatatype(), ScipParaRacingRampUpParamSetTh::createDatatype(), ScipParaRacingRampUpParamSet::getGenerateBranchOrderSeed(), ScipParaRacingRampUpParamSet::read(), ScipParaRacingRampUpParamSetTh::receive(), ScipParaRacingRampUpParamSet::toString(), and ScipParaRacingRampUpParamSet::write().

permuteProbSeed

int permuteProbSeed

protected

seed to permute problem

Definition at line 53 of file scipParaRacingRampUpParamSet.h.

Referenced by ScipParaRacingRampUpParamSetMpi::createDatatype(), ScipParaRacingRampUpParamSetTh::createDatatype(), ScipParaRacingRampUpParamSet::getPermuteProbSeed(), ScipParaRacingRampUpParamSet::read(), ScipParaRacingRampUpParamSetTh::receive(), ScipParaRacingRampUpParamSet::toString(), and ScipParaRacingRampUpParamSet::write().

scipDiffParamSet

ScipDiffParamSet* scipDiffParamSet

protected

scip parameter set different from default values for racing ramp-up

Definition at line 56 of file scipParaRacingRampUpParamSet.h.

Referenced by ScipParaRacingRampUpParamSetTh::createDatatype(), ScipParaRacingRampUpParamSet::getScipDiffParamSet(), ScipParaRacingRampUpParamSet::read(), ScipParaRacingRampUpParamSetMpi::receive(), ScipParaRacingRampUpParamSetTh::receive(), ScipParaRacingRampUpParamSetMpi::send(), ScipParaRacingRampUpParamSet::toString(), ScipParaRacingRampUpParamSet::write(), and ScipParaRacingRampUpParamSet::~ScipParaRacingRampUpParamSet().

scipDiffParamSetInfo

int scipDiffParamSetInfo

protected

1: with scipDiffParamSet, 0: no scipDiffParamSet

Definition at line 55 of file scipParaRacingRampUpParamSet.h.

Referenced by ScipParaRacingRampUpParamSetMpi::createDatatype(), ScipParaRacingRampUpParamSetTh::createDatatype(), ScipParaRacingRampUpParamSet::read(), ScipParaRacingRampUpParamSetMpi::receive(), ScipParaRacingRampUpParamSetTh::receive(), ScipParaRacingRampUpParamSet::ScipParaRacingRampUpParamSet(), ScipParaRacingRampUpParamSetMpi::send(), ScipParaRacingRampUpParamSet::toString(), and ScipParaRacingRampUpParamSet::write().

scipRacingParamSeed

int scipRacingParamSeed

protected

seed to generate SCIP racing parameter

Definition at line 52 of file scipParaRacingRampUpParamSet.h.

Referenced by ScipParaRacingRampUpParamSetMpi::createDatatype(), ScipParaRacingRampUpParamSetTh::createDatatype(), ScipParaRacingRampUpParamSet::getScipRacingParamSeed(), ScipParaRacingRampUpParamSet::getStrategy(), ScipParaRacingRampUpParamSet::read(), ScipParaRacingRampUpParamSetTh::receive(), ScipParaRacingRampUpParamSet::toString(), and ScipParaRacingRampUpParamSet::write().