Blis  0.94.0
Public Types | Public Member Functions | List of all members
BlisParams Class Reference

#include <BlisParams.h>

+ Inheritance diagram for BlisParams:

Public Types

enum  chrParams {
  cutRampUp, presolve, shareConstraints, shareVariables,
  sharePseudocostRampUp, sharePseudocostSearch, endOfChrParams
}
 Character parameters. More...
 
enum  intParams {
  branchStrategy, branchStrategyRampUp, cutStrategy, cutGenerationFrequency,
  cutPass, quickCutPass, cutCliqueStrategy, cutGomoryStrategy,
  cutFlowCoverStrategy, cutKnapsackStrategy, cutMirStrategy, cutOddHoleStrategy,
  cutProbingStrategy, cutTwoMirStrategy, cutCliqueFreq, cutGomoryFreq,
  cutFlowCoverFreq, cutKnapsackFreq, cutMirFreq, cutOddHoleFreq,
  cutProbingFreq, cutTwoMirFreq, difference, heurStrategy,
  heurCallFrequency, heurRoundStrategy, heurRoundFreq, lookAhead,
  pseudoRelibility, sharePcostDepth, sharePcostFrequency, strongCandSize,
  endOfIntParams
}
 Integer paramters. More...
 
enum  dblParams {
  cutFactor, cutoff, cutoffInc, denseConFactor,
  integerTol, objSense, optimalRelGap, optimalAbsGap,
  pseudoWeight, scaleConFactor, tailOff, 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. More...
 
virtual void setDefaultEntries ()
 Method for setting the default values for the parameters. More...
 
void setEntry (const chrParams key, const char *val)
 char* is true(1) or false(0), not used More...
 
void setEntry (const chrParams key, const char val)
 char is true(1) or false(0), not used More...
 
void setEntry (const chrParams key, const bool val)
 This method is the one that ever been used. More...
 
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. More...
 
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 chrParams and endOfChrParams 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 chrParams 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). More...
 
void unpack (AlpsEncoded &buf)
 Unpack the parameter set from the buffer. More...
 

Detailed Description

Definition at line 35 of file BlisParams.h.

Member Enumeration Documentation

Character parameters.

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

Enumerator
cutRampUp 

Generate cuts during rampup.

Default: true

presolve 

Presolve or not.

shareConstraints 

Share constraints Default: false.

shareVariables 

Share constraints Default: false.

sharePseudocostRampUp 

Share pseudocost during ramp up.

Default: true

sharePseudocostSearch 

Share pseudocost during search Default: false.

endOfChrParams 

Definition at line 39 of file BlisParams.h.

Integer paramters.

Enumerator
branchStrategy 

Branching strategy.

0: max infeasibilty, 1: pseudocost, 2: relibility, 3: strong branching. 4: bilevel branching

branchStrategyRampUp 
cutStrategy 

Cut generators control.

-2: root, -1: auto, 0: disable, any positive frequency

cutGenerationFrequency 

All constraint generators.

cutPass 
quickCutPass 

The pass to generate cuts.

cutCliqueStrategy 

The pass to generate cuts for quick branching.

cutGomoryStrategy 
cutFlowCoverStrategy 
cutKnapsackStrategy 
cutMirStrategy 
cutOddHoleStrategy 
cutProbingStrategy 
cutTwoMirStrategy 
cutCliqueFreq 
cutGomoryFreq 
cutFlowCoverFreq 
cutKnapsackFreq 
cutMirFreq 
cutOddHoleFreq 
cutProbingFreq 
cutTwoMirFreq 
difference 

-1 auto, 0, no, any integer frequency

heurStrategy 

Heuristics control.

BlisHeurStrategyRoot: root, BlisHeurStrategyAuto: auto, BlisHuerStrategyNone: disable, BlisHeurStrategyPeriodic: every 't' nodes

heurCallFrequency 

All heuristics.

heurRoundStrategy 
heurRoundFreq 
lookAhead 

The look ahead of pseudocost.

pseudoRelibility 

The relibility of pseudocost.

sharePcostDepth 

Maximum tree depth of sharing pseudocost.

sharePcostFrequency 

Frequency of sharing pseudocost.

strongCandSize 

The number of candidate used in strong branching.

Default: 10.

endOfIntParams 

Definition at line 62 of file BlisParams.h.

Double parameters.

Enumerator
cutFactor 

Limit the max number cuts applied at a node.

maxNumCons = (CutFactor - 1) * numCoreConstraints.

cutoff 

Cutoff any nodes whose objective value is higher than it.

cutoffInc 

The value added to relaxation value when deciding fathom.

Default:1.0e-6

denseConFactor 

Dense constraint factor.

integerTol 

Tolerance to treat as an integer.

Default: 1.0e-5

objSense 

Objective sense: min = 1.0, max = -1.0.

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.

scaleConFactor 

Scaling indicator of a constraint.

tailOff 

Tail off.

endOfDblParams 

Definition at line 133 of file BlisParams.h.

String parameters.

Enumerator
strDummy 
endOfStrParams 

Definition at line 174 of file BlisParams.h.

There are no string array parameters.

Enumerator
strArrayDummy 
endOfStrArrayParams 

Definition at line 181 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 193 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 chrParams  key) const
inline

Definition at line 236 of file BlisParams.h.

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

Definition at line 238 of file BlisParams.h.

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

Definition at line 240 of file BlisParams.h.

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

Definition at line 243 of file BlisParams.h.

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

Definition at line 246 of file BlisParams.h.

void BlisParams::setEntry ( const chrParams  key,
const char *  val 
)
inline

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

Definition at line 251 of file BlisParams.h.

void BlisParams::setEntry ( const chrParams  key,
const char  val 
)
inline

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

Definition at line 254 of file BlisParams.h.

void BlisParams::setEntry ( const chrParams  key,
const bool  val 
)
inline

This method is the one that ever been used.

Definition at line 257 of file BlisParams.h.

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

Definition at line 260 of file BlisParams.h.

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

Definition at line 263 of file BlisParams.h.

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

Definition at line 266 of file BlisParams.h.

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

Definition at line 269 of file BlisParams.h.

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

Definition at line 272 of file BlisParams.h.

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

Definition at line 275 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 284 of file BlisParams.h.

void BlisParams::unpack ( AlpsEncoded &  buf)
inline

Unpack the parameter set from the buffer.

Definition at line 297 of file BlisParams.h.


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