Scippy

UG

Ubiquity Generator framework

BbParaParamSet Class Reference

class BbParaParamSet More...

#include <bbParaParamSet.h>

Inheritance diagram for BbParaParamSet:
ParaParamSetTh ParaParamSet ScipParaParamSet

Public Member Functions

 BbParaParamSet ()
 constructor More...
 
 BbParaParamSet (size_t inNParaParams)
 constructor More...
 
virtual ~BbParaParamSet ()
 destructor More...
 
void read (ParaComm *comm, const char *filename)
 read ParaParams from file More...
 
virtual size_t getNumBoolParams ()
 get number of bool parameters More...
 
virtual size_t getNumIntParams ()
 get number of int parameters More...
 
virtual size_t getNumLongintParams ()
 get number of longint parameters More...
 
virtual size_t getNumRealParams ()
 get number of real parameters More...
 
virtual size_t getNumCharParams ()
 get number of char parameters More...
 
virtual size_t getNumStringParams ()
 get number of string parameters More...
 
- Public Member Functions inherited from ParaParamSetTh
 ParaParamSetTh ()
 constructor More...
 
 ParaParamSetTh (int inNParaParams)
 constructor More...
 
 ~ParaParamSetTh ()
 destructor More...
 
int bcast (ParaComm *comm, int root)
 broadcast ParaParams More...
 
- Public Member Functions inherited from ParaParamSet
 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...
 

Additional Inherited Members

- Protected Member Functions inherited from ParaParamSet
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 inherited from ParaParamSet
size_t nParaParams
 number of ParaParams More...
 
ParaParam ** paraParams
 array of ParaParams More...
 

Detailed Description

class BbParaParamSet

Definition at line 233 of file bbParaParamSet.h.

Constructor & Destructor Documentation

◆ BbParaParamSet() [1/2]

constructor

Definition at line 241 of file bbParaParamSet.h.

◆ BbParaParamSet() [2/2]

BbParaParamSet ( size_t  inNParaParams)

constructor

bool params

int params

longint params

real params

char params

string params

Definition at line 52 of file bbParaParamSet.cpp.

References UG::ABgapForSwitchingToBestSolver, UG::AggressivePresolveDepth, UG::AggressivePresolveStopDepth, UG::AllBoundChangesTransfer, UG::AllowableRegressionRatioInMerging, UG::AllowTreeSearchRestart, UG::BgapCollectingMode, UG::BgapStopSolvingMode, UG::BigDualGapSubtreeHandling, UG::BreakFirstSubtree, UG::CheckEffectOfRootNodePreprocesses, UG::CheckFeasibilityInLC, UG::CleanUp, UG::CollectingModeInterval, UG::CollectOnce, UG::CommunicateTighterBoundsInRacing, UG::ControlCollectingModeOnSolverSide, UG::CountingSolverRatioInRacing, UG::DeterministicTabularSolvingStatus, UG::DistributeBestPrimalSolution, UG::DualBoundGainBranchRatio, UG::DualBoundGainTest, UG::EnhancedCheckpointInterval, UG::EnhancedCheckpointStartTime, UG::EnhancedFinalCheckpoint, UG::EventWeightedDeterministic, UG::FinalCheckpointNSolvers, UG::FixedVariablesRatioInMerging, UG::GenerateReducedCheckpointFiles, UG::HugeImbalanceActiveSolverRatio, UG::HugeImbalanceThresholdTime, UG::InitialNodesGeneration, UG::InstanceTransferMethod, UG::IterativeBreakDown, UG::KeepNodesDepth, UG::KeepRacingUntilToFindFirstSolution, UG::LightWeightNodePenartyInCollecting, UG::LightWeightRootNodeProcess, UG::LogSubtreeInfo, UG::MaxNRacingParamSetSeed, UG::MaxNumberOfCollectingModeSolvers, UG::MergeNodesAtRestart, UG::MinNumberOfCollectingModeSolvers, UG::MultiplierForBgapCollectingMode, UG::MultiplierForBreakingTargetBound, UG::MultiplierForCollectingMode, UG::MultiplierToDetermineThresholdValue, UG::NBoundChangesForTransferNode, UG::NBoundChangesOfMergeNode, UG::NChangeIntoCollectingMode, UG::NChangeIntoCollectingModeNSolvers, UG::NCollectOnce, UG::NEagerToSolveAtRestart, UG::NEvaluationSolversToStopRacing, UG::NIdleSolversToTerminate, UG::NMaxCanditatesForCollecting, UG::NMaxRacingBaseParameters, UG::NMergingNodesAtRestart, UG::NNodesToKeepInCheckpointFile, UG::NNodesTransferLogging, UG::NoAggressiveSeparatorInRacing, UG::NoAllBoundChangesTransferInRacing, UG::NoAlternateSolving, UG::NodeTransferMode, UG::NoPreprocessingInLC, UG::NoSolverPresolvingAtRoot, UG::NoSolverPresolvingAtRootDefaultSet, UG::NoTransferThresholdReductionRatio, UG::NoUpperBoundTransferInRacing, UG::NSolverNodesStartBreaking, UG::NStopBreaking, UG::NStopSolvingMode, UG::NTransferLimitForBreaking, UG::NumberOfInitialNodes, UG::NumberOfNodesKeepingInRootSolver, UG::OmitInfeasibleTerminationInRacing, UG::OmitTerminationNSolutionsInRacing, UG::OutputPresolvedInstance, UG::OutputTabularSolvingStatus, UG::ProhibitCollectOnceMultiplier, UG::ProvingRun, UG::RacingRampUpTerminationCriteria, UG::RacingStatBranching, UG::RampUpPhaseProcess, UG::RandomNodeSelectionRatio, UG::RatioToApplyLightWeightRootProcess, UG::RestartInRampDownActiveSolverRatio, UG::RestartInRampDownThresholdTime, UG::RestartRacing, UG::SelfSplitTreeDepth, UG::SetAllDefaultsAfterRacing, UG::SolverOrderInCollectingMode, UG::SolverSettingsAtRacing, UG::SolverSettingsAtRootNode, UG::SolverSettingsExceptRootNode, UG::SolverSettingsForInitialPresolving, UG::StopRacingNumberOfNodesLeft, UG::StopRacingNumberOfNodesLeftMultiplier, UG::StopRacingTimeLimit, UG::StopRacingTimeLimitMultiplier, UG::TabularSolvingStatusInterval, UG::TimeStopSolvingMode, UG::TimeToIncreaseCMS, UG::TNodesTransferLogging, UG::TransferBendersCuts, UG::TransferBranchStats, UG::TransferConflictCuts, UG::TransferConflicts, UG::TransferLocalCuts, UG::TransferVarValueStats, UG::TryNBranchingOrderInRacing, UG::TryNVariablegOrderInRacing, UG::UseRootNodeCuts, and UG::WaitTerminationOfThreads.

◆ ~BbParaParamSet()

virtual ~BbParaParamSet ( )
virtual

destructor

Definition at line 288 of file bbParaParamSet.h.

Member Function Documentation

◆ getNumBoolParams()

virtual size_t getNumBoolParams ( )
virtual

get number of bool parameters

Returns
size of parameter table

Implements ParaParamSet.

Reimplemented in ScipParaParamSet.

Definition at line 305 of file bbParaParamSet.h.

References UG::BbParaParamsBoolN, and UG::ParaParamsBoolN.

◆ getNumCharParams()

virtual size_t getNumCharParams ( )
virtual

get number of char parameters

Returns
size of parameter table

Implements ParaParamSet.

Reimplemented in ScipParaParamSet.

Definition at line 345 of file bbParaParamSet.h.

References UG::BbParaParamsCharN, and UG::ParaParamsCharN.

◆ getNumIntParams()

virtual size_t getNumIntParams ( )
virtual

get number of int parameters

Returns
size of parameter table

Implements ParaParamSet.

Reimplemented in ScipParaParamSet.

Definition at line 315 of file bbParaParamSet.h.

References UG::BbParaParamsIntN, and UG::ParaParamsIntN.

◆ getNumLongintParams()

virtual size_t getNumLongintParams ( )
virtual

get number of longint parameters

Returns
size of parameter table

Implements ParaParamSet.

Reimplemented in ScipParaParamSet.

Definition at line 325 of file bbParaParamSet.h.

References UG::BbParaParamsLongintN, and UG::ParaParamsLongintN.

◆ getNumRealParams()

virtual size_t getNumRealParams ( )
virtual

get number of real parameters

Returns
size of parameter table

Implements ParaParamSet.

Reimplemented in ScipParaParamSet.

Definition at line 335 of file bbParaParamSet.h.

References UG::BbParaParamsCharN, and UG::ParaParamsCharN.

◆ getNumStringParams()

virtual size_t getNumStringParams ( )
virtual

get number of string parameters

Returns
size of parameter table

Implements ParaParamSet.

Reimplemented in ScipParaParamSet.

Definition at line 355 of file bbParaParamSet.h.

References UG::BbParaParamsStringN, and UG::ParaParamsStringN.

◆ read()

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

read ParaParams from file

check parameter consistency

Parameters
commcommunicator used
filenamereading file name

Reimplemented from ParaParamSet.

Definition at line 666 of file bbParaParamSet.cpp.

References UG::CollectOnce, comm, ParaParamSet::getBoolParamValue(), ParaParamSet::getIntParamValue(), UG::LogSolvingStatus, UG::LogTasksTransfer, UG::NCollectOnce, UG::Quiet, UG::RacingStatBranching, UG::RampUpPhaseProcess, ParaParamSet::read(), ParaParamSet::setBoolParamValue(), ParaParamSet::setIntParamValue(), and UG::TagTrace.

Referenced by main().