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;
226 bool solveWithCuts(OsiCuts &cuts,
int numberTries,
CbcNode *node);
234 int serialCuts(OsiCuts &cuts,
CbcNode *node, OsiCuts &slackCuts,
int lastNumberCuts);
250 int &numberNodesOutput,
int &
status);
252 void resizeWhichGenerator(
int numberNow,
int numberAfter);
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);
376 return whichGenerator_;
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);
495 return numberObjects_;
500 numberObjects_ = number;
510 const inline OsiObject *
object(
int which)
const 512 return object_[which];
517 return object_[which];
556 #ifdef SWITCH_VARIABLES 560 int fixAssociated(OsiSolverInterface *solver,
int cleanBasis);
562 int checkAssociated(
const OsiSolverInterface *solver,
563 const double *solution,
int printLevel);
581 intParam_[key] = value;
587 dblParam_[key] = value;
593 return intParam_[key];
598 return dblParam_[key];
809 minimumDrop_ = value;
821 maximumCutPassesAtRoot_ = value;
826 return maximumCutPassesAtRoot_;
833 maximumCutPasses_ = value;
838 return maximumCutPasses_;
844 return currentPassNumber_;
850 currentPassNumber_ = value;
864 return numberStrong_;
870 preferredWay_ = value;
875 return preferredWay_;
892 bool doCutsNow(
int allowForTopOfTree)
const;
904 return numberBeforeTrust_;
916 return numberPenalties_;
926 numberAnalyzeIterations_ = number;
930 return numberAnalyzeIterations_;
936 return penaltyScaleFactor_;
950 problemType_ = number;
959 return currentDepth_;
967 return howOftenGlobalScan_;
972 return originalColumns_;
976 int numberGood = COIN_INT_MAX);
978 OsiRowCut *
conflictCut(
const OsiSolverInterface *solver,
bool &localCuts);
989 printFrequency_ = number;
994 return printFrequency_;
1020 return numberIterations_;
1025 numberIterations_ += value;
1030 return numberNodes_;
1035 numberNodes_ += value;
1040 return numberExtraNodes_;
1045 return numberFathoms_;
1078 return secondaryStatus_;
1082 secondaryStatus_ = value;
1111 return numberRowsAtContinuous_;
1117 return solver_->getNumCols();
1123 return solver_->getNumRows();
1129 return solver_->getNumElements();
1135 return numberIntegers_;
1140 return integerVariable_;
1145 assert(integerInfo_);
1146 assert(integerInfo_[i] == 0 || integerInfo_[i] == 1);
1147 return integerInfo_[i];
1152 return integerInfo_;
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();
1285 return cbcColLower_;
1290 return cbcColUpper_;
1295 return cbcRowLower_;
1300 return cbcRowUpper_;
1305 return cbcColSolution_;
1310 return cbcRowPrice_;
1315 return cbcReducedCost_;
1320 return cbcRowActivity_;
1329 return continuousSolution_;
1337 return usedInSolution_;
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;
1377 return currentSolution_;
1384 return testSolution_;
1388 testSolution_ = solution;
1396 return solver_->getColSolution();
1402 return solver_->getRowPrice();
1408 return solver_->getReducedCost();
1414 return solver_->getRowActivity();
1431 return bestObjective_;
1436 bestObjective_ = value;
1442 return bestObjective_ * solver_->getObjSense();
1453 bestObjective_ = value * solver_->getObjSense();
1458 return solver_->getObjValue() * solver_->getObjSense();
1469 return bestSolution_;
1478 double objectiveValue,
bool check =
false);
1483 return numberSolutions_;
1489 numberSolutions_ = value;
1496 return maximumSavedSolutions_;
1523 return numberHeuristicSolutions_;
1528 numberHeuristicSolutions_ = value;
1535 solver_->setObjSense(s);
1541 return originalContinuousObjective_;
1545 originalContinuousObjective_ = value;
1550 return continuousInfeasibilities_;
1554 continuousInfeasibilities_ = value;
1559 return continuousObjective_;
1564 return sumChangeObjective1_;
1570 return numberGlobalViolations_;
1574 numberGlobalViolations_ = 0;
1579 return resolveAfterTakeOffCuts_;
1583 resolveAfterTakeOffCuts_ = yesNo;
1588 return maximumRows_;
1593 return workingBasis_;
1598 return stopNumberIterations_;
1603 stopNumberIterations_ = value;
1608 return heuristicModel_;
1613 heuristicModel_ = model;
1622 return nodeCompare_;
1633 return problemFeasibility_;
1660 return numberStoppedSubTrees_;
1665 numberStoppedSubTrees_++;
1692 return branchingMethod_;
1697 delete branchingMethod_;
1698 branchingMethod_ = method->
clone();
1706 delete branchingMethod_;
1707 branchingMethod_ = method.
clone();
1712 return cutModifier_;
1734 return stateOfSearch_;
1738 stateOfSearch_ = state;
1743 return searchStrategy_;
1748 searchStrategy_ = value;
1753 return strongStrategy_;
1758 strongStrategy_ = value;
1764 return numberCutGenerators_;
1774 return generator_[i];
1779 return virginGenerator_[i];
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);
1816 return parentModel_;
1836 return heuristic_[i];
1841 return numberHeuristics_;
1846 numberHeuristics_ = value;
1851 return lastHeuristic_;
1856 lastHeuristic_ = last;
1882 return object_[sequence]->priority();
1894 return (eventHandler_);
1928 return solverCharacteristics_;
1939 void newLanguage(CoinMessages::Language language);
1964 return handler_->logLevel();
1973 defaultHandler_ = yesNo;
1978 return defaultHandler_;
2016 specialOptions_ = value;
2021 return specialOptions_;
2026 randomSeed_ = value;
2036 multipleRootTries_ = value;
2041 return multipleRootTries_;
2046 eventHappened_ =
true;
2051 return (specialOptions_ & 16) == 0;
2059 return (specialOptions_ & 1048576) != 0;
2086 moreSpecialOptions_ = value;
2091 return moreSpecialOptions_;
2110 moreSpecialOptions2_ = value;
2115 return moreSpecialOptions2_;
2120 cutoffRowNumber_ = (yesNo) ? -2 : -1;
2126 moreSpecialOptions_ |= 131072;
2128 moreSpecialOptions_ &= ~131072;
2133 return (moreSpecialOptions_ & 131072) != 0;
2138 return temporaryPointer_;
2143 temporaryPointer_ = pointer;
2146 void goToDantzig(
int numberNodes, ClpDualRowPivot *&savePivotMethod);
2163 CbcModel(
const OsiSolverInterface &);
2173 void assignSolver(OsiSolverInterface *&solver,
bool deleteSolver =
true);
2188 ownership_ = ourSolver ? (ownership_ | 0x80000000) : (ownership_ & (~0x80000000));
2198 return ((ownership_ & 0x80000000) != 0);
2222 inline OsiSolverInterface *
swapSolver(OsiSolverInterface *solver)
2224 OsiSolverInterface *returnSolver = solver_;
2226 return returnSolver;
2232 return continuousSolver_;
2238 continuousSolver_ = solver_->clone();
2243 delete continuousSolver_;
2244 continuousSolver_ = NULL;
2250 return referenceSolver_;
2288 return masterThread_;
2298 return numberThreads_;
2303 numberThreads_ = value;
2321 threadMode_ = value;
2331 if (!numberThreads_) {
2332 if ((threadMode_ & 1) == 0)
2338 if ((threadMode_ & 1) == 0)
2398 return numberNodes2_;
2401 void setPointers(
const OsiSolverInterface *solver);
2419 int resolve(OsiSolverInterface *solver);
2421 int resolveClp(OsiClpSolverInterface *solver,
int type);
2429 CbcNode *oldNode, OsiCuts &cuts,
2430 bool &resolved, CoinWarmStartBasis *lastws,
2431 const double *lowerBefore,
const double *upperBefore,
2432 OsiSolverBranch *&branches);
2441 CoinWarmStartBasis *
getEmptyBasis(
int ns = 0,
int na = 0)
const;
2455 bool allowResolve, OsiCuts *saveCuts,
2456 int numberNewCuts = 0,
const OsiRowCut **newCuts = NULL);
2493 double &lower,
double &upper,
int force);
2520 int *numberDown = NULL,
int *numberUp = NULL,
2521 int *numberDownInfeasible = NULL,
2522 int *numberUpInfeasible = NULL)
const;
2534 return hotstartSolution_;
2539 return hotstartPriorities_;
2550 return currentNumberCuts_;
2555 return &globalCuts_;
2567 return currentNode_;
2574 return probingInfo_;
2579 return &randomNumberGenerator_;
2584 numberStrongIterations_ = number;
2589 return numberStrongIterations_;
2594 return maximumNumberIterations_;
2599 maximumNumberIterations_ = value;
2605 return symmetryInfo_;
2613 fastNodeDepth_ = value;
2618 return fastNodeDepth_;
2623 return continuousPriority_;
2628 continuousPriority_ = value;
2632 numberExtraNodes_ += nodes;
2633 numberExtraIterations_ += iterations;
2634 numberFathoms_ += fathoms;
2639 numberExtraNodes_ = 0;
2640 numberExtraIterations_ = 0;
2646 return numberExtraIterations_;
2650 int numberFixed,
bool ifInfeasible);
2665 return storedRowCuts_;
2670 storedRowCuts_ = cuts;
2675 return ((ownership_ & 0x40000000) != 0);
2689 bestSolutionBasis_ = bestSolutionBasis;
2695 void setMIPStart(
const std::vector< std::pair< std::string, double > > &mipstart)
2697 this->mipStart_ = mipstart;
2704 this->keepNamesPreproc = _keep;
2709 return keepNamesPreproc;
2714 void setMIPStart(
int count,
const char **colNames,
const double colValues[]);
2719 return this->mipStart_;
2729 OsiSolverInterface *solver_;
2736 unsigned int ownership_;
2739 OsiSolverInterface *continuousSolver_;
2742 OsiSolverInterface *referenceSolver_;
2745 CoinMessageHandler *handler_;
2752 bool defaultHandler_;
2755 CoinMessages messages_;
2771 mutable CoinWarmStart *emptyWarmStart_;
2774 double bestObjective_;
2776 double bestPossibleObjective_;
2778 double sumChangeObjective1_;
2780 double sumChangeObjective2_;
2783 double *bestSolution_;
2785 double **savedSolutions_;
2791 double *currentSolution_;
2795 mutable const double *testSolution_;
2799 std::vector< std::pair< std::string, double > > mipStart_;
2805 bool keepNamesPreproc;
2813 CoinWarmStartBasis bestSolutionBasis_;
2820 double minimumDrop_;
2822 int numberSolutions_;
2824 int numberSavedSolutions_;
2826 int maximumSavedSolutions_;
2837 double *hotstartSolution_;
2839 int *hotstartPriorities_;
2841 int numberHeuristicSolutions_;
2849 int numberIterations_;
2864 int secondaryStatus_;
2866 int numberIntegers_;
2868 int numberRowsAtContinuous_;
2874 int cutoffRowNumber_;
2876 int maximumNumberCuts_;
2888 int currentNumberCuts_;
2902 CglPreProcess *preProcess_;
2904 const OsiRowCut **lastCut_;
2906 int lastNumberCuts2_;
2908 int *lastNumberCuts_;
2922 OsiRowCut *nextRowCut_;
2928 int *integerVariable_;
2932 double *continuousSolution_;
2934 int *usedInSolution_;
2962 int specialOptions_;
2977 int moreSpecialOptions_;
2991 int moreSpecialOptions2_;
3005 int numberStoppedSubTrees_;
3019 const double *cbcColLower_;
3022 const double *cbcColUpper_;
3024 const double *cbcRowLower_;
3026 const double *cbcRowUpper_;
3028 const double *cbcColSolution_;
3030 const double *cbcRowPrice_;
3032 const double *cbcReducedCost_;
3034 const double *cbcRowActivity_;
3048 int numberBeforeTrust_;
3052 int numberPenalties_;
3054 int stopNumberIterations_;
3057 double penaltyScaleFactor_;
3059 int numberAnalyzeIterations_;
3061 double *analyzeResults_;
3063 void *temporaryPointer_;
3065 int numberInfeasibleNodes_;
3074 int printFrequency_;
3076 int numberCutGenerators_;
3082 int numberHeuristics_;
3091 ClpEventHandler *eventHandler_;
3110 OsiObject **object_;
3115 int *originalColumns_;
3117 int howOftenGlobalScan_;
3120 int numberGlobalViolations_;
3122 int numberExtraIterations_;
3124 int numberExtraNodes_;
3130 double continuousObjective_;
3133 double originalContinuousObjective_;
3135 int continuousInfeasibilities_;
3137 int maximumCutPassesAtRoot_;
3139 int maximumCutPasses_;
3143 int currentPassNumber_;
3151 int multipleRootTries_;
3155 mutable CoinThreadRandom randomNumberGenerator_;
3157 CoinWarmStartBasis workingBasis_;
3159 int *whichGenerator_;
3161 int maximumStatistics_;
3165 int maximumDepthActual_;
3167 double numberDJFixed_;
3169 CglTreeProbingInfo *probingInfo_;
3171 int numberFixedAtRoot_;
3173 int numberFixedNow_;
3177 mutable bool eventHappened_;
3179 int numberLongStrong_;
3181 int numberOldActiveCuts_;
3185 int searchStrategy_;
3197 int strongStrategy_;
3199 int numberStrongIterations_;
3209 OsiBabSolver *solverCharacteristics_;
3211 bool resolveAfterTakeOffCuts_;
3213 int maximumNumberIterations_;
3215 int continuousPriority_;
3217 int numberUpdateItems_;
3219 int maximumNumberUpdateItems_;
3223 CglStored *storedRowCuts_;
3241 int numberGlobalCutsIn_;
3250 double &originalUpper);
3253 class OsiClpSolverInterface;
3257 int callCbc(
const char *input2, OsiClpSolverInterface &solver1);
3258 int callCbc(
const char *input2);
3259 int callCbc(
const std::string input2, OsiClpSolverInterface &solver1);
3260 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.
const OsiObject * object(int which) const
Get the specified object.
void setProblemFeasibility(CbcFeasibilityBase *feasibility)
double getDblParam(CbcDblParam key) const
Get a double parameter.
The objective is assumed to worsen by this amount for each integer infeasibility. ...
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 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.
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.
CbcNodeInfo ** walkback() const
Get pointer to walkback.
void setHowOftenGlobalScan(int number)
Set how often to scan global cuts.
void setLastHeuristic(CbcHeuristic *last)
set last heuristic which found a solution
double getCurrentObjValue() const
Get current objective function value.
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 logLevel() const
Get log level.
CbcBranchDecision * branchingMethod() const
Get the current branching decision method.
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()
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 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.
int CbcMain(int argc, const char *argv[], OsiClpSolverInterface &solver, CbcModel **babSolver)
void setCutoffAsConstraint(bool yesNo)
Set cutoff as constraint.
const double * getCbcColUpper() const
Get pointer to array[getNumCols()] (for speed) of column upper bounds.
CglTreeProbingInfo * probingInfo() const
Get a pointer to probing info.
CbcModel & operator=(const CbcModel &rhs)
Assignment operator.
int numberRowsAtContinuous() const
Number of rows in continuous (root) problem.
The maximum number of nodes before terminating.
void setFastNodeDepth(int value)
Set depth for fast nodes.
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...
void setStrongStrategy(int value)
Set strong branching strategy.
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)
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 .
const CoinPackedMatrix * getMatrixByRow() const
Get pointer to row-wise copy of matrix.
int callCbc(const char *input2, OsiClpSolverInterface &solver1)
Just a marker, so that a static sized array can store parameters.
bool setInfeasibilityWeight(double value)
Set the weight per integer infeasibility .
void reserveCurrentSolution(const double *solution=NULL)
Make sure region there and optionally copy solution.
bool getKeepNamesPreproc() const
bool setIntegerTolerance(double value)
Set the integrality tolerance .
double getInfeasibilityWeight() const
Get the weight per integer infeasibility .
bool isFreeBinary(int colIndex) const
Return true if variable is binary and not fixed at either bound.
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.
Cutoff - stored for speed.
int numberBeforeTrust() const
get the number of branches before pseudo costs believed in dynamic strong branching.
bool integerPresolveThisModel(OsiSolverInterface *originalSolver, bool weak=false)
Do integer presolve, modifying the current model.
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.
int getPrintingMode() const
Get the printing mode.
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.
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.
Sum of non-zero changes on a branch.
double penaltyScaleFactor() const
Get scale factor to make penalties match strong.
bool modelOwnsSolver()
Get ownership of solver.
void setPreProcess(CglPreProcess *preProcess)
Set CglPreProcess used before branch and bound.
void setKeepNamesPreproc(bool _keep)
if original column names will be preserved in preprocessed problem
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.
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...
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.
void convertToDynamic()
If numberBeforeTrust >0 then we are going to use CbcBranchDynamic.
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 getIterationCount() const
Get how many iterations it took to solve the problem.
int cliquePseudoCosts(int doStatistics)
Use cliques for pseudocost information - return nonzero if infeasible.
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.
int getNumberHeuristicSolutions() const
Get number of heuristic solutions.
void setMoreSpecialOptions(int value)
Set more special options at present bottom 6 bits used for shadow price mode 1024 for experimental ho...
bool isContinuous(int colIndex) const
Return true if variable is continuous.
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 numberSavedSolutions() const
Number of saved solutions (including best)
void incrementSubTreeStopped()
Says a sub tree was stopped.
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.
CbcEvent
Events known to cbc.
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.
void setMinimizationObjValue(double value)
Set best objective function value as minimization.
void startSplitModel(int numberIterations)
Start threads.
Using MS heap implementation.
bool isInitialSolveProvenDualInfeasible() const
Is dual infeasiblity proven (for initialSolve) ?
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.
Class to deal with symmetry.
Base class for Cbc event handling.
int callCbc1(const char *input2, CbcModel &babSolver)
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.
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 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.
void gutsOfDestructor2()
Clears out enough to reset CbcModel as if no branch and bound done.
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)
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.
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.
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?
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.
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.
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...
void setNumberObjects(int number)
Set the number of objects.
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.
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.
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 * hotstartSolution() const
Get the hotstart solution.
bool isInitialSolveProvenPrimalInfeasible() const
Is primal infeasiblity proven (for initialSolve) ?
CbcCompareBase * nodeComparison() const
OsiObject ** objects() const
Get the array of objects.
int maximumRows() const
Maximum number of rows.
CoinThreadRandom * randomNumberGenerator()
Thread specific random number generator.
bool maximumSecondsReached() const
Return true if maximum time reached.
void setObjSense(double s)
Set objective function sense (1 for min (default), -1 for max,)
void CbcMain0(CbcModel &babSolver)
The maximum number of solutions before terminating.
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.
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.
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.
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.
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.
void addObjects(int numberObjects, OsiObject **objects)
Add in object information.
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.
void sayEventHappened()
Tell model to stop on event.
Abstract cut modifier base class.
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 strongStrategy() const
Stong branching strategy.
void setParentModel(CbcModel &parentModel)
Set the parent model.
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)
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)
CbcHeuristic * heuristic(int i) const
Get the specified heuristic.
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 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)
int getIntParam(CbcIntParam key) const
Get an integer parameter.
double getMinimizationObjValue() const
Get best objective function value as minimization.
void synchronizeNumberBeforeTrust(int type=0)
Set numberBeforeTrust in all objects.
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.
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 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...
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.
void AddIntegers()
Add additional integers.
CglPreProcess * preProcess() const
Returns CglPreProcess used before branch and bound.
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.
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.
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.
void setPreferredWay(int value)
Set global preferred way to branch -1 down, +1 up, 0 no preference.
void gutsOfDestructor()
Clears out as much as possible (except solver)
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.
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.
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.
void pseudoShadow(int type)
Fill in useful estimates.
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.
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.
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.