Scippy

UG

Ubiquity Generator framework

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ParaParamSet Class Referenceabstract

class ParaParamSet More...

#include <paraParamSet.h>

Inheritance diagram for ParaParamSet:
ParaParamSetMpi ParaParamSetTh BbParaParamSet ScipParaParamSet

Public Member Functions

 ParaParamSet ()
 constructor More...
 
 ParaParamSet (size_t nInParaParams)
 constructor More...
 
virtual ~ParaParamSet ()
 destructor More...
 
bool getBoolParamValue (int param)
 get bool parameter value More...
 
void setBoolParamValue (int param, bool value)
 set bool parameter value More...
 
bool getBoolParamDefaultValue (int param)
 get default value of bool parameter More...
 
void setBoolParamDefaultValue (int param)
 set bool parameter default value More...
 
bool isBoolParamDefaultValue (int param)
 check if bool parameter is default value or not More...
 
int getIntParamValue (int param)
 get int parameter value More...
 
void setIntParamValue (int param, int value)
 set int parameter value More...
 
int getIntParamDefaultValue (int param)
 get default value of int parameter More...
 
void setIntParamDefaultValue (int param)
 set int parameter default value More...
 
bool isIntParamDefaultValue (int param)
 check if int parameter is default value or not More...
 
long long getLongintParamValue (int param)
 get long int parameter value More...
 
void setLongintParamValue (int param, long long value)
 set long int parameter value More...
 
long long getLongintParamDefaultValue (int param)
 get default value of long int parameter More...
 
void setLongintParamDefaultValue (int param)
 set long int parameter default value More...
 
bool isLongintParamDefaultValue (int param)
 check if long int parameter is default value or not More...
 
double getRealParamValue (int param)
 get real parameter value More...
 
void setRealParamValue (int param, double value)
 set real parameter value More...
 
double getRealParamDefaultValue (int param)
 get default value of real parameter More...
 
void setRealParamDefaultValue (int param)
 set real parameter default value More...
 
bool isRealParamDefaultValue (int param)
 check if real parameter is default value or not More...
 
char getCharParamValue (int param)
 get char parameter value More...
 
void setCharParamValue (int param, char value)
 set char parameter value More...
 
char getCharParamDefaultValue (int param)
 get default value of char parameter More...
 
void setCharParamDefaultValue (int param)
 set char parameter default value More...
 
bool isCharParamDefaultValue (int param)
 check if char parameter is default value or not More...
 
const char * getStringParamValue (int param)
 get string parameter value More...
 
void setStringParamValue (int param, const char *value)
 set string parameter value More...
 
const char * getStringParamDefaultValue (int param)
 get default value of string parameter More...
 
void setStringParamDefaultValue (int param)
 set string parameter default value More...
 
bool isStringParamDefaultValue (int param)
 check if string parameter is default value or not More...
 
virtual void read (ParaComm *comm, const char *filename)
 read ParaParams from file More...
 
void write (std::ostream *os)
 write ParaParams to output stream More...
 
size_t getParaParamsSize ()
 get parameter table size More...
 
virtual size_t getNumBoolParams ()=0
 get number of bool parameters More...
 
virtual size_t getNumIntParams ()=0
 get number of int parameters More...
 
virtual size_t getNumLongintParams ()=0
 get number of longint parameters More...
 
virtual size_t getNumRealParams ()=0
 get number of real parameters More...
 
virtual size_t getNumCharParams ()=0
 get number of char parameters More...
 
virtual size_t getNumStringParams ()=0
 get number of string parameters More...
 
virtual int bcast (ParaComm *comm, int root)=0
 broadcast ParaParams More...
 

Protected Member Functions

int paramParaseBool (ParaParam *paraParam, char *valuestr)
 parse bool parameter More...
 
int paramParaseInt (ParaParam *paraParam, char *valuestr)
 parse int parameter More...
 
int paramParaseLongint (ParaParam *paraParam, char *valuestr)
 parse long int parameter More...
 
int paramParaseReal (ParaParam *paraParam, char *valuestr)
 parse real parameter More...
 
int paramParaseChar (ParaParam *paraParam, char *valuestr)
 parse real parameter More...
 
int paramParaseString (ParaParam *paraParam, char *valuestr)
 parse real parameter More...
 
int parameterParse (char *line, std::map< std::string, int > &mapStringToId)
 parse parameter (this routine is almost copy from paramset.c of SCIP code) More...
 

Protected Attributes

size_t nParaParams
 number of ParaParams More...
 
ParaParam ** paraParams
 array of ParaParams More...
 

Detailed Description

class ParaParamSet

Definition at line 850 of file paraParamSet.h.

Constructor & Destructor Documentation

◆ ParaParamSet() [1/2]

ParaParamSet ( )

constructor

Definition at line 927 of file paraParamSet.h.

◆ ParaParamSet() [2/2]

ParaParamSet ( size_t  nInParaParams)

constructor

bool params

int params

longint params

real params

char params

string params

Definition at line 50 of file paraParamSet.cpp.

References UG::Checkpoint, UG::CheckpointFilePath, UG::CheckpointInterval, UG::Deterministic, UG::DynamicAdjustNotificationInterval, UG::FinalCheckpointGeneratingTime, UG::LogSolvingStatus, UG::LogSolvingStatusFilePath, UG::LogTasksTransfer, UG::LogTasksTransferFilePath, UG::NotificationInterval, UG::NotificationSynchronization, ParaParamSet::nParaParams, UG::OutputParaParams, ParaParamSet::paraParams, UG::Quiet, UG::RacingParamsDirPath, UG::SolutionFilePath, UG::StatisticsToStdout, UG::TagTrace, UG::TagTraceFileName, UG::TempFilePath, and UG::TimeLimit.

◆ ~ParaParamSet()

virtual ~ParaParamSet ( )
virtual

destructor

Definition at line 943 of file paraParamSet.h.

References ParaParamSet::nParaParams, and ParaParamSet::paraParams.

Member Function Documentation

◆ bcast()

virtual int bcast ( ParaComm *  comm,
int  root 
)
pure virtual

broadcast ParaParams

Returns
always 0 (for future extensions)
Parameters
commcommunicator used
rootroot rank for broadcast

Implemented in ParaParamSetMpi, and ParaParamSetTh.

◆ getBoolParamDefaultValue()

bool getBoolParamDefaultValue ( int  param)

get default value of bool parameter

Returns
default bool parameter value
Parameters
parambool parameter id

Definition at line 195 of file paraParamSet.cpp.

References ParaParamBool::getDefaultValue(), ParaParamSet::paraParams, and UG::ParaParamTypeBool.

Referenced by ScipParaSolver::solve().

◆ getBoolParamValue()

bool getBoolParamValue ( int  param)

get bool parameter value

for bool parameters

Returns
value of the bool parameter specified
Parameters
parambool parameter id

Definition at line 174 of file paraParamSet.cpp.

References ParaParamBool::getValue(), ParaParamSet::paraParams, and UG::ParaParamTypeBool.

Referenced by BbParaSolverPool::activateSolver(), ScipParaDiffSubproblem::addLocalNodeInfo(), ScipParaInitiator::addRootNodeCuts(), BbParaLoadCoordinator::BbParaLoadCoordinator(), BbParaSolver::BbParaSolver(), BbParaSolverPool::BbParaSolverPool(), ScipParaObjCommPointHdlr::checkRootNodeSolvabilityAndSendParaNode(), ScipParaSolver::createSubproblem(), ScipParaSolver::freeSubproblem(), ScipParaObjNodesel::getNBoundChanges(), BbParaSolver::getThresholdValue(), BbParaSolverPool::inactivateSolver(), ScipParaInitiator::init(), BbParaSolver::isIterativeBreakDownApplied(), BbParaRacingSolverPool::isWinnerDecided(), main(), BbParaLoadCoordinator::newRacing(), BbParaSolver::notificationIsNecessary(), outputParaParamSet(), outputSolverParams(), BbParaLoadCoordinator::outputTabularSolvingStatus(), ParaLoadCoordinator::ParaLoadCoordinator(), ParaSolver::ParaSolver(), BbParaLoadCoordinator::processRacingRampUpTagCompletionOfCalculation(), BbParaLoadCoordinator::processRacingRampUpTagSolverState(), BbParaLoadCoordinator::processTagCompletionOfCalculation(), BbParaSolver::processTagIncumbentValue(), BbParaLoadCoordinator::processTagSelfSlpitNodeCalcuationState(), BbParaLoadCoordinator::processTagSolution(), BbParaLoadCoordinator::processTagSolverState(), BbParaLoadCoordinator::processTagTask(), ParaLoadCoordinator::processTagTerminated(), BbParaLoadCoordinator::processTagTermStateForInterruption(), BbParaSolver::processTagToken(), ParaParamSet::read(), BbParaParamSet::read(), BbParaSolver::receiveNewTaskAndReactivate(), ScipParaInitiator::reInit(), ScipParaSolver::reinitialize(), BbParaSolverPool::resetCountersInSolver(), BbParaLoadCoordinator::restartRacing(), BbParaLoadCoordinator::run(), BbParaSolver::run(), runSolverThread(), ScipParaSolver::saveOrgProblemBounds(), ScipParaObjCommPointHdlr::scip_exec(), ScipParaDiffSubproblem::ScipParaDiffSubproblem(), ScipParaObjCommPointHdlr::ScipParaObjCommPointHdlr(), ScipParaSolver::ScipParaSolver(), BbParaSolver::sendCompletionOfCalculation(), BbParaSolver::sendCompletionOfCalculationWithoutSolving(), BbParaLoadCoordinator::sendCutOffValue(), BbParaLoadCoordinator::sendIncumbentValue(), BbParaLoadCoordinator::sendInterruptRequest(), BbParaLoadCoordinator::sendParaTasksToIdleSolvers(), ScipParaInitiator::sendSolverInitializationMessage(), BbParaSolver::sendSolverState(), ScipParaSolver::setOriginalNodeSelectionStrategy(), ScipParaSolver::setRacingParams(), ScipParaSolver::setWinnerRacingParams(), ScipParaSolver::solve(), BbParaSolverPoolForMinimization::switchInCollectingMode(), BbParaSolverPool::switchOutCollectingMode(), ParaLoadCoordinator::terminateAllSolvers(), BbParaLoadCoordinator::terminateAllSolvers(), ScipParaInitiator::tryToSetIncumbentSolution(), BbParaSolver::waitAckCompletion(), BbParaLoadCoordinator::warmStart(), ScipParaInitiator::writeSolution(), BbParaLoadCoordinator::~BbParaLoadCoordinator(), ScipParaInitiator::~ScipParaInitiator(), and ScipParaSolver::~ScipParaSolver().

◆ getCharParamDefaultValue()

char getCharParamDefaultValue ( int  param)

get default value of char parameter

Returns
default char parameter value
Parameters
paramchar parameter id

Definition at line 411 of file paraParamSet.cpp.

References ParaParamChar::getDefaultValue(), ParaParamSet::paraParams, and UG::ParaParamTypeChar.

◆ getCharParamValue()

char getCharParamValue ( int  param)

get char parameter value

for char parameters

Returns
value of the char parameter specified
Parameters
paramchar parameter id

Definition at line 390 of file paraParamSet.cpp.

References ParaParamChar::getValue(), ParaParamSet::paraParams, and UG::ParaParamTypeChar.

◆ getIntParamDefaultValue()

int getIntParamDefaultValue ( int  param)

get default value of int parameter

Returns
default int parameter value
Parameters
paramint parameter id

Definition at line 249 of file paraParamSet.cpp.

References ParaParamInt::getDefaultValue(), ParaParamSet::paraParams, and UG::ParaParamTypeInt.

Referenced by BbParaRacingSolverPool::updateSolverStatus().

◆ getIntParamValue()

int getIntParamValue ( int  param)

get int parameter value

for int parameters

Returns
value of the int parameter specified
Parameters
paramint parameter id

Definition at line 228 of file paraParamSet.cpp.

References ParaParamInt::getValue(), ParaParamSet::paraParams, and UG::ParaParamTypeInt.

Referenced by BbParaSolverPool::activateSolver(), BbParaLoadCoordinator::BbParaLoadCoordinator(), BbParaSolver::BbParaSolver(), BbParaSolverPool::BbParaSolverPool(), BbParaSolverPoolForMinimization::BbParaSolverPoolForMinimization(), ScipParaSolver::createSubproblem(), ScipParaSolver::freeSubproblem(), ScipParaInitiator::generateRacingRampUpParameterSets(), BbParaSolver::getAggresivePresolvingDepth(), BbParaSolver::getAggresivePresolvingStopDepth(), BbParaSolver::getBigDualGapSubtreeHandlingStrategy(), ScipParaSolver::getChangeNodeSelName(), ScipParaInitiator::init(), BbParaSolver::isAggressivePresolvingSpecified(), BbParaSolver::isRacingRampUp(), BbParaLoadCoordinator::isRacingStage(), BbParaSolver::isRacingStage(), BbParaRacingSolverPool::isWinnerDecided(), main(), BbParaLoadCoordinator::outputTabularSolvingStatus(), BbParaLoadCoordinator::processRacingRampUpTagCompletionOfCalculation(), BbParaLoadCoordinator::processTagCompletionOfCalculation(), BbParaSolver::processTagRampUp(), BbParaLoadCoordinator::processTagSelfSlpitNodeCalcuationState(), BbParaLoadCoordinator::processTagSolution(), BbParaLoadCoordinator::processTagSolverState(), BbParaLoadCoordinator::processTagTask(), BbParaParamSet::read(), ScipParaSolver::recoverOriginalSettings(), ScipParaInitiator::reInit(), ScipParaSolver::reinitialize(), BbParaSolverPool::reinitToRestart(), BbParaLoadCoordinator::restartRacing(), BbParaLoadCoordinator::run(), runSolverThread(), ScipParaSolver::saveOrgProblemBounds(), ScipParaObjCommPointHdlr::scip_exec(), ScipParaLoadCoordinator::ScipParaLoadCoordinator(), ScipParaObjCommPointHdlr::ScipParaObjCommPointHdlr(), ScipParaSolver::ScipParaSolver(), BbParaLoadCoordinator::sendInterruptRequest(), BbParaLoadCoordinator::sendParaTasksToIdleSolvers(), ScipParaInitiator::sendSolverInitializationMessage(), ScipParaSolver::setRacingParams(), ScipParaSolver::solve(), BbParaSolverPoolForMinimization::switchInCollectingMode(), BbParaSolverPool::switchInCollectingToSolver(), BbParaLoadCoordinator::updateCheckpointFiles(), BbParaSolverPoolForMinimization::updateSolverStatus(), BbParaSolver::waitMessageIfNecessary(), BbParaLoadCoordinator::warmStart(), ParaParamSet::write(), and BbParaLoadCoordinator::~BbParaLoadCoordinator().

◆ getLongintParamDefaultValue()

long long getLongintParamDefaultValue ( int  param)

get default value of long int parameter

Returns
default long int parameter value
Parameters
paramlong int parameter id

Definition at line 303 of file paraParamSet.cpp.

References ParaParamLongint::getDefaultValue(), ParaParamSet::paraParams, and UG::ParaParamTypeLongint.

◆ getLongintParamValue()

long long getLongintParamValue ( int  param)

get long int parameter value

for long int parameters

Returns
value of the long int parameter specified
Parameters
paramlong int parameter id

Definition at line 282 of file paraParamSet.cpp.

References ParaParamLongint::getValue(), ParaParamSet::paraParams, and UG::ParaParamTypeLongint.

◆ getNumBoolParams()

virtual size_t getNumBoolParams ( )
pure virtual

get number of bool parameters

Returns
size of parameter table

Implemented in BbParaParamSet, and ScipParaParamSet.

Referenced by ParaParamSetMpi::allocateMemory(), and ParaParamSetMpi::freeMemory().

◆ getNumCharParams()

virtual size_t getNumCharParams ( )
pure virtual

get number of char parameters

Returns
size of parameter table

Implemented in BbParaParamSet, and ScipParaParamSet.

Referenced by ParaParamSetMpi::allocateMemory(), and ParaParamSetMpi::freeMemory().

◆ getNumIntParams()

virtual size_t getNumIntParams ( )
pure virtual

get number of int parameters

Returns
size of parameter table

Implemented in BbParaParamSet, and ScipParaParamSet.

Referenced by ParaParamSetMpi::allocateMemory(), and ParaParamSetMpi::freeMemory().

◆ getNumLongintParams()

virtual size_t getNumLongintParams ( )
pure virtual

get number of longint parameters

Returns
size of parameter table

Implemented in BbParaParamSet, and ScipParaParamSet.

Referenced by ParaParamSetMpi::allocateMemory(), and ParaParamSetMpi::freeMemory().

◆ getNumRealParams()

virtual size_t getNumRealParams ( )
pure virtual

get number of real parameters

Returns
size of parameter table

Implemented in BbParaParamSet, and ScipParaParamSet.

Referenced by ParaParamSetMpi::allocateMemory(), and ParaParamSetMpi::freeMemory().

◆ getNumStringParams()

virtual size_t getNumStringParams ( )
pure virtual

get number of string parameters

Returns
size of parameter table

Implemented in BbParaParamSet, and ScipParaParamSet.

Referenced by ParaParamSetMpi::allocateMemory(), and ParaParamSetMpi::freeMemory().

◆ getParaParamsSize()

size_t getParaParamsSize ( )

get parameter table size

Returns
size of parameter table

Definition at line 1232 of file paraParamSet.h.

References ParaParamSet::nParaParams.

Referenced by ParaParamSet::read(), and ParaParamSet::write().

◆ getRealParamDefaultValue()

double getRealParamDefaultValue ( int  param)

get default value of real parameter

Returns
default real parameter value
Parameters
paramreal parameter id

Definition at line 357 of file paraParamSet.cpp.

References ParaParamReal::getDefaultValue(), ParaParamSet::paraParams, and UG::ParaParamTypeReal.

◆ getRealParamValue()

double getRealParamValue ( int  param)

get real parameter value

for real parameters

Returns
value of the real parameter specified
Parameters
paramreal parameter id

Definition at line 336 of file paraParamSet.cpp.

References ParaParamReal::getValue(), ParaParamSet::paraParams, and UG::ParaParamTypeReal.

Referenced by BbParaSolverPool::activateSolver(), ScipParaInitiator::addRootNodeCuts(), BbParaLoadCoordinator::BbParaLoadCoordinator(), BbParaSolver::BbParaSolver(), BbParaSolverPool::BbParaSolverPool(), BbParaNodesMerger::generateMergeNodesCandidates(), ScipParaInitiator::generateRacingRampUpParameterSets(), BbParaSolver::getBoundGapForCollectingMode(), BbParaSolver::getBoundGapForStopSolving(), BbParaSolver::getThresholdValue(), BbParaSolver::getTimeStopSolvingMode(), ScipParaInitiator::init(), BbParaRacingSolverPool::isWinnerDecided(), BbParaSolver::notificationIsNecessary(), ParaSolver::ParaSolver(), BbParaLoadCoordinator::processTagAnotherNodeRequest(), BbParaLoadCoordinator::processTagCompletionOfCalculation(), BbParaLoadCoordinator::processTagSelfSlpitNodeCalcuationState(), BbParaLoadCoordinator::processTagSolverState(), BbParaLoadCoordinator::processTagTask(), ScipParaSolver::reinitialize(), BbParaLoadCoordinator::restartInRampDownPhase(), BbParaLoadCoordinator::run(), ScipParaObjCommPointHdlr::scip_exec(), ScipParaSolver::ScipParaSolver(), BbParaLoadCoordinator::sendInterruptRequest(), BbParaLoadCoordinator::sendParaTasksToIdleSolvers(), ScipParaSolver::solve(), BbParaSolverPoolForMinimization::switchInCollectingMode(), BbParaSolverPool::switchInCollectingToSolver(), BbParaSolverPoolForMinimization::updateSolverStatus(), BbParaSolver::waitAckCompletion(), BbParaLoadCoordinator::warmStart(), and BbParaLoadCoordinator::~BbParaLoadCoordinator().

◆ getStringParamDefaultValue()

const char * getStringParamDefaultValue ( int  param)

get default value of string parameter

Returns
default string parameter value
Parameters
paramstring parameter id

Definition at line 467 of file paraParamSet.cpp.

References ParaParamString::getDefaultValue(), ParaParamSet::paraParams, and UG::ParaParamTypeString.

◆ getStringParamValue()

const char * getStringParamValue ( int  param)

get string parameter value

for char parameters

Returns
value of the string parameter specified
Parameters
paramstring parameter id

Definition at line 444 of file paraParamSet.cpp.

References ParaParamString::getValue(), ParaParamSet::paraParams, and UG::ParaParamTypeString.

Referenced by BbParaLoadCoordinator::BbParaLoadCoordinator(), ScipParaSolver::createSubproblem(), ScipParaInitiator::generateRacingRampUpParameterSets(), ScipParaInitiator::init(), outputParaParamSet(), outputSolverParams(), ParaLoadCoordinator::ParaLoadCoordinator(), BbParaLoadCoordinator::processTagSolution(), ScipParaSolver::setRacingParams(), BbParaLoadCoordinator::updateCheckpointFiles(), BbParaLoadCoordinator::warmStart(), and ScipParaInitiator::writeSolution().

◆ isBoolParamDefaultValue()

bool isBoolParamDefaultValue ( int  param)

check if bool parameter is default value or not

Returns
true if bool parameter is default value
Parameters
parambool parameter id

Definition at line 215 of file paraParamSet.cpp.

References ParaParamBool::isDefaultValue(), ParaParamSet::paraParams, and UG::ParaParamTypeBool.

◆ isCharParamDefaultValue()

bool isCharParamDefaultValue ( int  param)

check if char parameter is default value or not

Returns
true if char parameter is default value
Parameters
paramchar parameter id

Definition at line 431 of file paraParamSet.cpp.

References ParaParamChar::isDefaultValue(), ParaParamSet::paraParams, and UG::ParaParamTypeChar.

◆ isIntParamDefaultValue()

bool isIntParamDefaultValue ( int  param)

check if int parameter is default value or not

Returns
true if int parameter is default value
Parameters
paramint parameter id

Definition at line 269 of file paraParamSet.cpp.

References ParaParamInt::isDefaultValue(), ParaParamSet::paraParams, and UG::ParaParamTypeInt.

◆ isLongintParamDefaultValue()

bool isLongintParamDefaultValue ( int  param)

check if long int parameter is default value or not

Returns
true if long int parameter is default value
Parameters
paramlong int parameter id

Definition at line 323 of file paraParamSet.cpp.

References ParaParamLongint::isDefaultValue(), ParaParamSet::paraParams, and UG::ParaParamTypeLongint.

◆ isRealParamDefaultValue()

bool isRealParamDefaultValue ( int  param)

check if real parameter is default value or not

Returns
true if real parameter is default value
Parameters
paramreal parameter id

Definition at line 377 of file paraParamSet.cpp.

References ParaParamReal::isDefaultValue(), ParaParamSet::paraParams, and UG::ParaParamTypeReal.

◆ isStringParamDefaultValue()

bool isStringParamDefaultValue ( int  param)

check if string parameter is default value or not

Returns
true if string parameter is default value
Parameters
paramstring parameter id

Definition at line 487 of file paraParamSet.cpp.

References ParaParamString::isDefaultValue(), ParaParamSet::paraParams, and UG::ParaParamTypeString.

◆ parameterParse()

int parameterParse ( char *  line,
std::map< std::string, int > &  mapStringToId 
)
protected

parse parameter (this routine is almost copy from paramset.c of SCIP code)

Returns
0, if parameter in a line is valid, -1: error

the parameterParse routine is almost copy from paramset.c of SCIP code

Parameters
lineparameter line
mapStringToIdmap of parameter sting to parameter id

Definition at line 674 of file paraParamSet.cpp.

References ParaParamSet::paramParaseBool(), ParaParamSet::paramParaseChar(), ParaParamSet::paramParaseInt(), ParaParamSet::paramParaseLongint(), ParaParamSet::paramParaseReal(), ParaParamSet::paramParaseString(), ParaParamSet::paraParams, UG::ParaParamTypeBool, UG::ParaParamTypeChar, UG::ParaParamTypeInt, UG::ParaParamTypeLongint, UG::ParaParamTypeReal, and UG::ParaParamTypeString.

Referenced by ParaParamSet::read().

◆ paramParaseBool()

int paramParaseBool ( ParaParam *  paraParam,
char *  valuestr 
)
protected

parse bool parameter

Returns
0, if the bool parameter value is valid, -1: error
Parameters
paraParampointer to ParaParam object
valuestrvalue string

Definition at line 497 of file paraParamSet.cpp.

References ParaParam::getParamName(), and ParaParamBool::setValue().

Referenced by ParaParamSet::parameterParse().

◆ paramParaseChar()

int paramParaseChar ( ParaParam *  paraParam,
char *  valuestr 
)
protected

parse real parameter

Returns
0, if the real parameter value is valid, -1: error
Parameters
paraParampointer to ParaParam object
valuestrvalue string

Definition at line 613 of file paraParamSet.cpp.

References ParaParamChar::getAllowedValues(), ParaParam::getComment(), ParaParam::getParamName(), OUTPUT_PARAM_VALUE_ERROR, and ParaParamChar::setValue().

Referenced by ParaParamSet::parameterParse().

◆ paramParaseInt()

int paramParaseInt ( ParaParam *  paraParam,
char *  valuestr 
)
protected

parse int parameter

Returns
0, if the int parameter value is valid, -1: error
Parameters
paraParampointer to ParaParam object
valuestrvalue string

Definition at line 523 of file paraParamSet.cpp.

References ParaParam::getComment(), ParaParamInt::getMinValue(), ParaParam::getParamName(), OUTPUT_PARAM_VALUE_ERROR, and ParaParamInt::setValue().

Referenced by ParaParamSet::parameterParse().

◆ paramParaseLongint()

int paramParaseLongint ( ParaParam *  paraParam,
char *  valuestr 
)
protected

parse long int parameter

Returns
0, if the long int parameter value is valid, -1: error
Parameters
paraParampointer to ParaParam object
valuestrvalue string

Definition at line 553 of file paraParamSet.cpp.

References ParaParam::getComment(), ParaParamLongint::getMinValue(), ParaParam::getParamName(), OUTPUT_PARAM_VALUE_ERROR, and ParaParamLongint::setValue().

Referenced by ParaParamSet::parameterParse().

◆ paramParaseReal()

int paramParaseReal ( ParaParam *  paraParam,
char *  valuestr 
)
protected

parse real parameter

Returns
0, if the real parameter value is valid, -1: error
Parameters
paraParampointer to ParaParam object
valuestrvalue string

Definition at line 583 of file paraParamSet.cpp.

References ParaParam::getComment(), ParaParamReal::getMinValue(), ParaParam::getParamName(), OUTPUT_PARAM_VALUE_ERROR, and ParaParamReal::setValue().

Referenced by ParaParamSet::parameterParse().

◆ paramParaseString()

int paramParaseString ( ParaParam *  paraParam,
char *  valuestr 
)
protected

parse real parameter

Returns
0, if the real parameter value is valid, -1: error
Parameters
paraParampointer to ParaParam object
valuestrvalue string

Definition at line 645 of file paraParamSet.cpp.

References ParaParam::getParamName(), and ParaParamString::setValue().

Referenced by ParaParamSet::parameterParse().

◆ read()

void read ( ParaComm *  comm,
const char *  filename 
)
virtual

read ParaParams from file

Parameters
commcommunicator used
filenamereading file name

Reimplemented in BbParaParamSet.

Definition at line 781 of file paraParamSet.cpp.

References UG::Checkpoint, ParaParamSet::getBoolParamValue(), ParaParamSet::getParaParamsSize(), ParaParamSet::parameterParse(), and ParaParamSet::paraParams.

Referenced by BbParaParamSet::read().

◆ setBoolParamDefaultValue()

void setBoolParamDefaultValue ( int  param)

set bool parameter default value

Parameters
parambool parameter id

Definition at line 205 of file paraParamSet.cpp.

References ParaParamSet::paraParams, UG::ParaParamTypeBool, and ParaParamBool::setDefaultValue().

◆ setBoolParamValue()

void setBoolParamValue ( int  param,
bool  value 
)

set bool parameter value

Parameters
parambool parameter id
valuevalue to be set

Definition at line 184 of file paraParamSet.cpp.

References ParaParamSet::paraParams, UG::ParaParamTypeBool, and ParaParamBool::setValue().

Referenced by BbParaParamSet::read(), and BbParaLoadCoordinator::run().

◆ setCharParamDefaultValue()

void setCharParamDefaultValue ( int  param)

set char parameter default value

Parameters
paramchar parameter id

Definition at line 421 of file paraParamSet.cpp.

References ParaParamSet::paraParams, UG::ParaParamTypeChar, and ParaParamChar::setDefaultValue().

◆ setCharParamValue()

void setCharParamValue ( int  param,
char  value 
)

set char parameter value

Parameters
paramchar parameter id
valuevalue to be set

Definition at line 400 of file paraParamSet.cpp.

References ParaParamSet::paraParams, UG::ParaParamTypeChar, and ParaParamChar::setValue().

◆ setIntParamDefaultValue()

void setIntParamDefaultValue ( int  param)

set int parameter default value

Parameters
paramint parameter id

Definition at line 259 of file paraParamSet.cpp.

References ParaParamSet::paraParams, UG::ParaParamTypeInt, and ParaParamInt::setDefaultValue().

◆ setIntParamValue()

void setIntParamValue ( int  param,
int  value 
)

set int parameter value

Parameters
paramint parameter id
valuevalue to be set

Definition at line 238 of file paraParamSet.cpp.

References ParaParamSet::paraParams, UG::ParaParamTypeInt, and ParaParamInt::setValue().

Referenced by BbParaLoadCoordinator::BbParaLoadCoordinator(), BbParaSolver::BbParaSolver(), ScipParaInitiator::init(), main(), BbParaParamSet::read(), BbParaLoadCoordinator::run(), and BbParaLoadCoordinator::warmStart().

◆ setLongintParamDefaultValue()

void setLongintParamDefaultValue ( int  param)

set long int parameter default value

Parameters
paramlong int parameter id

Definition at line 313 of file paraParamSet.cpp.

References ParaParamSet::paraParams, UG::ParaParamTypeLongint, and ParaParamLongint::setDefaultValue().

◆ setLongintParamValue()

void setLongintParamValue ( int  param,
long long  value 
)

set long int parameter value

Parameters
paramlong int parameter id
valuevalue to be set

Definition at line 292 of file paraParamSet.cpp.

References ParaParamSet::paraParams, UG::ParaParamTypeLongint, and ParaParamLongint::setValue().

◆ setRealParamDefaultValue()

void setRealParamDefaultValue ( int  param)

set real parameter default value

Parameters
paramreal parameter id

Definition at line 367 of file paraParamSet.cpp.

References ParaParamSet::paraParams, UG::ParaParamTypeReal, and ParaParamReal::setDefaultValue().

◆ setRealParamValue()

void setRealParamValue ( int  param,
double  value 
)

set real parameter value

Parameters
paramreal parameter id
valuevalue to be set

Definition at line 346 of file paraParamSet.cpp.

References ParaParamSet::paraParams, UG::ParaParamTypeReal, and ParaParamReal::setValue().

Referenced by BbParaLoadCoordinator::BbParaLoadCoordinator(), BbParaSolver::BbParaSolver(), BbParaSolver::notificationIsNecessary(), and BbParaSolver::waitAckCompletion().

◆ setStringParamDefaultValue()

void setStringParamDefaultValue ( int  param)

set string parameter default value

Parameters
paramstring parameter id

Definition at line 477 of file paraParamSet.cpp.

References ParaParamSet::paraParams, UG::ParaParamTypeString, and ParaParamString::setDefaultValue().

◆ setStringParamValue()

void setStringParamValue ( int  param,
const char *  value 
)

set string parameter value

Parameters
paramstring parameter id
valuevalue to be set

Definition at line 454 of file paraParamSet.cpp.

References ParaParamSet::paraParams, UG::ParaParamTypeString, and ParaParamString::setValue().

◆ write()

void write ( std::ostream *  os)

write ParaParams to output stream

Parameters
osostream for writing

Definition at line 827 of file paraParamSet.cpp.

References ParaParam::getComment(), ParaParamSet::getIntParamValue(), ParaParam::getParamName(), ParaParamSet::getParaParamsSize(), ParaParamBool::getValue(), ParaParamInt::getValue(), ParaParamLongint::getValue(), ParaParamReal::getValue(), ParaParamChar::getValue(), ParaParamString::getValue(), ParaParamBool::isDefaultValue(), ParaParamInt::isDefaultValue(), ParaParamLongint::isDefaultValue(), ParaParamReal::isDefaultValue(), ParaParamChar::isDefaultValue(), ParaParamString::isDefaultValue(), UG::OutputParaParams, ParaParamSet::paraParams, UG::ParaParamTypeBool, UG::ParaParamTypeChar, UG::ParaParamTypeInt, UG::ParaParamTypeLongint, UG::ParaParamTypeReal, and UG::ParaParamTypeString.

Referenced by outputParaParamSet().

Member Data Documentation

◆ nParaParams

size_t nParaParams
protected

number of ParaParams

Definition at line 855 of file paraParamSet.h.

Referenced by ParaParamSetMpi::allocateMemory(), ParaParamSetMpi::createDiffParams(), ParaParamSet::getParaParamsSize(), ParaParamSet::ParaParamSet(), and ParaParamSet::~ParaParamSet().

◆ paraParams

ParaParam** paraParams
protected

array of ParaParams

Definition at line 856 of file paraParamSet.h.

Referenced by ParaParamSetMpi::allocateMemory(), ParaParamSetMpi::createDiffParams(), ParaParamSet::getBoolParamDefaultValue(), ParaParamSet::getBoolParamValue(), ParaParamSet::getCharParamDefaultValue(), ParaParamSet::getCharParamValue(), ParaParamSet::getIntParamDefaultValue(), ParaParamSet::getIntParamValue(), ParaParamSet::getLongintParamDefaultValue(), ParaParamSet::getLongintParamValue(), ParaParamSet::getRealParamDefaultValue(), ParaParamSet::getRealParamValue(), ParaParamSet::getStringParamDefaultValue(), ParaParamSet::getStringParamValue(), ParaParamSet::isBoolParamDefaultValue(), ParaParamSet::isCharParamDefaultValue(), ParaParamSet::isIntParamDefaultValue(), ParaParamSet::isLongintParamDefaultValue(), ParaParamSet::isRealParamDefaultValue(), ParaParamSet::isStringParamDefaultValue(), ParaParamSet::parameterParse(), ParaParamSet::ParaParamSet(), ParaParamSet::read(), ScipParaParamSet::ScipParaParamSet(), ParaParamSet::setBoolParamDefaultValue(), ParaParamSet::setBoolParamValue(), ParaParamSet::setCharParamDefaultValue(), ParaParamSet::setCharParamValue(), ParaParamSetMpi::setDiffParams(), ParaParamSet::setIntParamDefaultValue(), ParaParamSet::setIntParamValue(), ParaParamSet::setLongintParamDefaultValue(), ParaParamSet::setLongintParamValue(), ParaParamSet::setRealParamDefaultValue(), ParaParamSet::setRealParamValue(), ParaParamSet::setStringParamDefaultValue(), ParaParamSet::setStringParamValue(), ParaParamSet::write(), and ParaParamSet::~ParaParamSet().