Cbc  2.9.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
CbcSolver Class Reference

This allows the use of the standalone solver in a flexible manner. More...

#include <CbcSolver.hpp>

+ Collaboration diagram for CbcSolver:

Public Member Functions

Solve method
int solve (int argc, const char *argv[], int returnMode)
 This takes a list of commands, does "stuff" and returns returnMode - 0 model and solver untouched - babModel updated 1 model updated - just with solution basis etc 2 model updated i.e. More...
 
int solve (const char *input, int returnMode)
 This takes a list of commands, does "stuff" and returns returnMode - 0 model and solver untouched - babModel updated 1 model updated - just with solution basis etc 2 model updated i.e. More...
 
Constructors and destructors etc
 CbcSolver ()
 Default Constructor. More...
 
 CbcSolver (const OsiClpSolverInterface &)
 Constructor from solver. More...
 
 CbcSolver (const CbcModel &)
 Constructor from model. More...
 
 CbcSolver (const CbcSolver &rhs)
 Copy constructor . More...
 
CbcSolveroperator= (const CbcSolver &rhs)
 Assignment operator. More...
 
 ~CbcSolver ()
 Destructor. More...
 
void fillParameters ()
 Fill with standard parameters. More...
 
void fillValuesInSolver ()
 Set default values in solvers from parameters. More...
 
void addUserFunction (CbcUser *function)
 Add user function. More...
 
void setUserCallBack (CbcStopNow *function)
 Set user call back. More...
 
void addCutGenerator (CglCutGenerator *generator)
 Add cut generator. More...
 
miscellaneous methods to line up with old
int * analyze (OsiClpSolverInterface *solverMod, int &numberChanged, double &increment, bool changeInt, CoinMessageHandler *generalMessageHandler)
 
void updateModel (ClpSimplex *model2, int returnMode)
 1 - add heuristics to model 2 - do heuristics (and set cutoff and best solution) 3 - for miplib test so skip some (out model later) More...
 
useful stuff
int intValue (CbcOrClpParameterType type) const
 Get int value. More...
 
void setIntValue (CbcOrClpParameterType type, int value)
 Set int value. More...
 
double doubleValue (CbcOrClpParameterType type) const
 Get double value. More...
 
void setDoubleValue (CbcOrClpParameterType type, double value)
 Set double value. More...
 
CbcUseruserFunction (const char *name) const
 User function (NULL if no match) More...
 
CbcModelmodel ()
 Return original Cbc model. More...
 
CbcModelbabModel ()
 Return updated Cbc model. More...
 
int numberUserFunctions () const
 Number of userFunctions. More...
 
CbcUser ** userFunctionArray () const
 User function array. More...
 
OsiClpSolverInterfaceoriginalSolver () const
 Copy of model on initial load (will contain output solutions) More...
 
CoinModeloriginalCoinModel () const
 Copy of model on initial load. More...
 
void setOriginalSolver (OsiClpSolverInterface *originalSolver)
 Copy of model on initial load (will contain output solutions) More...
 
void setOriginalCoinModel (CoinModel *originalCoinModel)
 Copy of model on initial load. More...
 
int numberCutGenerators () const
 Number of cutgenerators. More...
 
CglCutGenerator ** cutGeneratorArray () const
 Cut generator array. More...
 
double startTime () const
 Start time. More...
 
void setPrinting (bool onOff)
 Whether to print to std::cout. More...
 
void setReadMode (int value)
 Where to start reading commands. More...
 

Private Attributes

Private member data
CbcModel model_
 Reference model. More...
 
CbcModelbabModel_
 Updated model. More...
 
CbcUser ** userFunction_
 User functions. More...
 
int * statusUserFunction_
 Status of user functions 0 - not used 1 - needs cbc_load 2 - available - data in coinModel 3 - data loaded - can do cbc_save. More...
 
OsiClpSolverInterfaceoriginalSolver_
 Copy of model on initial load (will contain output solutions) More...
 
CoinModeloriginalCoinModel_
 Copy of model on initial load. More...
 
CglCutGenerator ** cutGenerator_
 Cut generators. More...
 
int numberUserFunctions_
 Number of user functions. More...
 
int numberCutGenerators_
 Number of cut generators. More...
 
CbcStopNowcallBack_
 Stop now stuff. More...
 
double startTime_
 Cpu time at instantiation. More...
 
CbcOrClpParamparameters_
 Parameters and values. More...
 
int numberParameters_
 Number of parameters. More...
 
bool doMiplib_
 Whether to do miplib test. More...
 
bool noPrinting_
 Whether to print to std::cout. More...
 
int readMode_
 Where to start reading commands. More...
 

Detailed Description

This allows the use of the standalone solver in a flexible manner.

It has an original OsiClpSolverInterface and CbcModel which it can use repeatedly, e.g., to get a heuristic solution and then start again.

So I [jjf] will need a primitive scripting language which can then call solve and manipulate solution value and solution arrays.

Also provides for user callback functions. Currently two ideas in gestation, CbcUser and CbcStopNow. The latter seems limited to deciding whether or not to stop. The former seems completely general, with a notion of importing and exporting, and a `solve', which should be interpreted as `do whatever this user function does'.

Parameter initialisation is at last centralised in fillParameters().

Definition at line 56 of file CbcSolver.hpp.

Constructor & Destructor Documentation

CbcSolver::CbcSolver ( )

Default Constructor.

CbcSolver::CbcSolver ( const OsiClpSolverInterface )

Constructor from solver.

CbcSolver::CbcSolver ( const CbcModel )

Constructor from model.

CbcSolver::CbcSolver ( const CbcSolver rhs)

Copy constructor .

CbcSolver::~CbcSolver ( )

Destructor.

Member Function Documentation

int CbcSolver::solve ( int  argc,
const char *  argv[],
int  returnMode 
)

This takes a list of commands, does "stuff" and returns returnMode - 0 model and solver untouched - babModel updated 1 model updated - just with solution basis etc 2 model updated i.e.

as babModel (babModel NULL) (only use without preprocessing)

int CbcSolver::solve ( const char *  input,
int  returnMode 
)

This takes a list of commands, does "stuff" and returns returnMode - 0 model and solver untouched - babModel updated 1 model updated - just with solution basis etc 2 model updated i.e.

as babModel (babModel NULL) (only use without preprocessing)

CbcSolver& CbcSolver::operator= ( const CbcSolver rhs)

Assignment operator.

void CbcSolver::fillParameters ( )

Fill with standard parameters.

void CbcSolver::fillValuesInSolver ( )

Set default values in solvers from parameters.

Misleading. The current code actually reads default values from the underlying solvers and installs them as default values for a subset of parameters in parameters_.

void CbcSolver::addUserFunction ( CbcUser function)

Add user function.

void CbcSolver::setUserCallBack ( CbcStopNow function)

Set user call back.

void CbcSolver::addCutGenerator ( CglCutGenerator generator)

Add cut generator.

int* CbcSolver::analyze ( OsiClpSolverInterface solverMod,
int &  numberChanged,
double &  increment,
bool  changeInt,
CoinMessageHandler generalMessageHandler 
)
void CbcSolver::updateModel ( ClpSimplex model2,
int  returnMode 
)

1 - add heuristics to model 2 - do heuristics (and set cutoff and best solution) 3 - for miplib test so skip some (out model later)

Updates model_ from babModel_ according to returnMode returnMode - 0 model and solver untouched - babModel updated 1 model updated - just with solution basis etc 2 model updated i.e. as babModel (babModel NULL) (only use without preprocessing)

int CbcSolver::intValue ( CbcOrClpParameterType  type) const

Get int value.

void CbcSolver::setIntValue ( CbcOrClpParameterType  type,
int  value 
)

Set int value.

double CbcSolver::doubleValue ( CbcOrClpParameterType  type) const

Get double value.

void CbcSolver::setDoubleValue ( CbcOrClpParameterType  type,
double  value 
)

Set double value.

CbcUser* CbcSolver::userFunction ( const char *  name) const

User function (NULL if no match)

CbcModel* CbcSolver::model ( )
inline

Return original Cbc model.

Definition at line 144 of file CbcSolver.hpp.

CbcModel* CbcSolver::babModel ( )
inline

Return updated Cbc model.

Definition at line 148 of file CbcSolver.hpp.

int CbcSolver::numberUserFunctions ( ) const
inline

Number of userFunctions.

Definition at line 152 of file CbcSolver.hpp.

CbcUser** CbcSolver::userFunctionArray ( ) const
inline

User function array.

Definition at line 156 of file CbcSolver.hpp.

OsiClpSolverInterface* CbcSolver::originalSolver ( ) const
inline

Copy of model on initial load (will contain output solutions)

Definition at line 160 of file CbcSolver.hpp.

CoinModel* CbcSolver::originalCoinModel ( ) const
inline

Copy of model on initial load.

Definition at line 164 of file CbcSolver.hpp.

void CbcSolver::setOriginalSolver ( OsiClpSolverInterface originalSolver)

Copy of model on initial load (will contain output solutions)

void CbcSolver::setOriginalCoinModel ( CoinModel originalCoinModel)

Copy of model on initial load.

int CbcSolver::numberCutGenerators ( ) const
inline

Number of cutgenerators.

Definition at line 172 of file CbcSolver.hpp.

CglCutGenerator** CbcSolver::cutGeneratorArray ( ) const
inline

Cut generator array.

Definition at line 176 of file CbcSolver.hpp.

double CbcSolver::startTime ( ) const
inline

Start time.

Definition at line 180 of file CbcSolver.hpp.

void CbcSolver::setPrinting ( bool  onOff)
inline

Whether to print to std::cout.

Definition at line 184 of file CbcSolver.hpp.

void CbcSolver::setReadMode ( int  value)
inline

Where to start reading commands.

Definition at line 188 of file CbcSolver.hpp.

Member Data Documentation

CbcModel CbcSolver::model_
private

Reference model.

Definition at line 197 of file CbcSolver.hpp.

CbcModel* CbcSolver::babModel_
private

Updated model.

Definition at line 200 of file CbcSolver.hpp.

CbcUser** CbcSolver::userFunction_
private

User functions.

Definition at line 203 of file CbcSolver.hpp.

int* CbcSolver::statusUserFunction_
private

Status of user functions 0 - not used 1 - needs cbc_load 2 - available - data in coinModel 3 - data loaded - can do cbc_save.

Definition at line 210 of file CbcSolver.hpp.

OsiClpSolverInterface* CbcSolver::originalSolver_
private

Copy of model on initial load (will contain output solutions)

Definition at line 212 of file CbcSolver.hpp.

CoinModel* CbcSolver::originalCoinModel_
private

Copy of model on initial load.

Definition at line 214 of file CbcSolver.hpp.

CglCutGenerator** CbcSolver::cutGenerator_
private

Cut generators.

Definition at line 216 of file CbcSolver.hpp.

int CbcSolver::numberUserFunctions_
private

Number of user functions.

Definition at line 218 of file CbcSolver.hpp.

int CbcSolver::numberCutGenerators_
private

Number of cut generators.

Definition at line 220 of file CbcSolver.hpp.

CbcStopNow* CbcSolver::callBack_
private

Stop now stuff.

Definition at line 222 of file CbcSolver.hpp.

double CbcSolver::startTime_
private

Cpu time at instantiation.

Definition at line 224 of file CbcSolver.hpp.

CbcOrClpParam* CbcSolver::parameters_
private

Parameters and values.

Definition at line 226 of file CbcSolver.hpp.

int CbcSolver::numberParameters_
private

Number of parameters.

Definition at line 228 of file CbcSolver.hpp.

bool CbcSolver::doMiplib_
private

Whether to do miplib test.

Definition at line 230 of file CbcSolver.hpp.

bool CbcSolver::noPrinting_
private

Whether to print to std::cout.

Definition at line 232 of file CbcSolver.hpp.

int CbcSolver::readMode_
private

Where to start reading commands.

Definition at line 234 of file CbcSolver.hpp.


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