Public Types | Public Member Functions
BlisParams Class Reference

#include <BlisParams.h>

List of all members.

Public Types

enum  boolParams {
  useCons, useHeuristics, cutDuringRampup, endOfBoolParams,
  useCons, useHeuristics, cutDuringRampup, endOfBoolParams
}
 Character parameters. More...
enum  intParams {
  strongCandSize, branchStrategy, heurRound, cutClique,
  cutGomory, cutFlowCover, cutKnapsack, cutMir,
  cutOddHole, cutProbing, cutTwoMir, pseudoRelibility,
  lookAhead, endOfIntParams, 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, integerTol, cutoffInc, optimalRelGap,
  optimalAbsGap, pseudoWeight, cutFactor, denseConFactor,
  scaleConFactor, endOfDblParams
}
 Double parameters. More...
enum  strParams { strDummy, endOfStrParams, strDummy, endOfStrParams }
 String parameters. More...
enum  strArrayParams { strArrayDummy, endOfStrArrayParams, strArrayDummy, endOfStrArrayParams }
 There are no string array parameters. More...
enum  boolParams {
  useCons, useHeuristics, cutDuringRampup, endOfBoolParams,
  useCons, useHeuristics, cutDuringRampup, endOfBoolParams
}
 Character parameters. More...
enum  intParams {
  strongCandSize, branchStrategy, heurRound, cutClique,
  cutGomory, cutFlowCover, cutKnapsack, cutMir,
  cutOddHole, cutProbing, cutTwoMir, pseudoRelibility,
  lookAhead, endOfIntParams, 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, integerTol, cutoffInc, optimalRelGap,
  optimalAbsGap, pseudoWeight, cutFactor, denseConFactor,
  scaleConFactor, endOfDblParams
}
 Double parameters. More...
enum  strParams { strDummy, endOfStrParams, strDummy, endOfStrParams }
 String parameters. More...
enum  strArrayParams { strArrayDummy, endOfStrArrayParams, 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)
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.
 BlisParams ()
 The default constructor creates a parameter set with from the template argument structure.
Query methods

For user application: Following code are do NOT need to change.

The reason can not put following functions in base class AlpsParameterSet is that boolParams and endOfBoolParams etc., are NOT the same as those declared in base class.

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
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.
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.

Detailed Description

Definition at line 36 of file BlisParams.h.


Member Enumeration Documentation

Character parameters.

All of these variable are used as booleans (ture = 1, false = 0).

Enumerator:
useCons 

Whether generate cuts at all. Default: true.

useHeuristics 

Whether call heuristics. Default: true.

cutDuringRampup 

Whether generate cuts during rampup. Default: false.

endOfBoolParams 
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 40 of file BlisParams.h.

Integer paramters.

Enumerator:
strongCandSize 

The number of candidate used in strong branching.

Default: 10.

branchStrategy 

Branching strategy.

-1: disable, 0: default, 1: verbose. Default: 0 logLevel, 0: max infeasibilty, 1: pseudocost, 2: relibility, 3: strong branching.

heurRound 

Heuristics control.

-1: disable, 0: default, 1: moderate, 2: aggressive.

cutClique 

Cut generators control.

-1: disable, 0: default, 1: moderate, 2: aggressive.

cutGomory 
cutFlowCover 
cutKnapsack 
cutMir 
cutOddHole 
cutProbing 
cutTwoMir 
pseudoRelibility 

The relibility of pseudocost.

lookAhead 

The look ahead of pseudocost.

endOfIntParams 
strongCandSize 

The number of candidate used in strong branching.

Default: 10.

branchStrategy 

Branching strategy.

-1: disable, 0: default, 1: verbose. Default: 0 logLevel, 0: max infeasibilty, 1: pseudocost, 2: relibility, 3: strong branching.

heurRound 

Heuristics control.

-1: disable, 0: default, 1: moderate, 2: aggressive.

cutClique 

Cut generators control.

-1: disable, 0: default, 1: moderate, 2: aggressive.

cutGomory 
cutFlowCover 
cutKnapsack 
cutMir 
cutOddHole 
cutProbing 
cutTwoMir 
pseudoRelibility 

The relibility of pseudocost.

lookAhead 

The look ahead of pseudocost.

endOfIntParams 

Definition at line 52 of file BlisParams.h.

Double parameters.

Enumerator:
integerTol 

Tolrence to treat as an integer.

Default: 1.0e-5

cutoffInc 

The value added to relaxation value when deciding fathom.

Default:1.0e-6

optimalRelGap 

If the relative gap between best feasible and best relaxed fall into this gap, search stops.

Default: 1.0e-6

optimalAbsGap 

If the absolute gap between best feasible and best relaxed fall into this gap, search stops.

Default: 1.0e-4

pseudoWeight 

Weight used to calculate pseudocost.

cutFactor 

Limit the max number cuts applied at a node.

maxNumCons = (CutFactor - 1) * numCoreConstraints.

denseConFactor 

Dense constraint factor.

scaleConFactor 

Scaling indicator of a constraint.

endOfDblParams 
integerTol 

Tolrence to treat as an integer.

Default: 1.0e-5

cutoffInc 

The value added to relaxation value when deciding fathom.

Default:1.0e-6

optimalRelGap 

If the relative gap between best feasible and best relaxed fall into this gap, search stops.

Default: 1.0e-6

optimalAbsGap 

If the absolute gap between best feasible and best relaxed fall into this gap, search stops.

Default: 1.0e-4

pseudoWeight 

Weight used to calculate pseudocost.

cutFactor 

Limit the max number cuts applied at a node.

maxNumCons = (CutFactor - 1) * numCoreConstraints.

denseConFactor 

Dense constraint factor.

scaleConFactor 

Scaling indicator of a constraint.

endOfDblParams 

Definition at line 98 of file BlisParams.h.

String parameters.

Enumerator:
strDummy 
endOfStrParams 
strDummy 
endOfStrParams 

Definition at line 131 of file BlisParams.h.

There are no string array parameters.

Enumerator:
strArrayDummy 
endOfStrArrayParams 
strArrayDummy 
endOfStrArrayParams 

Definition at line 138 of file BlisParams.h.

Character parameters.

All of these variable are used as booleans (ture = 1, false = 0).

Enumerator:
useCons 

Whether generate cuts at all. Default: true.

useHeuristics 

Whether call heuristics. Default: true.

cutDuringRampup 

Whether generate cuts during rampup. Default: false.

endOfBoolParams 
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 40 of file BlisParams.h.

Integer paramters.

Enumerator:
strongCandSize 

The number of candidate used in strong branching.

Default: 10.

branchStrategy 

Branching strategy.

-1: disable, 0: default, 1: verbose. Default: 0 logLevel, 0: max infeasibilty, 1: pseudocost, 2: relibility, 3: strong branching.

heurRound 

Heuristics control.

-1: disable, 0: default, 1: moderate, 2: aggressive.

cutClique 

Cut generators control.

-1: disable, 0: default, 1: moderate, 2: aggressive.

cutGomory 
cutFlowCover 
cutKnapsack 
cutMir 
cutOddHole 
cutProbing 
cutTwoMir 
pseudoRelibility 

The relibility of pseudocost.

lookAhead 

The look ahead of pseudocost.

endOfIntParams 
strongCandSize 

The number of candidate used in strong branching.

Default: 10.

branchStrategy 

Branching strategy.

-1: disable, 0: default, 1: verbose. Default: 0 logLevel, 0: max infeasibilty, 1: pseudocost, 2: relibility, 3: strong branching.

heurRound 

Heuristics control.

-1: disable, 0: default, 1: moderate, 2: aggressive.

cutClique 

Cut generators control.

-1: disable, 0: default, 1: moderate, 2: aggressive.

cutGomory 
cutFlowCover 
cutKnapsack 
cutMir 
cutOddHole 
cutProbing 
cutTwoMir 
pseudoRelibility 

The relibility of pseudocost.

lookAhead 

The look ahead of pseudocost.

endOfIntParams 

Definition at line 52 of file BlisParams.h.

Double parameters.

Enumerator:
integerTol 

Tolrence to treat as an integer.

Default: 1.0e-5

cutoffInc 

The value added to relaxation value when deciding fathom.

Default:1.0e-6

optimalRelGap 

If the relative gap between best feasible and best relaxed fall into this gap, search stops.

Default: 1.0e-6

optimalAbsGap 

If the absolute gap between best feasible and best relaxed fall into this gap, search stops.

Default: 1.0e-4

pseudoWeight 

Weight used to calculate pseudocost.

cutFactor 

Limit the max number cuts applied at a node.

maxNumCons = (CutFactor - 1) * numCoreConstraints.

denseConFactor 

Dense constraint factor.

scaleConFactor 

Scaling indicator of a constraint.

endOfDblParams 
integerTol 

Tolrence to treat as an integer.

Default: 1.0e-5

cutoffInc 

The value added to relaxation value when deciding fathom.

Default:1.0e-6

optimalRelGap 

If the relative gap between best feasible and best relaxed fall into this gap, search stops.

Default: 1.0e-6

optimalAbsGap 

If the absolute gap between best feasible and best relaxed fall into this gap, search stops.

Default: 1.0e-4

pseudoWeight 

Weight used to calculate pseudocost.

cutFactor 

Limit the max number cuts applied at a node.

maxNumCons = (CutFactor - 1) * numCoreConstraints.

denseConFactor 

Dense constraint factor.

scaleConFactor 

Scaling indicator of a constraint.

endOfDblParams 

Definition at line 98 of file BlisParams.h.

String parameters.

Enumerator:
strDummy 
endOfStrParams 
strDummy 
endOfStrParams 

Definition at line 131 of file BlisParams.h.

There are no string array parameters.

Enumerator:
strArrayDummy 
endOfStrArrayParams 
strArrayDummy 
endOfStrArrayParams 

Definition at line 138 of file BlisParams.h.


Constructor & Destructor Documentation

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 150 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 150 of file BlisParams.h.


Member Function Documentation

virtual void BlisParams::createKeywordList ( ) [virtual]

Method for creating the list of keyword looked for in the parameter file.

virtual void BlisParams::setDefaultEntries ( ) [virtual]

Method for setting the default values for the parameters.

bool BlisParams::entry ( const boolParams  key) const [inline]

Definition at line 193 of file BlisParams.h.

int BlisParams::entry ( const intParams  key) const [inline]

Definition at line 195 of file BlisParams.h.

double BlisParams::entry ( const dblParams  key) const [inline]

Definition at line 197 of file BlisParams.h.

const std::string& BlisParams::entry ( const strParams  key) const [inline]

Definition at line 200 of file BlisParams.h.

const std::vector<std::string>& BlisParams::entry ( const strArrayParams  key) const [inline]

Definition at line 203 of file BlisParams.h.

void BlisParams::setEntry ( const boolParams  key,
const char *  val 
) [inline]

char* is true(1) or false(0), not used

Definition at line 208 of file BlisParams.h.

void BlisParams::setEntry ( const boolParams  key,
const char  val 
) [inline]

char is true(1) or false(0), not used

Definition at line 211 of file BlisParams.h.

void BlisParams::setEntry ( const boolParams  key,
const bool  val 
) [inline]

This method is the one that ever been used.

Definition at line 214 of file BlisParams.h.

void BlisParams::setEntry ( const intParams  key,
const char *  val 
) [inline]

Definition at line 217 of file BlisParams.h.

void BlisParams::setEntry ( const intParams  key,
const int  val 
) [inline]

Definition at line 220 of file BlisParams.h.

void BlisParams::setEntry ( const dblParams  key,
const char *  val 
) [inline]

Definition at line 223 of file BlisParams.h.

void BlisParams::setEntry ( const dblParams  key,
const double  val 
) [inline]

Definition at line 226 of file BlisParams.h.

void BlisParams::setEntry ( const strParams  key,
const char *  val 
) [inline]

Definition at line 229 of file BlisParams.h.

void BlisParams::setEntry ( const strArrayParams  key,
const char *  val 
) [inline]

Definition at line 232 of file BlisParams.h.

void BlisParams::pack ( AlpsEncoded &  buf) [inline]

Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here).

Definition at line 241 of file BlisParams.h.

void BlisParams::unpack ( AlpsEncoded &  buf) [inline]

Unpack the parameter set from the buffer.

Definition at line 254 of file BlisParams.h.

virtual void BlisParams::createKeywordList ( ) [virtual]

Method for creating the list of keyword looked for in the parameter file.

virtual void BlisParams::setDefaultEntries ( ) [virtual]

Method for setting the default values for the parameters.

bool BlisParams::entry ( const boolParams  key) const [inline]

Definition at line 193 of file BlisParams.h.

int BlisParams::entry ( const intParams  key) const [inline]

Definition at line 195 of file BlisParams.h.

double BlisParams::entry ( const dblParams  key) const [inline]

Definition at line 197 of file BlisParams.h.

const std::string& BlisParams::entry ( const strParams  key) const [inline]

Definition at line 200 of file BlisParams.h.

const std::vector<std::string>& BlisParams::entry ( const strArrayParams  key) const [inline]

Definition at line 203 of file BlisParams.h.

void BlisParams::setEntry ( const boolParams  key,
const char *  val 
) [inline]

char* is true(1) or false(0), not used

Definition at line 208 of file BlisParams.h.

void BlisParams::setEntry ( const boolParams  key,
const char  val 
) [inline]

char is true(1) or false(0), not used

Definition at line 211 of file BlisParams.h.

void BlisParams::setEntry ( const boolParams  key,
const bool  val 
) [inline]

This method is the one that ever been used.

Definition at line 214 of file BlisParams.h.

void BlisParams::setEntry ( const intParams  key,
const char *  val 
) [inline]

Definition at line 217 of file BlisParams.h.

void BlisParams::setEntry ( const intParams  key,
const int  val 
) [inline]

Definition at line 220 of file BlisParams.h.

void BlisParams::setEntry ( const dblParams  key,
const char *  val 
) [inline]

Definition at line 223 of file BlisParams.h.

void BlisParams::setEntry ( const dblParams  key,
const double  val 
) [inline]

Definition at line 226 of file BlisParams.h.

void BlisParams::setEntry ( const strParams  key,
const char *  val 
) [inline]

Definition at line 229 of file BlisParams.h.

void BlisParams::setEntry ( const strArrayParams  key,
const char *  val 
) [inline]

Definition at line 232 of file BlisParams.h.

void BlisParams::pack ( AlpsEncoded &  buf) [inline]

Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here).

Definition at line 241 of file BlisParams.h.

void BlisParams::unpack ( AlpsEncoded &  buf) [inline]

Unpack the parameter set from the buffer.

Definition at line 254 of file BlisParams.h.


The documentation for this class was generated from the following files: