#include <BlisParams.h>
Inheritance diagram for BlisParams:
Public Types | |
useCons | |
Whether generate cuts at all. Default: true. | |
useHeuristics | |
Whether call heuristics. Default: true. | |
cutDuringRampup | |
Whether generate cuts during rampup. Default: false. | |
endOfBoolParams | |
strongCandSize | |
The number of candidate used in strong branching. | |
branchStrategy | |
Branching strategy. | |
heurRound | |
Heuristics control. | |
cutClique | |
Cut generators control. | |
cutGomory | |
cutFlowCover | |
cutKnapsack | |
cutMir | |
cutOddHole | |
cutProbing | |
cutTwoMir | |
pseudoRelibility | |
The relibility of pseudocost. | |
lookAhead | |
The look ahead of pseudocost. | |
endOfIntParams | |
integerTol | |
Tolrence to treat as an integer. | |
cutoffInc | |
The value added to relaxation value when deciding fathom. | |
optimalRelGap | |
If the relative gap between best feasible and best relaxed fall into this gap, search stops. | |
optimalAbsGap | |
If the absolute gap between best feasible and best relaxed fall into this gap, search stops. | |
pseudoWeight | |
Weight used to calculate pseudocost. | |
cutFactor | |
Limit the max number cuts applied at a node. | |
denseConFactor | |
Dense constraint factor. | |
scaleConFactor | |
Scaling indicator of a constraint. | |
endOfDblParams | |
strDummy | |
endOfStrParams | |
strArrayDummy | |
endOfStrArrayParams | |
enum | boolParams { useCons, useHeuristics, cutDuringRampup, endOfBoolParams } |
Character parameters. More... | |
enum | intParams { strongCandSize, branchStrategy, heurRound, cutClique, cutGomory, cutFlowCover, cutKnapsack, cutMir, cutOddHole, cutProbing, cutTwoMir, pseudoRelibility, lookAhead, endOfIntParams } |
Integer paramters. More... | |
enum | dblParams { integerTol, cutoffInc, optimalRelGap, optimalAbsGap, pseudoWeight, cutFactor, denseConFactor, scaleConFactor, endOfDblParams } |
Double parameters. More... | |
enum | strParams { strDummy, endOfStrParams } |
String parameters. More... | |
enum | strArrayParams { strArrayDummy, endOfStrArrayParams } |
There are no string array parameters. More... | |
Public Member Functions | |
virtual void | createKeywordList () |
Method for creating the list of keyword looked for in the parameter file. | |
virtual void | setDefaultEntries () |
Method for setting the default values for the parameters. | |
void | setEntry (const boolParams key, const char *val) |
char* is true(1) or false(0), not used | |
void | setEntry (const boolParams key, const char val) |
char is true(1) or false(0), not used | |
void | setEntry (const boolParams key, const bool val) |
This method is the one that ever been used. | |
void | setEntry (const intParams key, const char *val) |
void | setEntry (const intParams key, const int val) |
void | setEntry (const dblParams key, const char *val) |
void | setEntry (const dblParams key, const double val) |
void | setEntry (const strParams key, const char *val) |
void | setEntry (const strArrayParams key, const char *val) |
Constructors. | |
BlisParams () | |
The default constructor creates a parameter set with from the template argument structure. | |
Query methods | |
The members of the parameter set can be queried for using the overloaded entry() method. Using the example in the class documentation the user can get a parameter with the "<code>param.entry(USER_par::parameter_name)</code>" expression. | |
bool | entry (const boolParams key) const |
int | entry (const intParams key) const |
double | entry (const dblParams key) const |
const std::string & | entry (const strParams key) const |
const std::vector< std::string > & | entry (const strArrayParams key) const |
Packing/unpacking methods | |
void | pack (AlpsEncoded &buf) |
Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here). | |
void | unpack (AlpsEncoded &buf) |
Unpack the parameter set from the buffer. |
Definition at line 35 of file BlisParams.h.
Character parameters.
All of these variable are used as booleans (ture = 1, false = 0).
useCons | Whether generate cuts at all. Default: true. |
useHeuristics | Whether call heuristics. Default: true. |
cutDuringRampup | Whether generate cuts during rampup. Default: false. |
endOfBoolParams |
Definition at line 39 of file BlisParams.h.
Integer paramters.
Definition at line 51 of file BlisParams.h.
Double parameters.
Definition at line 97 of file BlisParams.h.
BlisParams::BlisParams | ( | ) | [inline] |
The default constructor creates a parameter set with from the template argument structure.
The keyword list is created and the defaults are set.
Definition at line 149 of file BlisParams.h.
References createKeywordList(), and setDefaultEntries().
virtual void BlisParams::createKeywordList | ( | ) | [virtual] |
Method for creating the list of keyword looked for in the parameter file.
Implements AlpsParameterSet.
Referenced by BlisParams().
virtual void BlisParams::setDefaultEntries | ( | ) | [virtual] |
Method for setting the default values for the parameters.
Implements AlpsParameterSet.
Referenced by BlisParams().
bool BlisParams::entry | ( | const boolParams | key | ) | const [inline] |
int BlisParams::entry | ( | const intParams | key | ) | const [inline] |
double BlisParams::entry | ( | const dblParams | key | ) | const [inline] |
const std::string& BlisParams::entry | ( | const strParams | key | ) | const [inline] |
const std::vector<std::string>& BlisParams::entry | ( | const strArrayParams | key | ) | const [inline] |
void BlisParams::setEntry | ( | const boolParams | key, | |
const char * | val | |||
) | [inline] |
char* is true(1) or false(0), not used
Definition at line 207 of file BlisParams.h.
References AlpsParameterSet::bpar_.
void BlisParams::setEntry | ( | const boolParams | key, | |
const char | val | |||
) | [inline] |
char is true(1) or false(0), not used
Definition at line 210 of file BlisParams.h.
References AlpsParameterSet::bpar_.
void BlisParams::setEntry | ( | const boolParams | key, | |
const bool | val | |||
) | [inline] |
This method is the one that ever been used.
Definition at line 213 of file BlisParams.h.
References AlpsParameterSet::bpar_.
void BlisParams::setEntry | ( | const intParams | key, | |
const char * | val | |||
) | [inline] |
void BlisParams::setEntry | ( | const intParams | key, | |
const int | val | |||
) | [inline] |
void BlisParams::setEntry | ( | const dblParams | key, | |
const char * | val | |||
) | [inline] |
void BlisParams::setEntry | ( | const dblParams | key, | |
const double | val | |||
) | [inline] |
void BlisParams::setEntry | ( | const strParams | key, | |
const char * | val | |||
) | [inline] |
void BlisParams::setEntry | ( | const strArrayParams | key, | |
const char * | val | |||
) | [inline] |
void BlisParams::pack | ( | AlpsEncoded & | buf | ) | [inline, virtual] |
Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here).
Reimplemented from AlpsParameterSet.
Definition at line 240 of file BlisParams.h.
References AlpsParameterSet::bpar_, AlpsParameterSet::dpar_, endOfBoolParams, endOfDblParams, endOfIntParams, endOfStrArrayParams, endOfStrParams, AlpsParameterSet::ipar_, AlpsParameterSet::sapar_, AlpsParameterSet::spar_, and AlpsEncoded::writeRep().
void BlisParams::unpack | ( | AlpsEncoded & | buf | ) | [inline, virtual] |
Unpack the parameter set from the buffer.
Reimplemented from AlpsParameterSet.
Definition at line 253 of file BlisParams.h.
References AlpsParameterSet::bpar_, AlpsParameterSet::dpar_, endOfBoolParams, endOfDblParams, endOfIntParams, endOfStrArrayParams, endOfStrParams, AlpsParameterSet::ipar_, AlpsEncoded::readRep(), AlpsParameterSet::sapar_, and AlpsParameterSet::spar_.