10 #include "CoinMessageHandler.hpp" 11 #include "OsiSolverInterface.hpp" 12 #include "OsiBranchingObject.hpp" 13 #include "OsiCuts.hpp" 14 #include "CoinWarmStartBasis.hpp" 19 #include "ClpDualRowPivot.hpp" 25 class OsiRowCutDebugger;
26 class CglCutGenerator;
29 class CglTreeProbingInfo;
41 class OsiClpSolverInterface;
234 int serialCuts(OsiCuts &cuts,
CbcNode *node, OsiCuts &slackCuts,
int lastNumberCuts);
250 int &numberNodesOutput,
int &
status);
255 #ifdef CBC_KEEP_DEPRECATED 261 CbcModel *cleanModel(
const double *lower,
const double *upper);
278 int subBranchAndBound(
CbcModel *model2,
296 int subBranchAndBound(
const double *lower,
const double *upper,
305 OsiSolverInterface *strengthenedModel();
315 CglPreProcess *
preProcess(
int makeEquality = 0,
int numberPasses = 5,
319 void postProcess(CglPreProcess *process);
357 double *saveLower = NULL,
358 double *saveUpper = NULL);
395 int lessThanThis,
int defaultValue = 1000);
436 bool tightenVubs(
int type,
bool allowMultipleBinary =
false,
437 double useCutoff = 1.0e50);
445 double useCutoff = 1.0e50);
463 void saveModel(OsiSolverInterface *saveSolver,
double *checkCutoffForRestart,
bool *feasible);
510 const inline OsiObject *
object(
int which)
const 556 #ifdef SWITCH_VARIABLES 560 int fixAssociated(OsiSolverInterface *
solver,
int cleanBasis);
562 int checkAssociated(
const OsiSolverInterface *
solver,
563 const double *solution,
int printLevel);
892 bool doCutsNow(
int allowForTopOfTree)
const;
976 int numberGood = COIN_INT_MAX);
1129 return solver_->getNumElements();
1158 return solver_->getColLower();
1164 return solver_->getColUpper();
1178 return solver_->getRowSense();
1191 return solver_->getRightHandSide();
1204 return solver_->getRowRange();
1210 return solver_->getRowLower();
1216 return solver_->getRowUpper();
1222 return solver_->getObjCoefficients();
1235 return solver_->isContinuous(colIndex);
1241 return solver_->isBinary(colIndex);
1250 return solver_->isInteger(colIndex);
1256 return solver_->isIntegerNonBinary(colIndex);
1262 return solver_->isFreeBinary(colIndex);
1268 return solver_->getMatrixByRow();
1274 return solver_->getMatrixByCol();
1280 return solver_->getInfinity();
1343 double &objectiveValue,
const double *solution,
1344 int fixVariables = 0);
1350 const double *solution);
1359 virtual double checkSolution(
double cutoff,
double *solution,
1360 int fixVariables,
double originalObjValue);
1368 int &numberObjectInfeasibilities)
const;
1396 return solver_->getColSolution();
1402 return solver_->getRowPrice();
1408 return solver_->getReducedCost();
1414 return solver_->getRowActivity();
1478 double objectiveValue,
bool check =
false);
1790 int howOften = 1,
const char *name = NULL,
1791 bool normal =
true,
bool atSolution =
false,
1792 bool infeasible =
false,
int howOftenInSub = -100,
1793 int whatDepth = -1,
int whatDepthInSub = -1);
1882 return object_[sequence]->priority();
1939 void newLanguage(CoinMessages::Language language);
2146 void goToDantzig(
int numberNodes, ClpDualRowPivot *&savePivotMethod);
2163 CbcModel(
const OsiSolverInterface &);
2224 OsiSolverInterface *returnSolver =
solver_;
2226 return returnSolver;
2414 int resolveClp(OsiClpSolverInterface *
solver,
int type);
2422 CbcNode *oldNode, OsiCuts &cuts,
2423 bool &resolved, CoinWarmStartBasis *lastws,
2424 const double *lowerBefore,
const double *upperBefore,
2425 OsiSolverBranch *&branches);
2433 CoinWarmStartBasis *
getEmptyBasis(
int ns = 0,
int na = 0)
const;
2447 bool allowResolve, OsiCuts *saveCuts,
2448 int numberNewCuts = 0,
const OsiRowCut **newCuts = NULL);
2485 double &lower,
double &upper,
int force);
2510 int *numberDown = NULL,
int *numberUp = NULL,
2511 int *numberDownInfeasible = NULL,
2512 int *numberUpInfeasible = NULL)
const;
2640 int numberFixed,
bool ifInfeasible);
2685 void setMIPStart(
const std::vector< std::pair< std::string, double > > &mipstart)
2704 void setMIPStart(
int count,
const char **colNames,
const double colValues[]);
3240 double &originalUpper);
3243 class OsiClpSolverInterface;
3246 int callCbc(
const char *input2, OsiClpSolverInterface &solver1);
3247 int callCbc(
const char *input2);
3248 int callCbc(
const std::string input2, OsiClpSolverInterface &solver1);
3249 int callCbc(
const std::string input2);
void flipModel()
Flip direction of optimization on all models.
bool isInitialSolveProvenOptimal() const
Is optimality proven (for initialSolve) ?
void passInSolverCharacteristics(OsiBabSolver *solverCharacteristics)
For advanced applications you may wish to modify the behavior of Cbc e.g.
CbcNodeInfo ** walkback_
Array used to assemble the path between a node and the search tree root.
const double * cbcColUpper_
Pointer to array[getNumCols()] (for speed) of column upper bounds.
const OsiObject * object(int which) const
Get the specified object.
int status_
Status of problem - 0 finished, 1 stopped, 2 difficulties.
void setProblemFeasibility(CbcFeasibilityBase *feasibility)
CglTreeProbingInfo * probingInfo_
Probing info.
double getDblParam(CbcDblParam key) const
Get a double parameter.
The objective is assumed to worsen by this amount for each integer infeasibility. ...
CbcObjectUpdateData * updateItems_
Update items.
int continuousPriority() const
Get anything with priority >= this can be treated as continuous.
void resetToReferenceSolver()
Uses a copy of reference solver to be current solver.
bool waitingForMiniBranchAndBound() const
Says if model is sitting there waiting for mini branch and bound to finish This is because an event h...
int numberExtraNodes_
Number of extra nodes in fast lp.
int getMaximumCutPasses() const
Get the maximum number of cut passes at other nodes (default 10)
Number of branches (may be more than number of nodes as may include strong branching) ...
void newLanguage(CoinMessages::Language language)
Set language.
const double * getColUpper() const
Get pointer to array[getNumCols()] of column upper bounds.
CbcNodeInfo ** lastNodeInfo_
int getExtraNodeCount() const
Get how many Nodes were enumerated in complete fathoming B&B inside CLP.
CbcModel * integerPresolve(bool weak=false)
Do integer presolve, creating a new (presolved) model.
void setPointers(const OsiSolverInterface *solver)
Set pointers for speed.
CbcModel * heuristicModel() const
A pointer to model from CbcHeuristic.
double * currentSolution_
Array holding the current solution.
char * integerInfo_
Whether of not integer.
CbcNodeInfo ** walkback() const
Get pointer to walkback.
void setHowOftenGlobalScan(int number)
Set how often to scan global cuts.
int strongStrategy_
Strategy for strong branching 0 - normal when to do all fractional 1 - root node 2 - depth less than ...
CbcNode * currentNode_
Current node so can be used elsewhere.
void setLastHeuristic(CbcHeuristic *last)
set last heuristic which found a solution
double getCurrentObjValue() const
Get current objective function value.
int parallelCuts(CbcBaseModel *master, OsiCuts &cuts, CbcNode *node, OsiCuts &slackCuts, int lastNumberCuts)
Generate one round of cuts - parallel mode returns - 0 - normal 1 - must keep going 2 - set numberTri...
const double * getRowActivity() const
Get pointer to array[getNumRows()] of row activity levels.
OsiBranchingInformation usefulInformation() const
Generate an OsiBranchingInformation object.
void setOptionalInteger(int index)
int numberSavedSolutions_
Number of saved solutions.
int numberSolutions_
Number of solutions.
int logLevel() const
Get log level.
double numberDJFixed_
Number of reduced cost fixings.
CbcBranchDecision * branchingMethod() const
Get the current branching decision method.
int preferredWay_
Preferred way of branching.
void setRandomSeed(int value)
Set random seed.
bool setAllowableFractionGap(double value)
Set the fraction allowable gap between the best known solution and the best possible solution...
const std::vector< std::pair< std::string, double > > & getMIPStart()
const double * cbcRowLower_
Pointer to array[getNumRows()] (for speed) of row lower bounds.
int cutoffRowNumber_
-1 - cutoff as constraint not activated -2 - waiting to activate >=0 - activated
int getMaximumNodes() const
Get the maximum node limit .
int currentNumberCuts() const
Number of entries in the list returned by addedCuts()
const double * getCbcRowLower() const
Get pointer to array[getNumRows()] (for speed) of row lower bounds.
int stateOfSearch_
State of search 0 - no solution 1 - only heuristic solutions 2 - branched to a solution 3 - no soluti...
int priority(int sequence) const
Returns priority level for an object (or 1000 if no priorities exist)
void incrementStrongInfo(int numberTimes, int numberIterations, int numberFixed, bool ifInfeasible)
Increment strong info.
CbcCountRowCut ** addedCuts_
The list of cuts initially collected for this subproblem.
void setCutoffAsConstraint(bool yesNo)
Set cutoff as constraint.
CbcSymmetry * symmetryInfo_
Symmetry information.
const double * getCbcColUpper() const
Get pointer to array[getNumCols()] (for speed) of column upper bounds.
bool resolveAfterTakeOffCuts_
Whether to force a resolve after takeOffCuts.
CglTreeProbingInfo * probingInfo() const
Get a pointer to probing info.
CbcModel & operator=(const CbcModel &rhs)
Assignment operator.
double sumChangeObjective2_
Sum of Changes to objective by subsequent solves.
int numberRowsAtContinuous() const
Number of rows in continuous (root) problem.
The maximum number of nodes before terminating.
int * whichGenerator_
Which cut generator generated this cut.
int maximumRows_
Maximum number of rows.
void setFastNodeDepth(int value)
Set depth for fast nodes.
CbcCompareBase * nodeCompare_
User node comparison function.
int getMaximumSolutions() const
Get the maximum number of solutions desired.
double * currentSolution() const
Solution to the most recent lp relaxation.
const double * testSolution() const
For testing infeasibilities - will point to currentSolution_ or solver–>getColSolution() ...
void setNumberStrongIterations(int number)
Set the number of iterations done in strong branching.
bool defaultHandler() const
Check default handler.
double getInfinity() const
Get solver's value for infinity.
bool setHeuristicFractionGap(double value)
Set the fraction heuristic gap between the best known solution and the best possible solution...
int maximumNumberUpdateItems_
Maximum number of outstanding update information items.
void setStrongStrategy(int value)
Set strong branching strategy.
int numberGlobalCutsIn_
Number of global cuts on entry to a node.
int * mutableStrongInfo()
Return mutable strong info.
virtual CbcModel * clone(bool cloneHandler)
Clone.
CbcNode * currentNode() const
Get a pointer to current node (be careful)
int maximumNumberIterations() const
Get maximum number of iterations (designed to be used in heuristics)
int specialOptions() const
Get special options.
void setHeuristicModel(CbcModel *model)
Set a pointer to model from CbcHeuristic.
void setCurrentPassNumber(int value)
Set current cut pass number in this round of cuts.
bool isNodeLimitReached() const
Node limit reached?
void setResolveAfterTakeOffCuts(bool yesNo)
void * temporaryPointer_
Useful temporary pointer.
const double * getCbcColSolution() const
Get pointer to array[getNumCols()] (for speed) of primal solution vector.
const double * getRowUpper() const
Get pointer to array[getNumRows()] of row upper bounds.
int numberExtraIterations() const
Number of extra iterations.
void incrementNodeCount(int value)
Increment how many nodes it took to solve the problem.
void setContinuousPriority(int value)
Set anything with priority >= this can be treated as continuous.
double getIntegerTolerance() const
Get the integrality tolerance .
void resizeWhichGenerator(int numberNow, int numberAfter)
Update size of whichGenerator.
const CoinPackedMatrix * getMatrixByRow() const
Get pointer to row-wise copy of matrix.
int callCbc(const char *input2, OsiClpSolverInterface &solver1)
void lockThread()
Locks a thread if parallel so that stuff like cut pool can be updated and/or used.
Just a marker, so that a static sized array can store parameters.
int serialCuts(OsiCuts &cuts, CbcNode *node, OsiCuts &slackCuts, int lastNumberCuts)
Generate one round of cuts - serial mode returns - 0 - normal 1 - must keep going 2 - set numberTries...
bool setInfeasibilityWeight(double value)
Set the weight per integer infeasibility .
OsiSolverInterface * solver_
The solver associated with this model.
void reserveCurrentSolution(const double *solution=NULL)
Make sure region there and optionally copy solution.
double * bestSolution_
Array holding the incumbent (best) solution.
bool getKeepNamesPreproc() const
bool setIntegerTolerance(double value)
Set the integrality tolerance .
double getInfeasibilityWeight() const
Get the weight per integer infeasibility .
int * integerVariable_
Indices of integer variables.
bool isFreeBinary(int colIndex) const
Return true if variable is binary and not fixed at either bound.
CbcModel * parentModel_
Parent model.
CoinMessageHandler * handler_
Message handler.
bool addCuts1(CbcNode *node, CoinWarmStartBasis *&lastws)
Traverse the tree from node to root and prep the model.
bool setMaximumSolutions(int value)
Set the maximum number of solutions desired.
int specialOptions_
Special options 0 bit (1) - check if cuts valid (if on debugger list) 1 bit (2) - use current basis t...
double minimumDrop_
Minimum degradation in objective value to continue cut generation.
Cutoff - stored for speed.
CbcCutGenerator ** generator_
int numberBeforeTrust() const
get the number of branches before pseudo costs believed in dynamic strong branching.
int numberLongStrong_
Number of long strong goes.
int fastNodeDepth_
Depth for fast nodes.
bool integerPresolveThisModel(OsiSolverInterface *originalSolver, bool weak=false)
Do integer presolve, modifying the current model.
int numberSolves_
Cumulative number of solves.
unsigned int ownership_
Ownership of objects and other stuff.
const double * getRowPrice() const
Get pointer to array[getNumRows()] of dual prices.
int getNumCols() const
Get number of columns.
CoinWarmStartBasis & workingBasis()
Work basis for temporary use.
const double * cbcColLower_
Whether to automatically do presolve before branch and bound.
int getPrintingMode() const
Get the printing mode.
CbcEventHandler * eventHandler_
Pointer to the event handler.
char * setupCleanVariables()
Sets up cleanVariables array (i.e. ones to be careful about)
void setStoredRowCuts(CglStored *cuts)
Set stored row cuts for donor/recipient CbcModel.
bool setDblParam(CbcDblParam key, double value)
Set a double parameter.
CbcHeuristic * lastHeuristic_
Pointer to heuristic solver which found last solution (or NULL)
CbcHeuristic ** heuristic_
Heuristic solvers.
void clearContinuousSolver()
Clear solver with continuous state.
CoinMessages * messagesPointer()
Return pointer to messages.
void makePartialCut(const OsiRowCut *cut, const OsiSolverInterface *solver=NULL)
Make partial cut into a global cut and save.
void setNumberHeuristicSolutions(int value)
Set number of heuristic solutions.
int getMultipleRootTries() const
Get multiple root tries.
int numberInfeasibleNodes_
Number of nodes infeasible by normal branching (before cuts)
Sum of non-zero changes on a branch.
double penaltyScaleFactor() const
Get scale factor to make penalties match strong.
int multipleRootTries_
Multiple root tries.
bool modelOwnsSolver()
Get ownership of solver.
void setPreProcess(CglPreProcess *preProcess)
Set CglPreProcess used before branch and bound.
int numberStrong_
Maximum number of candidates to consider for strong branching.
void setKeepNamesPreproc(bool _keep)
if original column names will be preserved in preprocessed problem
int moreSpecialOptions2_
More more special options 0 bit (1) - find switching variables 1 bit (2) - using fake objective until...
void setModelOwnsSolver(bool ourSolver)
Set ownership of solver.
void setNumberAnalyzeIterations(int number)
Number of analyze iterations to do.
int numberAnalyzeIterations() const
void setThreadMode(int value)
Set thread mode always use numberThreads for branching 1 set then deterministic 2 set then use number...
int takeOffCuts(OsiCuts &cuts, bool allowResolve, OsiCuts *saveCuts, int numberNewCuts=0, const OsiRowCut **newCuts=NULL)
Remove inactive cuts from the model.
void setNumberThreads(int value)
Set number of threads.
bool isProvenInfeasible() const
Is infeasiblity proven (or none better than cutoff)?
double * continuousSolution() const
Holds solution at continuous (after cuts if branchAndBound called)
void * getApplicationData() const
Get application data.
void saveReferenceSolver()
Save a copy of the current solver so can be reset to.
CbcStrategy * strategy_
Strategy.
const double * cbcRowPrice_
Pointer to array[getNumRows()] (for speed) of dual prices.
void setPrintFrequency(int number)
Set the print frequency.
CbcCutGenerator ** cutGenerators() const
Get the list of cut generators.
CoinMessageHandler * messageHandler() const
Return handler.
virtual double checkSolution(double cutoff, double *solution, int fixVariables, double originalObjValue)
Call this to really test if a valid solution can be feasible Solution is number columns in size...
int currentDepth_
Current depth.
void passInEventHandler(const CbcEventHandler *eventHandler)
Set an event handler.
void setNumberStrong(int number)
Set the maximum number of candidates to be evaluated for strong branching.
void setLanguage(CoinMessages::Language language)
OsiRowCut * conflictCut(const OsiSolverInterface *solver, bool &localCuts)
Create conflict cut (well - most of)
void passInTreeHandler(CbcTree &tree)
For modifying tree handling (original is cloned)
void incrementUsed(const double *solution)
Increases usedInSolution for nonzeros.
int numberNewCuts_
Number of new cuts.
void unlockThread()
Unlocks a thread if parallel to say cut pool stuff not needed.
void convertToDynamic()
If numberBeforeTrust >0 then we are going to use CbcBranchDynamic.
OsiObject ** object_
Integer and Clique and ...
CbcStatistics ** statistics_
statistics
const double * getCbcRowActivity() const
Get pointer to array[getNumRows()] (for speed) of row activity levels.
bool setAllowablePercentageGap(double value)
Set the percentage allowable gap between the best known solution and the best possible solution...
void setBranchingMethod(CbcBranchDecision *method)
Set the branching decision method.
int cleanBounds(OsiSolverInterface *solver, char *cleanVariables)
Clean model i.e.
const double * getCbcColLower() const
Get pointer to array[getNumCols()] (for speed) of column lower bounds.
void generateCpp(FILE *fp, int options)
Create C++ lines to get to current state.
int CbcMain(int argc, const char *argv[], CbcModel &babSolver)
int getIterationCount() const
Get how many iterations it took to solve the problem.
int maximumNumberIterations_
Maximum number of iterations (designed to be used in heuristics)
Adjusts printout 1 does different node message with number unsatisfied on last branch.
char integerType(int i) const
Whether or not integer.
void setApplicationData(void *appData)
Set application data.
double getAllowablePercentageGap() const
Get the percentage allowable gap between the best known solution and the best possible solution...
Stop when the gap between the objective value of the best known solution and the best bound on the ob...
bool isSolutionLimitReached() const
Solution limit reached?
double getCutoffIncrement() const
Get the CbcModel::CbcCutoffIncrement desired.
int getFathomCount() const
Get how many times complete fathoming B&B was done.
void setStrategy(CbcStrategy &strategy)
Set the strategy. Clones.
void setSearchStrategy(int value)
Set strategy worked out - mainly at root node for use by CbcNode.
void setOriginalColumns(const int *originalColumns, int numberGood=COIN_INT_MAX)
Set original columns as created by preprocessing.
void deleteSolutions()
Delete best and saved solutions.
CbcModel * subTreeModel(OsiSolverInterface *solver=NULL) const
For retrieving a copy of subtree model with given OsiSolver.
bool canStopOnGap() const
See if can stop on gap.
double getContinuousObjective() const
Value of objective at continuous.
const double * getCbcReducedCost() const
Get a pointer to array[getNumCols()] (for speed) of reduced costs.
void makeGlobalCuts()
Make partial cuts into global cuts.
const OsiRowCut ** lastCut_
CbcFullNodeInfo * topOfTree_
Pointer to top of tree.
int getNumberHeuristicSolutions() const
Get number of heuristic solutions.
bool eventHappened_
Whether event happened.
void setMoreSpecialOptions(int value)
Set more special options at present bottom 6 bits used for shadow price mode 1024 for experimental ho...
double penaltyScaleFactor_
Scale factor to make penalties match strong.
int numberStrongIterations_
Number of iterations in strong branching.
bool isContinuous(int colIndex) const
Return true if variable is continuous.
CbcNode ** solveOneNode(int whichSolver, CbcNode *node, int &numberNodesOutput, int &status)
Input one node output N nodes to put on tree and optional solution update This should be able to oper...
int numberUpdateItems_
Number of outstanding update information items.
bool setPrintingMode(int value)
Set the printing mode.
void setDefaultHandler(bool yesNo)
Set flag to say if handler_ is the default handler.
double getCutoff() const
Get the cutoff bound on the objective function - always as minimize.
void saveSolution(const OsiSolverInterface *osi, std::string fileName)
double getObjValue() const
Get best objective function value.
int numberStrong() const
Get the maximum number of candidates to be evaluated for strong branching.
void setCutAndHeuristicOptions(CbcModel &model)
void moveToModel(CbcModel *baseModel, int mode)
Move/copy information from one model to another -1 - initialization 0 - from base model 1 - to base m...
int maximumCutPassesAtRoot_
Maximum number of cut passes at root.
OsiSolverInterface * referenceSolver_
A copy of the solver, taken at constructor or by saveReferenceSolver.
int numberNodes2_
Cumulative number of nodes for statistics.
int maximumDepth_
Current limit on search tree depth.
int numberSavedSolutions() const
Number of saved solutions (including best)
void incrementSubTreeStopped()
Says a sub tree was stopped.
int threadMode_
thread mode always use numberThreads for branching 1 set then deterministic 2 set then use numberThre...
CbcCutModifier * cutModifier_
Cut modifier function.
int getMaximumCutPassesAtRoot() const
Get the maximum number of cut passes at root node.
void zapGlobalCuts()
Get rid of global cuts.
double getSolverObjValue() const
Get solver objective function value (as minimization)
void gutsOfCopy(const CbcModel &rhs, int mode=0)
Most of copy constructor mode - 0 copy but don't delete before 1 copy and delete before 2 copy and de...
void setInfoInChild(int type, CbcThread *info)
Set information in a child -3 pass pointer to child thread info -2 just stop -1 delete simple child s...
bool isInitialSolveAbandoned() const
Are there numerical difficulties (for initialSolve) ?
int fastNodeDepth() const
Get depth for fast nodes.
CbcEventHandler::CbcAction dealWithEventHandler(CbcEventHandler::CbcEvent event, double objValue, const double *solution)
Deals with event handler and solution.
void branchAndBound(int doStatistics=0)
Invoke the branch & cut algorithm.
CbcBaseModel * master_
Thread stuff for master.
CbcEvent
Events known to cbc.
const double * cbcReducedCost_
Get a pointer to array[getNumCols()] (for speed) of reduced costs.
Current minimization objective value.
void setBestSolutionBasis(const CoinWarmStartBasis &bestSolutionBasis)
Warm start object produced by heuristic or strong branching.
void synchronizeHandlers(int makeDefault)
Makes all handlers same.
int numberCutGenerators() const
Get the number of cut generators.
void setNumberPenalties(int number)
Set the number of variables for which to compute penalties in dynamic strong branching.
int numberNodes_
Cumulative number of nodes.
int numberFixedAtRoot_
Number of fixed by analyze at root.
void setMinimizationObjValue(double value)
Set best objective function value as minimization.
void startSplitModel(int numberIterations)
Start threads.
Using MS heap implementation.
int whenCuts_
At which depths to do cuts.
bool isInitialSolveProvenDualInfeasible() const
Is dual infeasiblity proven (for initialSolve) ?
int numberFathoms_
Number of times fast lp entered.
int continuousInfeasibilities_
Number of infeasibilities at continuous.
Stop doing heuristics when the gap between the objective value of the best known solution and the bes...
void setLogLevel(int value)
Set log level.
int * originalColumns() const
Original columns as created by integerPresolve or preprocessing.
const char * integerType() const
Whether or not integer.
void setWhenCuts(int value)
Set at which depths to do cuts.
void setNumberBeforeTrust(int number)
Set the number of branches before pseudo costs believed in dynamic strong branching.
int numberIntegers_
Number of integers in problem.
Class to deal with symmetry.
int problemType_
Problem type as set by user or found by analysis.
Base class for Cbc event handling.
int strongInfo_[7]
0 - number times strong branching done, 1 - number fixed, 2 - number infeasible Second group of three...
OsiObject * modifiableObject(int which) const
Get the specified object.
const int * hotstartPriorities() const
Get the hotstart priorities.
int getContinuousInfeasibilities() const
Number of infeasibilities at continuous.
const double * getColSolution() const
Get pointer to array[getNumCols()] of primal solution vector.
int phase() const
Current phase (so heuristics etc etc can find out).
void setHotstartSolution(const double *solution, const int *priorities=NULL)
Pass in target solution and optional priorities.
bool allDynamic() const
Says whether all dynamic integers.
int addCuts(CbcNode *node, CoinWarmStartBasis *&lastws)
Determine and install the active cuts that need to be added for the current subproblem.
void deleteNode(CbcNode *node)
Delete a node and possibly null out currentNode_.
int numberStrongIterations() const
Get the number of iterations done in strong branching.
Just a marker, so that a static sized array can store parameters.
int getNodeCount2() const
Get how many Nodes it took to solve the problem.
double getCurrentMinimizationObjValue() const
Get current minimization objective function value.
void setMaximumSavedSolutions(int value)
Set maximum number of extra saved solutions.
double sumChangeObjective1_
Sum of Changes to objective by first solve.
void setUseElapsedTime(bool yesNo)
Set time method.
int numberPenalties() const
get the number of variables for which to compute penalties in dynamic strong branching.
int numberHeuristicSolutions_
Number of heuristic solutions.
int parallelMode() const
Return -2 if deterministic threaded and main thread -1 if deterministic threaded and serial thread 0 ...
bool isBinary(int colIndex) const
Return true if variable is binary.
int stopNumberIterations_
For threads - stop after this many "iterations".
void gutsOfDestructor2()
Clears out enough to reset CbcModel as if no branch and bound done.
double bestObjective_
Best objective.
const double * getReducedCost() const
Get a pointer to array[getNumCols()] of reduced costs.
void setBestObjectiveValue(double objectiveValue)
Just update objectiveValue.
void redoWalkBack()
Redo walkback arrays.
int stateOfSearch() const
State of search 0 - no solution 1 - only heuristic solutions 2 - branched to a solution 3 - no soluti...
CbcHeuristic * lastHeuristic() const
Pointer to heuristic solver which found last solution (or NULL)
int searchStrategy_
Strategy worked out - mainly at root node.
int numberBeforeTrust_
The number of branches before pseudo costs believed in dynamic strong branching.
void setStateOfSearch(int state)
void setNodeComparison(CbcCompareBase *compare)
Stop doing heuristics when the gap between the objective value of the best known solution and the bes...
int chooseBranch(CbcNode *&newNode, int numberPassesLeft, CbcNode *oldNode, OsiCuts &cuts, bool &resolved, CoinWarmStartBasis *lastws, const double *lowerBefore, const double *upperBefore, OsiSolverBranch *&branches)
Encapsulates choosing a variable - anyAction -2, infeasible (-1 round again), 0 done.
void synchronizeModel()
Ensure attached objects point to this model.
int resolve(CbcNodeInfo *parent, int whereFrom, double *saveSolution=NULL, double *saveLower=NULL, double *saveUpper=NULL)
Reoptimise an LP relaxation.
void setBranchingMethod(CbcBranchDecision &method)
Set the branching method.
double * analyzeResults_
Arrays with analysis results.
int printFrequency() const
Get the print frequency.
int moreSpecialOptions2() const
Get more special options2.
The amount by which to tighten the objective function cutoff when a new solution is discovered...
bool isIntegerNonBinary(int colIndex) const
Return true if variable is general integer.
const double * cbcColSolution_
Pointer to array[getNumCols()] (for speed) of primal solution vector.
virtual CbcBranchDecision * clone() const =0
Clone.
void setProblemType(int number)
Problem type as set by user or found by analysis.
void saveBestSolution(const double *solution, double objectiveValue)
Save a solution to best and move current to saved.
void clearNumberGlobalViolations()
void setCutoff(double value)
Set cutoff bound on the objective function.
bool isProvenOptimal() const
Is optimality proven?
int printFrequency_
Print frequency.
double continuousObjective_
Value of objective at continuous (Well actually after initial round of cuts)
bool isProvenDualInfeasible() const
Was continuous solution unbounded.
int getStopNumberIterations() const
Get number of "iterations" to stop after.
void passInPriorities(const int *priorities, bool ifNotSimpleIntegers)
Pass in branching priorities.
CoinWarmStartBasis bestSolutionBasis_
Warm start object produced by heuristic or strong branching.
int howOftenGlobalScan_
How often to scan global cuts.
OsiRowCut augmented with bookkeeping.
CbcCountRowCut ** addedCuts() const
Return the list of cuts initially collected for this subproblem.
int numberIntegers() const
Number of integers in problem.
int moreSpecialOptions() const
Get more special options.
int callCbc1(const char *input2, CbcModel &babSolver, int(CbcModel *currentSolver, int whereFrom))
bool keepNamesPreproc
keepNamesPreproc if variables names will be preserved in the pre-processed problem (usefull in callba...
double getAllowableGap() const
Get the allowable gap between the best known solution and the best possible solution.
bool tightenVubs(int type, bool allowMultipleBinary=false, double useCutoff=1.0e50)
For variables involved in VUB constraints, see if we can tighten bounds by solving lp's...
int maximumDepthActual_
Maximum depth reached.
void setNumberObjects(int number)
Set the number of objects.
int numberRowsAtContinuous_
Number of rows at continuous.
CoinWarmStart * emptyWarmStart_
Pointer to an empty warm start object.
void previousBounds(CbcNode *node, CbcNodeInfo *where, int iColumn, double &lower, double &upper, int force)
Returns bounds just before where - initially original bounds.
void zeroExtra()
Zero extra.
CbcModel()
Default Constructor.
CbcBranchDecision * branchingMethod_
Variable selection function.
bool isAbandoned() const
Are there a numerical difficulties?
double getAllowableFractionGap() const
Get the fraction allowable gap between the best known solution and the best possible solution...
Optimization direction - stored for speed.
bool resolveAfterTakeOffCuts() const
Whether to force a resolve after takeOffCuts.
double getCurrentSeconds() const
Current time since start of branchAndbound.
Information required while the node is live.
int numberFixedNow_
Number fixed by analyze so far.
For gathering statistics.
OsiSolverInterface * referenceSolver() const
A copy of the solver, taken at constructor or by saveReferenceSolver.
double savedSolutionObjective(int which) const
Return a saved solution objective (0==best) - COIN_DBL_MAX if off end.
double getMaximumSeconds() const
Get the maximum number of seconds desired.
int numberObjects() const
Get the number of objects.
void setSolutionCount(int value)
Set number of solutions (so heuristics will be different)
const double * cbcRowActivity_
Pointer to array[getNumRows()] (for speed) of row activity levels.
const double * hotstartSolution() const
Get the hotstart solution.
bool isInitialSolveProvenPrimalInfeasible() const
Is primal infeasiblity proven (for initialSolve) ?
CbcCompareBase * nodeComparison() const
int numberStoppedSubTrees_
Number of times any subtree stopped on nodes, time etc.
OsiObject ** objects() const
Get the array of objects.
int maximumRows() const
Maximum number of rows.
int continuousPriority_
Anything with priority >= this can be treated as continuous.
int numberCutGenerators_
Number of cut generators.
int currentPassNumber_
Current cut pass number.
CoinThreadRandom * randomNumberGenerator()
Thread specific random number generator.
bool maximumSecondsReached() const
Return true if maximum time reached.
int numberObjects_
Total number of objects.
void setObjSense(double s)
Set objective function sense (1 for min (default), -1 for max,)
double dblParam_[CbcLastDblParam]
Array for double parameters.
void CbcMain0(CbcModel &babSolver)
The maximum number of solutions before terminating.
CbcFeasibilityBase * problemFeasibility_
User feasibility function (see CbcFeasibleBase.hpp)
int maximumStatistics_
Maximum number of statistics.
int maximumSavedSolutions_
Maximum number of saved solutions.
OsiSolverInterface * continuousSolver_
A copy of the solver, taken at the continuous (root) node.
CoinMessages messages_
Cbc messages.
CbcRowCuts globalCuts_
Global cuts.
int intParam_[CbcLastIntParam]
Array for integer parameters.
bool doCutsNow(int allowForTopOfTree) const
Return true if we want to do cuts If allowForTopOfTree zero then just does on multiples of depth if 1...
const double * getCbcRowUpper() const
Get pointer to array[getNumRows()] (for speed) of row upper bounds.
bool defaultHandler_
Flag to say if handler_ is the default handler.
void setMoreSpecialOptions2(int value)
Set more more special options 0 bit (1) - find switching variables 1 bit (2) - using fake objective u...
void setStrategy(CbcStrategy *strategy)
Set the strategy. assigns.
int searchStrategy() const
Strategy worked out - mainly at root node for use by CbcNode.
CoinWarmStartBasis * getEmptyBasis(int ns=0, int na=0) const
Return an empty basis object of the specified size.
void incrementIterationCount(int value)
Increment how many iterations it took to solve the problem.
const OsiBabSolver * solverCharacteristics() const
Get solver characteristics.
CBC_Message
This deals with Cbc messages (as against Clp messages etc).
Smallest non-zero change on a branch.
CglStored * storedRowCuts() const
Get stored row cuts for donor/recipient CbcModel.
int maximumNumberCuts_
Maximum number of cuts.
void setMaximumCutPassesAtRoot(int value)
Set the maximum number of cut passes at root node (default 20) Minimum drop can also be used for fine...
void checkModel()
Check original model before it gets messed up.
int doOneNode(CbcModel *baseModel, CbcNode *&node, CbcNode *&newNode)
Do one node - broken out for clarity? also for parallel (when baseModel!=this) Returns 1 if solution ...
double sumChangeObjective() const
Sum of Changes to objective by first solve.
void setObjValue(double value)
Set best objective function value.
const double * getRightHandSide() const
Get pointer to array[getNumRows()] of rows right-hand sides.
The maximum number of seconds before terminating.
CoinMessages & messages()
Return messages.
CbcEventHandler * getEventHandler() const
Retrieve a pointer to the event handler.
void initialSolve()
Solve the initial LP relaxation.
bool ownObjects_
Now we may not own objects - just point to solver's objects.
int maximumCutPasses_
Maximum number of cut passes.
double getObjSense() const
Get objective function sense (1 for min (default), -1 for max)
CbcRowCuts * globalCuts()
Global cuts.
CoinBigIndex getNumElements() const
Get number of nonzero elements.
CbcRowCuts * globalConflictCuts_
Global conflict cuts.
bool setMaximumNodes(int value)
Set the maximum node limit .
The time at start of model.
int status() const
Final status of problem Some of these can be found out by is......
const char * getRowSense() const
Get pointer to array[getNumRows()] of row constraint senses.
double * bestSolution() const
The best solution to the integer programming problem.
const double * cbcRowUpper_
Pointer to array[getNumRows()] (for speed) of row upper bounds.
void addObjects(int numberObjects, OsiObject **objects)
Add in object information.
CglStored * storedRowCuts_
Stored row cuts for donor/recipient CbcModel.
void incrementExtra(int nodes, int iterations, int fathoms=1)
int splitModel(int numberModels, CbcModel **model, int numberNodes)
Split up nodes.
const int * whichGenerator() const
Which cut generator generated this cut.
int numberIterations_
Cumulative number of iterations.
double * continuousSolution_
Holds solution at continuous (after cuts)
void sayEventHappened()
Tell model to stop on event.
Abstract cut modifier base class.
double ** savedSolutions_
Arrays holding other solutions.
Information required to recreate the subproblem at this node.
void setBestSolution(CBC_Message how, double &objectiveValue, const double *solution, int fixVariables=0)
Record a new incumbent solution and update objectiveValue.
int numberAnalyzeIterations_
Number of analyze iterations to do.
int strongStrategy() const
Stong branching strategy.
int secondaryStatus_
Secondary status of problem -1 unset (status_ will also be -1) 0 search completed with solution 1 lin...
void setParentModel(CbcModel &parentModel)
Set the parent model.
int * hotstartPriorities_
Hotstart priorities.
double originalContinuousObjective_
Value of objective before root node cuts added.
int getNodeCount() const
Get how many Nodes it took to solve the problem (including those in complete fathoming B&B inside CLP...
void zapIntegerInformation(bool leaveObjects=true)
Zap integer information in problem (may leave object info)
CglPreProcess * preProcess_
preProcess used before branch and bound (optional)
const CoinPackedMatrix * getMatrixByCol() const
Get pointer to column-wise copy of matrix.
int getSolutionCount() const
Get number of solutions.
void setPenaltyScaleFactor(double value)
Set scale factor to make penalties match strong.
int numberGlobalViolations() const
Number of times global cuts violated.
OsiSolverInterface * continuousSolver() const
Returns solver with continuous state.
Information required to recreate the subproblem at this node.
void setSecondaryStatus(int value)
void fillPseudoCosts(double *downCosts, double *upCosts, int *priority=NULL, int *numberDown=NULL, int *numberUp=NULL, int *numberDownInfeasible=NULL, int *numberUpInfeasible=NULL) const
Return pseudo costs If not all integers or not pseudo costs - returns all zero Length of arrays are n...
void setMaximumNumberIterations(int value)
Set maximum number of iterations (designed to be used in heuristics)
CbcModel * subTreeModel_
A pointer to model to be used for subtrees.
CoinWarmStartBasis workingBasis_
Work basis for temporary use.
CbcHeuristic * heuristic(int i) const
Get the specified heuristic.
void * appData_
Pointer to user-defined data structure.
void doHeuristicsAtRoot(int deleteHeuristicsAfterwards=0)
Do heuristics at root.
int getNumRows() const
Get number of rows.
void setContinuousObjective(double value)
double rootObjectiveAfterCuts() const
Value of objective after root node cuts added.
void analyzeObjective()
Analyze problem to find a minimum change in the objective function.
void setProblemStatus(int value)
bool stoppedOnGap_
Whether stopping on gap.
bool isLocked() const
From here to end of section - code in CbcThread.cpp until class changed Returns true if locked...
const int * strongInfo() const
Return strong info.
CbcAction
Action codes returned by the event handler.
Largest non-zero change on a branch.
const double * getColLower() const
Get pointer to array[getNumCols()] of column lower bounds.
const double * getCbcRowPrice() const
Get pointer to array[getNumRows()] (for speed) of dual prices.
static bool haveMultiThreadSupport()
Indicates whether Cbc library has been compiled with multithreading support.
int CbcMain1(int argc, const char *argv[], CbcModel &babSolver)
void createContinuousSolver()
Create solver with continuous state.
int getRandomSeed() const
Get random seed.
void setTestSolution(const double *solution)
int whenCuts() const
Get at which depths to do cuts.
int getPreferredWay() const
Get the preferred way to branch (default 0)
OsiRowCut * nextRowCut_
A pointer to a row cut which will be added instead of normal branching.
int getIntParam(CbcIntParam key) const
Get an integer parameter.
int phase_
Current phase (so heuristics etc etc can find out).
CbcModel * heuristicModel_
A pointer to model from CbcHeuristic.
double getMinimizationObjValue() const
Get best objective function value as minimization.
void synchronizeNumberBeforeTrust(int type=0)
Set numberBeforeTrust in all objects.
OsiBabSolver * solverCharacteristics_
For advanced applications you may wish to modify the behavior of Cbc e.g.
int numberHeuristics() const
Get the number of heuristics.
void setNumberHeuristics(int value)
Set the number of heuristics.
Small non-zero change on a branch to be used as guess.
bool setAllowableGap(double value)
Set the allowable gap between the best known solution and the best possible solution.
const double * getObjCoefficients() const
Get pointer to array[getNumCols()] of objective function coefficients.
const int * integerVariable() const
int getCurrentPassNumber() const
Get current cut pass number in this round of cuts.
CbcCutGenerator * virginCutGenerator(int i) const
Get the specified cut generator before any changes.
void setMIPStart(const std::vector< std::pair< std::string, double > > &mipstart)
void setMaximumCutPasses(int value)
Set the maximum number of cut passes at other nodes (default 10) Minimum drop can also be used for fi...
CbcModel * parentModel() const
Get the current parent model.
double getHeuristicFractionGap() const
Get the fraction heuristic gap between the best known solution and the best possible solution...
void setMinimumDrop(double value)
Set the minimum drop to continue cuts.
int * usedInSolution_
Array marked whenever a solution is found if non-zero.
const double * getRowLower() const
Get pointer to array[getNumRows()] of row lower bounds.
void passInMessageHandler(CoinMessageHandler *handler)
Pass in Message handler (not deleted at end)
int * usedInSolution() const
Array marked whenever a solution is found if non-zero.
int presolve_
Presolve for CbcTreeLocal.
CbcThread * masterThread_
Pointer to masterthread.
int typePresolve() const
Whether to automatically do presolve before branch and bound (subTrees).
const double * savedSolution(int which) const
Return a saved solution (0==best) - NULL if off end.
void addUpdateInformation(const CbcObjectUpdateData &data)
Adds an update information object.
void resetModel()
Clears out enough to reset CbcModel cutoff etc.
double getBestPossibleObjValue() const
Get best possible objective function value.
void goToDantzig(int numberNodes, ClpDualRowPivot *&savePivotMethod)
Go to dantzig pivot selection if easy problem (clp only)
int getThreadMode() const
Get thread mode.
const double * getRowRange() const
Get pointer to array[getNumRows()] of row ranges.
void addSOSEtcToSolver()
Add SOS info to solver - Overwrites SOS information in solver with information in CbcModel...
const OsiSolverInterface * postProcessedSolver(int solutionType=1)
Returns postProcessed solution in solver(called from event handler) Normally used for integer solutio...
CbcCutGenerator ** virginGenerator_
void getIntegerInformation(const OsiObject *object, double &originalLower, double &originalUpper)
So we can use osiObject or CbcObject during transition.
void setTemporaryPointer(void *pointer)
Set useful temporary pointer.
bool setIntParam(CbcIntParam key, int value)
Set an integer parameter.
void setMultipleRootTries(int value)
Set multiple root tries.
bool normalSolver() const
Says if normal solver i.e. has well defined CoinPackedMatrix.
void setObjectiveValue(CbcNode *thisNode, const CbcNode *parentNode) const
Set objective value in a node.
std::vector< std::pair< std::string, double > > mipStart_
MIPstart values values for integer variables which will be converted to a complete integer initial fe...
int numberOldActiveCuts_
Number of old active cuts.
void AddIntegers()
Add additional integers.
CglPreProcess * preProcess() const
Returns CglPreProcess used before branch and bound.
bool solveWithCuts(OsiCuts &cuts, int numberTries, CbcNode *node)
Evaluate a subproblem using cutting planes and heuristics.
bool ownObjects() const
Now we may not own objects - just point to solver's objects.
void setContinuousInfeasibilities(int value)
CbcFeasibilityBase * problemFeasibility() const
int reducedCostFix()
Perform reduced cost fixing.
const double * testSolution_
For testing infeasibilities - will point to currentSolution_ or solver–>getColSolution() ...
bool setMaximumSeconds(double value)
Set the maximum number of seconds desired.
CbcBaseModel * master() const
Thread stuff for master.
Interface between Cbc and Cut Generation Library.
void deleteSavedSolution(int which)
Delete a saved solution and move others up.
double getMinimumDrop() const
Get the minimum drop to continue cuts.
const CbcFullNodeInfo * topOfTree() const
Pointer to top of tree.
void setTypePresolve(int value)
int getNumberThreads() const
Get number of threads.
void deleteObjects(bool findIntegers=true)
Delete all object information (and just back to integers if true)
int secondaryStatus() const
Secondary status of problem -1 unset (status_ will also be -1) 0 search completed with solution 1 lin...
bool setCutoffIncrement(double value)
Set the CbcModel::CbcCutoffIncrement desired.
int numberPenalties_
The number of variables for which to compute penalties in dynamic strong branching.
bool setHeuristicGap(double value)
Set the heuristic gap between the best known solution and the best possible solution.
int numberStoppedSubTrees() const
Returns number of times any subtree stopped on nodes, time etc.
bool isInteger(int colIndex) const
Return true if column is integer.
CbcModel * findCliques(bool makeEquality, int atLeastThisMany, int lessThanThis, int defaultValue=1000)
Identify cliques and construct corresponding objects.
The maximum amount the value of an integer variable can vary from integer and still be considered fea...
void addCutGenerator(CglCutGenerator *generator, int howOften=1, const char *name=NULL, bool normal=true, bool atSolution=false, bool infeasible=false, int howOftenInSub=-100, int whatDepth=-1, int whatDepthInSub=-1)
Add one generator - up to user to delete generators.
Stop when the gap between the objective value of the best known solution and the best bound on the ob...
void addHeuristic(CbcHeuristic *generator, const char *name=NULL, int before=-1)
Add one heuristic - up to user to delete.
void assignSolver(OsiSolverInterface *&solver, bool deleteSolver=true)
Assign a solver to the model (model assumes ownership)
OsiSolverInterface * swapSolver(OsiSolverInterface *solver)
Returns current solver - sets new one.
int numberExtraIterations_
Number of extra iterations in fast lp.
void setPreferredWay(int value)
Set global preferred way to branch -1 down, +1 up, 0 no preference.
int * originalColumns_
Original columns as created by integerPresolve or preprocessing.
CoinThreadRandom randomNumberGenerator_
Thread specific random number generator.
void gutsOfDestructor()
Clears out as much as possible (except solver)
int numberThreads_
Parallel 0 - off 1 - testing 2-99 threads other special meanings.
Simple Branch and bound class.
void saveExtraSolution(const double *solution, double objectiveValue)
Save a solution to saved list.
bool feasibleSolution(int &numberIntegerInfeasibilities, int &numberObjectInfeasibilities) const
Test the current solution for feasiblility.
void * temporaryPointer() const
Get useful temporary pointer.
void findIntegers(bool startAgain, int type=0)
Identify integer variables and create corresponding objects.
int randomSeed_
Random seed.
void setStopNumberIterations(int value)
Set number of "iterations" to stop after.
void setCutModifier(CbcCutModifier *modifier)
Set the cut modifier method.
void setSpecialOptions(int value)
Set special options 0 bit (1) - check if cuts valid (if on debugger list) 1 bit (2) - use current bas...
void saveModel(OsiSolverInterface *saveSolver, double *checkCutoffForRestart, bool *feasible)
Save copy of the model.
int makeGlobalCut(const OsiRowCut *cut)
Make given cut into a global cut.
int moreSpecialOptions_
More special options at present bottom 6 bits used for shadow price mode 1024 for experimental hotsta...
int currentNumberCuts_
Number of entries in addedCuts_.
void setNextRowCut(const OsiRowCut &cut)
Copy and set a pointer to a row cut which will be added instead of normal branching.
CbcCutModifier * cutModifier() const
Get the current cut modifier method.
bool useElapsedTime() const
Get time method.
void originalModel(CbcModel *presolvedModel, bool weak)
Put back information into the original model after integer presolve.
OsiSolverInterface * solver() const
Returns solver - has current state.
bool isSecondsLimitReached() const
Time limit reached?
int howOftenGlobalScan() const
Get how often to scan global cuts.
int numberGlobalViolations_
Number of times global cuts violated.
void pseudoShadow(int type)
Fill in useful estimates.
int numberHeuristics_
Number of heuristics.
CbcTree * tree() const
Tree method e.g. heap (which may be overridden by inheritance)
void passInSubTreeModel(CbcModel &model)
For passing in an CbcModel to do a sub Tree (with derived tree handlers).
virtual ~CbcModel()
Destructor.
int maximumSavedSolutions() const
Maximum number of extra saved solutions.
A class to encapsulate thread stuff.
double * hotstartSolution_
Hotstart solution.
void mergeModels(int numberModel, CbcModel **model, int numberNodes)
Merge models.
CbcThread * masterThread() const
Get pointer to masterthread.
void adjustHeuristics()
Adjust heuristics based on model.
bool isContinuousUnbounded() const
Was continuous solution unbounded.
int maximumWhich_
Maximum number of cuts (for whichGenerator_)
double bestPossibleObjective_
Best possible objective.
double getHeuristicGap() const
Get the heuristic gap between the best known solution and the best possible solution.
void moveInfo(const CbcModel &rhs)
Move status, nodes etc etc across.
CbcCutGenerator * cutGenerator(int i) const
Get the specified cut generator.
CbcStrategy * strategy() const
Get the current strategy.
int currentDepth() const
Current depth.