UG
Ubiquity Generator framework
Ubiquity Generator framework
Class for initiator. More...
#include <paraInitiator.h>
Public Member Functions | |
| ParaInitiator (ParaComm *inComm, ParaTimer *inTimer) | |
| constructor More... | |
| virtual | ~ParaInitiator () |
| destructor More... | |
| bool | isWarmStarted () |
| check if the execution is warm started (restarted) or not More... | |
| const char * | getPrefixWarm () |
| get prefix of warm start (restart) files More... | |
| ParaComm * | getParaComm () |
| get communicator being used More... | |
| virtual int | init (ParaParamSet *params, int argc, char **argv) |
| initialize initiator More... | |
| virtual int | reInit (int nRestartedRacing)=0 |
| reinitizalie initiator TODO: this function should be in inherited class More... | |
| virtual ParaInstance * | getParaInstance ()=0 |
| get instance object More... | |
| virtual void | sendSolverInitializationMessage ()=0 |
| send solver initialization message More... | |
| virtual void | generateRacingRampUpParameterSets (int nParamSets, ParaRacingRampUpParamSet **racingRampUpParamSets)=0 |
| generate racing ramp-up parameter sets TODO: this function may be in inherited class More... | |
| virtual double | getEpsilon ()=0 |
| get epsilon specified More... | |
| virtual void | writeSolution (const std::string &message)=0 |
| write solution More... | |
| virtual void | writeParaInstance (const std::string &filename)=0 |
| write ParaInstance More... | |
| virtual void | writeCheckpointSolution (const std::string &filename)=0 |
| write checkpoint solution More... | |
| virtual double | readSolutionFromCheckpointFile (char *afterCheckpointingSolutionFileName)=0 |
| read solution from checkpoint file More... | |
| virtual void | writeSolverParameters (std::ostream *os)=0 |
| write solver runtime parameters More... | |
| virtual void | outputFinalSolverStatistics (std::ostream *os, double time)=0 |
| output final solver statistics More... | |
| virtual std::string | getStatus ()=0 |
| get solving status string More... | |
| virtual void | printSolverVersion (std::ostream *os)=0 |
| print solver version More... | |
Public Attributes | |
| bool | comment |
| print comment messages More... | |
Protected Attributes | |
| ParaComm * | paraComm |
| communicator used More... | |
| ParaTimer * | timer |
| timer used More... | |
| char * | prefixWarm |
| prefix of warm start files More... | |
Friends | |
| std::ostream & | operator<< (std::ostream &os, const ParaInitiator ¶Initiator) |
| output line initiator More... | |
Class for initiator.
Definition at line 62 of file paraInitiator.h.
| ParaInitiator | ( | ParaComm * | inComm, |
| ParaTimer * | inTimer | ||
| ) |
constructor
| inComm | communicator used |
| inTimer | timer used |
Definition at line 76 of file paraInitiator.h.
|
virtual |
destructor
Definition at line 90 of file paraInitiator.h.
|
pure virtual |
generate racing ramp-up parameter sets TODO: this function may be in inherited class
| nParamSets | number of parameter sets to be generated |
| racingRampUpParamSets | array of the racing parameter sets |
Implemented in ScipParaInitiator.
Referenced by BbParaLoadCoordinator::warmStart().
|
pure virtual |
get epsilon specified
Implemented in ScipParaInitiator.
Referenced by BbParaLoadCoordinator::outputTabularSolvingStatus(), ParaLoadCoordinator::ParaLoadCoordinator(), BbParaLoadCoordinator::processRacingRampUpTagCompletionOfCalculation(), BbParaLoadCoordinator::processTagCompletionOfCalculation(), and BbParaLoadCoordinator::processTagSelfSlpitNodeCalcuationState().
| ParaComm * getParaComm | ( | ) |
get communicator being used
Definition at line 130 of file paraInitiator.h.
References ParaInitiator::paraComm.
|
pure virtual |
get instance object
Implemented in ScipParaInitiator.
Referenced by BbParaLoadCoordinator::BbParaLoadCoordinator(), ParaLoadCoordinator::ParaLoadCoordinator(), BbParaLoadCoordinator::processTagSolution(), BbParaLoadCoordinator::restartRacing(), BbParaLoadCoordinator::run(), BbParaLoadCoordinator::updateCheckpointFiles(), and BbParaLoadCoordinator::warmStart().
| const char * getPrefixWarm | ( | ) |
get prefix of warm start (restart) files
Definition at line 120 of file paraInitiator.h.
References ParaInitiator::prefixWarm.
Referenced by BbParaLoadCoordinator::BbParaLoadCoordinator(), outputParaParamSet(), outputSolverParams(), BbParaLoadCoordinator::warmStart(), and BbParaLoadCoordinator::writePreviousStatisticsInformation().
|
pure virtual |
|
virtual |
initialize initiator
| params | UG parameter used |
| argc | the number of command line arguments |
| argv | array of the arguments |
Reimplemented in ScipParaInitiator.
Definition at line 140 of file paraInitiator.h.
References UG::getGitHash(), and UG_VERSION.
| bool isWarmStarted | ( | ) |
check if the execution is warm started (restarted) or not
Definition at line 110 of file paraInitiator.h.
References ParaInitiator::prefixWarm.
Referenced by main(), and ScipParaInitiator::sendSolverInitializationMessage().
|
pure virtual |
output final solver statistics
| os | output stream to write final solver statistics |
| time | computing time |
Implemented in ScipParaInitiator.
Referenced by BbParaLoadCoordinator::~BbParaLoadCoordinator().
|
pure virtual |
print solver version
| os | output file (or NULL for standard output) |
Implemented in ScipParaInitiator.
|
pure virtual |
read solution from checkpoint file
| afterCheckpointingSolutionFileName | name of after checkpointing solution file |
Implemented in ScipParaInitiator.
Referenced by BbParaLoadCoordinator::warmStart().
|
pure virtual |
reinitizalie initiator TODO: this function should be in inherited class
| nRestartedRacing | the number of restarted racing |
Implemented in ScipParaInitiator.
Referenced by BbParaLoadCoordinator::restartRacing().
|
pure virtual |
send solver initialization message
Implemented in ScipParaInitiator.
|
pure virtual |
write checkpoint solution
| filename | output file name |
Implemented in ScipParaInitiator.
Referenced by BbParaLoadCoordinator::processTagSolution(), and BbParaLoadCoordinator::updateCheckpointFiles().
|
pure virtual |
|
pure virtual |
write solution
| message | message head string |
Implemented in ScipParaInitiator.
Referenced by BbParaLoadCoordinator::warmStart(), and BbParaLoadCoordinator::~BbParaLoadCoordinator().
|
pure virtual |
write solver runtime parameters
| os | output stream to write solver parameters |
Implemented in ScipParaInitiator.
|
friend |
output line initiator
Definition at line 98 of file paraInitiator.h.
| bool comment |
print comment messages
Definition at line 71 of file paraInitiator.h.
Referenced by ScipParaInitiator::init().
|
protected |
communicator used
Definition at line 66 of file paraInitiator.h.
Referenced by ScipParaInitiator::generateRacingRampUpParameterSets(), ParaInitiator::getParaComm(), ScipParaInitiator::init(), ScipParaInitiator::outputFinalSolverStatistics(), BbParaInitiator::readParaNodeFromCheckpointFile(), ScipParaInitiator::readSolutionFromCheckpointFile(), ScipParaInitiator::reInit(), ScipParaInitiator::sendSolverInitializationMessage(), and ScipParaInitiator::tryToSetIncumbentSolution().
|
protected |
prefix of warm start files
Definition at line 68 of file paraInitiator.h.
Referenced by ParaInitiator::getPrefixWarm(), ScipParaInitiator::init(), ParaInitiator::isWarmStarted(), and ScipParaInitiator::readSolutionFromCheckpointFile().
|
protected |
timer used
Definition at line 67 of file paraInitiator.h.
Referenced by ScipParaInitiator::addRootNodeCuts(), and ScipParaInitiator::init().