CbcModel Class Reference

Simple Branch and bound class. More...

#include <CbcModel.hpp>

Collaboration diagram for CbcModel:

[legend]

List of all members.

Public Types
enum	CbcIntParam {   CbcMaxNumNode = 0, CbcMaxNumSol, CbcFathomDiscipline, CbcPrinting,   CbcLastIntParam }
enum	CbcDblParam {   CbcIntegerTolerance = 0, CbcInfeasibilityWeight, CbcCutoffIncrement, CbcAllowableGap,   CbcAllowableFractionGap, CbcMaximumSeconds, CbcCurrentCutoff, CbcOptimizationDirection,   CbcCurrentObjectiveValue, CbcCurrentMinimizationObjectiveValue, CbcStartSeconds, CbcLastDblParam }
Public Member Functions
Presolve methods
CbcModel *	findCliques (bool makeEquality, int atLeastThisMany, int lessThanThis, int defaultValue=1000)
	Identify cliques and construct corresponding objects.
CbcModel *	integerPresolve (bool weak=false)
	Do integer presolve, creating a new (presolved) model.
bool	integerPresolveThisModel (OsiSolverInterface *originalSolver, bool weak=false)
	Do integer presolve, modifying the current model.
void	originalModel (CbcModel *presolvedModel, bool weak)
	Put back information into the original model after integer presolve.
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.
bool	tightenVubs (int numberVubs, const int *which, double useCutoff=1.0e50)
	For variables involved in VUB constraints, see if we can tighten bounds by solving lp's.
void	analyzeObjective ()
	Analyze problem to find a minimum change in the objective function.
Object manipulation routines
See OsiObject for an explanation of `object' in the context of CbcModel.
int	numberObjects () const
	Get the number of objects.
void	setNumberObjects (int number)
	Set the number of objects.
OsiObject **	objects () const
	Get the array of objects.
const OsiObject *	object (int which) const
	Get the specified object.
OsiObject *	modifiableObject (int which) const
	Get the specified object.
void	deleteObjects (bool findIntegers=true)
	Delete all object information (and just back to integers if true).
void	addObjects (int numberObjects, OsiObject **objects)
	Add in object information.
void	addObjects (int numberObjects, CbcObject **objects)
	Add in object information.
void	synchronizeModel ()
	Ensure attached objects point to this model.
void	findIntegers (bool startAgain, int type=0)
	Identify integer variables and create corresponding objects.
Parameter set/get methods
The set methods return true if the parameter was set to the given value, false if the value of the parameter is out of range. The get methods return the value of the parameter.
bool	setIntParam (CbcIntParam key, int value)
	Set an integer parameter.
bool	setDblParam (CbcDblParam key, double value)
	Set a double parameter.
int	getIntParam (CbcIntParam key) const
	Get an integer parameter.
double	getDblParam (CbcDblParam key) const
	Get a double parameter.
void	setCutoff (double value)
	Set cutoff bound on the objective function.
double	getCutoff () const
	Get the cutoff bound on the objective function - always as minimize.
bool	setMaximumNodes (int value)
	Set the maximum node limit .
int	getMaximumNodes () const
	Get the maximum node limit .
bool	setMaximumSolutions (int value)
	Set the maximum number of solutions desired.
int	getMaximumSolutions () const
	Get the maximum number of solutions desired.
bool	setPrintingMode (int value)
	Set the printing mode.
int	getPrintingMode () const
	Get the printing mode.
bool	setMaximumSeconds (double value)
	Set the maximum number of seconds desired.
double	getMaximumSeconds () const
	Get the maximum number of seconds desired.
double	getCurrentSeconds () const
	Current time since start of branchAndbound.
bool	setIntegerTolerance (double value)
	Set the integrality tolerance .
double	getIntegerTolerance () const
	Get the integrality tolerance .
bool	setInfeasibilityWeight (double value)
	Set the weight per integer infeasibility .
double	getInfeasibilityWeight () const
	Get the weight per integer infeasibility .
bool	setAllowableGap (double value)
	Set the allowable gap between the best known solution and the best possible solution.
double	getAllowableGap () const
	Get the allowable gap between the best known solution and the best possible solution.
bool	setAllowableFractionGap (double value)
	Set the fraction allowable gap between the best known solution and the best possible solution.
double	getAllowableFractionGap () const
	Get the fraction allowable gap between the best known solution and the best possible solution.
bool	setAllowablePercentageGap (double value)
	Set the percentage allowable gap between the best known solution and the best possible solution.
double	getAllowablePercentageGap () const
	Get the percentage allowable gap between the best known solution and the best possible solution.
bool	setCutoffIncrement (double value)
	Set the CbcModel::CbcCutoffIncrement desired.
double	getCutoffIncrement () const
	Get the CbcModel::CbcCutoffIncrement desired.
void	setHotstartSolution (const double *solution, const int *priorities=NULL)
	Pass in target solution and optional priorities.
void	setMinimumDrop (double value)
	Set the minimum drop to continue cuts.
double	getMinimumDrop () const
	Get the minimum drop to continue 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 tuning.
int	getMaximumCutPassesAtRoot () const
	Get the maximum number of cut passes at root node.
void	setMaximumCutPasses (int value)
	Set the maximum number of cut passes at other nodes (default 10) Minimum drop can also be used for fine tuning.
int	getMaximumCutPasses () const
	Get the maximum number of cut passes at other nodes (default 10).
int	getCurrentPassNumber () const
	Get current cut pass number in this round of cuts.
void	setNumberStrong (int number)
	Set the maximum number of candidates to be evaluated for strong branching.
int	numberStrong () const
	Get the maximum number of candidates to be evaluated for strong branching.
void	setPreferredWay (int value)
	Set global preferred way to branch -1 down, +1 up, 0 no preference.
int	getPreferredWay () const
	Get the preferred way to branch (default 0).
void	setSizeMiniTree (int value)
	Set size of mini - tree.
int	sizeMiniTree () const
	Set an integer parameter.
void	setNumberBeforeTrust (int number)
	Set the number of branches before pseudo costs believed in dynamic strong branching.
int	numberBeforeTrust () const
	get the number of branches before pseudo costs believed in dynamic strong branching.
void	setNumberPenalties (int number)
	Set the number of variables for which to compute penalties in dynamic strong branching.
int	numberPenalties () const
	get the number of variables for which to compute penalties in dynamic strong branching.
void	setNumberAnalyzeIterations (int number)
	Number of analyze iterations to do.
int	numberAnalyzeIterations () const
	Set an integer parameter.
double	penaltyScaleFactor () const
	Get scale factor to make penalties match strong.
void	setPenaltyScaleFactor (double value)
	Set scale factor to make penalties match strong.
void	setProblemType (int number)
	Problem type as set by user or found by analysis.
int	problemType () const
	Set an integer parameter.
void	setHowOftenGlobalScan (int number)
	Set how often to scan global cuts.
int	howOftenGlobalScan () const
	Get how often to scan global cuts.
int *	originalColumns () const
	Original columns as created by integerPresolve or preprocessing.
void	setOriginalColumns (const int *originalColumns)
	Set original columns as created by preprocessing.
void	setPrintFrequency (int number)
	Set the print frequency.
int	printFrequency () const
	Get the print frequency.
Methods returning info on how the solution process terminated
bool	isAbandoned () const
	Are there a numerical difficulties?
bool	isProvenOptimal () const
	Is optimality proven?
bool	isProvenInfeasible () const
	Is infeasiblity proven (or none better than cutoff)?
bool	isContinuousUnbounded () const
	Was continuous solution unbounded.
bool	isProvenDualInfeasible () const
	Was continuous solution unbounded.
bool	isNodeLimitReached () const
	Node limit reached?
bool	isSecondsLimitReached () const
	Time limit reached?
bool	isSolutionLimitReached () const
	Solution limit reached?
int	getIterationCount () const
	Get how many iterations it took to solve the problem.
int	getNodeCount () const
	Get how many Nodes it took to solve the problem.
int	status () const
	Final status of problem Some of these can be found out by is.
void	setProblemStatus (int value)
	Are there a numerical difficulties?
int	secondaryStatus () const
	Secondary status of problem -1 unset (status_ will also be -1) 0 search completed with solution 1 linear relaxation not feasible (or worse than cutoff) 2 stopped on gap 3 stopped on nodes 4 stopped on time 5 stopped on user event 6 stopped on solutions 7 linear relaxation unbounded.
void	setSecondaryStatus (int value)
	Are there a numerical difficulties?
bool	isInitialSolveAbandoned () const
	Are there numerical difficulties (for initialSolve) ?
bool	isInitialSolveProvenOptimal () const
	Is optimality proven (for initialSolve) ?
bool	isInitialSolveProvenPrimalInfeasible () const
	Is primal infeasiblity proven (for initialSolve) ?
bool	isInitialSolveProvenDualInfeasible () const
	Is dual infeasiblity proven (for initialSolve) ?
Problem information methods
These methods call the solver's query routines to return information about the problem referred to by the current object. Querying a problem that has no data associated with it result in zeros for the number of rows and columns, and NULL pointers from the methods that return vectors. Const pointers returned from any data-query method are valid as long as the data is unchanged and the solver is not called.
int	numberRowsAtContinuous () const
	Number of rows in continuous (root) problem.
int	getNumCols () const
	Get number of columns.
int	getNumRows () const
	Get number of rows.
CoinBigIndex	getNumElements () const
	Get number of nonzero elements.
int	numberIntegers () const
	Number of integers in problem.
const int *	integerVariable () const
	Number of rows in continuous (root) problem.
char	integerType (int i) const
	Whether or not integer.
const char *	integerType () const
	Whether or not integer.
const double *	getColLower () const
	Get pointer to array[getNumCols()] of column lower bounds.
const double *	getColUpper () const
	Get pointer to array[getNumCols()] of column upper bounds.
const char *	getRowSense () const
	Get pointer to array[getNumRows()] of row constraint senses.
const double *	getRightHandSide () const
	Get pointer to array[getNumRows()] of rows right-hand sides.
const double *	getRowRange () const
	Get pointer to array[getNumRows()] of row ranges.
const double *	getRowLower () const
	Get pointer to array[getNumRows()] of row lower bounds.
const double *	getRowUpper () const
	Get pointer to array[getNumRows()] of row upper bounds.
const double *	getObjCoefficients () const
	Get pointer to array[getNumCols()] of objective function coefficients.
double	getObjSense () const
	Get objective function sense (1 for min (default), -1 for max).
bool	isContinuous (int colIndex) const
	Return true if variable is continuous.
bool	isBinary (int colIndex) const
	Return true if variable is binary.
bool	isInteger (int colIndex) const
	Return true if column is integer.
bool	isIntegerNonBinary (int colIndex) const
	Return true if variable is general integer.
bool	isFreeBinary (int colIndex) const
	Return true if variable is binary and not fixed at either bound.
const CoinPackedMatrix *	getMatrixByRow () const
	Get pointer to row-wise copy of matrix.
const CoinPackedMatrix *	getMatrixByCol () const
	Get pointer to column-wise copy of matrix.
double	getInfinity () const
	Get solver's value for infinity.
const double *	getCbcColLower () const
	Get pointer to array[getNumCols()] (for speed) of column lower bounds.
const double *	getCbcColUpper () const
	Get pointer to array[getNumCols()] (for speed) of column upper bounds.
const double *	getCbcRowLower () const
	Get pointer to array[getNumRows()] (for speed) of row lower bounds.
const double *	getCbcRowUpper () const
	Get pointer to array[getNumRows()] (for speed) of row upper bounds.
const double *	getCbcColSolution () const
	Get pointer to array[getNumCols()] (for speed) of primal solution vector.
const double *	getCbcRowPrice () const
	Get pointer to array[getNumRows()] (for speed) of dual prices.
const double *	getCbcReducedCost () const
	Get a pointer to array[getNumCols()] (for speed) of reduced costs.
const double *	getCbcRowActivity () const
	Get pointer to array[getNumRows()] (for speed) of row activity levels.
Methods related to querying the solution
double *	continuousSolution () const
	Holds solution at continuous (after cuts if branchAndBound called).
int *	usedInSolution () const
	Array marked whenever a solution is found if non-zero.
void	incrementUsed (const double *solution)
	Increases usedInSolution for nonzeros.
void	setBestSolution (CBC_Message how, double &objectiveValue, const double *solution, bool fixVariables=false)
	Record a new incumbent solution and update objectiveValue.
void	setBestObjectiveValue (double objectiveValue)
	Just update objectiveValue.
double	checkSolution (double cutoff, double *solution, bool fixVariables, double originalObjValue)
	Call this to really test if a valid solution can be feasible Solution is number columns in size.
bool	feasibleSolution (int &numberIntegerInfeasibilities, int &numberObjectInfeasibilities) const
	Test the current solution for feasiblility.
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	setTestSolution (const double *solution)
	Holds solution at continuous (after cuts if branchAndBound called).
void	reserveCurrentSolution (const double *solution=NULL)
	Make sure region there and optionally copy solution.
const double *	getColSolution () const
	Get pointer to array[getNumCols()] of primal solution vector.
const double *	getRowPrice () const
	Get pointer to array[getNumRows()] of dual prices.
const double *	getReducedCost () const
	Get a pointer to array[getNumCols()] of reduced costs.
const double *	getRowActivity () const
	Get pointer to array[getNumRows()] of row activity levels.
double	getCurrentObjValue () const
	Get current objective function value.
double	getCurrentMinimizationObjValue () const
	Get current minimization objective function value.
double	getMinimizationObjValue () const
	Get best objective function value as minimization.
void	setMinimizationObjValue (double value)
	Set best objective function value as minimization.
double	getObjValue () const
	Get best objective function value.
double	getBestPossibleObjValue () const
	Get best possible objective function value.
void	setObjValue (double value)
	Set best objective function value.
double *	bestSolution () const
	The best solution to the integer programming problem.
void	setBestSolution (const double *solution, int numberColumns, double objectiveValue)
	Holds solution at continuous (after cuts if branchAndBound called).
int	getSolutionCount () const
	Get number of solutions.
void	setSolutionCount (int value)
	Set number of solutions (so heuristics will be different).
int	phase () const
	Current phase (so heuristics etc etc can find out).
int	getNumberHeuristicSolutions () const
	Get number of heuristic solutions.
void	setNumberHeuristicSolutions (int value)
	Set number of heuristic solutions.
void	setObjSense (double s)
	Set objective function sense (1 for min (default), -1 for max,).
double	getContinuousObjective () const
	Value of objective at continuous.
void	setContinuousObjective (double value)
	Holds solution at continuous (after cuts if branchAndBound called).
int	getContinuousInfeasibilities () const
	Number of infeasibilities at continuous.
void	setContinuousInfeasibilities (int value)
	Holds solution at continuous (after cuts if branchAndBound called).
double	rootObjectiveAfterCuts () const
	Value of objective after root node cuts added.
double	sumChangeObjective () const
	Sum of Changes to objective by first solve.
int	numberGlobalViolations () const
	Number of times global cuts violated.
void	clearNumberGlobalViolations ()
	Holds solution at continuous (after cuts if branchAndBound called).
bool	resolveAfterTakeOffCuts () const
	Whether to force a resolve after takeOffCuts.
void	setResolveAfterTakeOffCuts (bool yesNo)
	Holds solution at continuous (after cuts if branchAndBound called).
int	maximumRows () const
	Maximum number of rows.
CoinWarmStartBasis &	workingBasis ()
	Work basis for temporary use.
int	getNumberThreads () const
	Get number of threads.
void	setNumberThreads (int value)
	Set number of threads.
int	getThreadMode () const
	Get thread mode.
void	setThreadMode (int value)
	Set thread mode always use numberThreads for branching 1 set then use numberThreads in root mini branch and bound 2 set then use numberThreads for root cuts default is 0.
int	getStopNumberIterations () const
	Get number of "iterations" to stop after.
void	setStopNumberIterations (int value)
	Set number of "iterations" to stop after.
Node selection
CbcCompareBase *	nodeComparison () const
void	setNodeComparison (CbcCompareBase *compare)
void	setNodeComparison (CbcCompareBase &compare)
Problem feasibility checking
CbcFeasibilityBase *	problemFeasibility () const
void	setProblemFeasibility (CbcFeasibilityBase *feasibility)
void	setProblemFeasibility (CbcFeasibilityBase &feasibility)
Tree methods and subtree methods
CbcTree *	tree () const
	Tree method e.g. heap (which may be overridden by inheritance).
void	passInTreeHandler (CbcTree &tree)
	For modifying tree handling (original is cloned).
void	passInSubTreeModel (CbcModel &model)
	For passing in an CbcModel to do a sub Tree (with derived tree handlers).
CbcModel *	subTreeModel (OsiSolverInterface *solver=NULL) const
	For retrieving a copy of subtree model with given OsiSolver.
int	numberStoppedSubTrees () const
	Returns number of times any subtree stopped on nodes, time etc.
void	incrementSubTreeStopped ()
	Says a sub tree was stopped.
int	typePresolve () const
	Whether to automatically do presolve before branch and bound (subTrees).
void	setTypePresolve (int value)
	Tree method e.g. heap (which may be overridden by inheritance).
Branching Decisions
See the CbcBranchDecision class for additional information.
CbcBranchDecision *	branchingMethod () const
	Get the current branching decision method.
void	setBranchingMethod (CbcBranchDecision *method)
	Set the branching decision method.
void	setBranchingMethod (CbcBranchDecision &method)
	Set the branching method.
CbcCutModifier *	cutModifier () const
	Get the current cut modifier method.
void	setCutModifier (CbcCutModifier *modifier)
	Set the cut modifier method.
void	setCutModifier (CbcCutModifier &modifier)
	Set the cut modifier method.
Row (constraint) and Column (variable) cut generation
int	stateOfSearch () const
	State of search 0 - no solution 1 - only heuristic solutions 2 - branched to a solution 3 - no solution but many nodes.
void	setStateOfSearch (int state)
	State of search 0 - no solution 1 - only heuristic solutions 2 - branched to a solution 3 - no solution but many nodes.
int	searchStrategy () const
	Strategy worked out - mainly at root node for use by CbcNode.
void	setSearchStrategy (int value)
	Set strategy worked out - mainly at root node for use by CbcNode.
int	numberCutGenerators () const
	Get the number of cut generators.
CbcCutGenerator **	cutGenerators () const
	Get the list of cut generators.
CbcCutGenerator *	cutGenerator (int i) const
	Get the specified cut generator.
CbcCutGenerator *	virginCutGenerator (int i) const
	Get the specified cut generator before any changes.
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.
Strategy and sub models
See the CbcStrategy class for additional information.
CbcStrategy *	strategy () const
	Get the current strategy.
void	setStrategy (CbcStrategy &strategy)
	Set the strategy. Clones.
CbcModel *	parentModel () const
	Get the current parent model.
void	setParentModel (CbcModel &parentModel)
	Set the parent model.
Heuristics and priorities
void	addHeuristic (CbcHeuristic *generator, const char *name=NULL)
	Add one heuristic - up to user to delete.
CbcHeuristic *	heuristic (int i) const
	Get the specified heuristic.
int	numberHeuristics () const
	Get the number of heuristics.
CbcHeuristic *	lastHeuristic () const
	Pointer to heuristic solver which found last solution (or NULL).
void	setLastHeuristic (CbcHeuristic *last)
	set last heuristic which found a solution
void	passInPriorities (const int *priorities, bool ifNotSimpleIntegers)
	Pass in branching priorities.
int	priority (int sequence) const
	Returns priority level for an object (or 1000 if no priorities exist).
void	passInEventHandler (const CbcEventHandler *eventHandler)
	Set an event handler.
CbcEventHandler *	getEventHandler () const
	Retrieve a pointer to the event handler.
Setting/Accessing application data
void	setApplicationData (void *appData)
	Set application data.
void *	getApplicationData () const
	Get application data.
void	passInSolverCharacteristics (OsiBabSolver *solverCharacteristics)
	For advanced applications you may wish to modify the behavior of Cbc e.g.
const OsiBabSolver *	solverCharacteristics () const
	Get solver characteristics.
Message handling
void	passInMessageHandler (CoinMessageHandler *handler)
	Pass in Message handler (not deleted at end).
void	newLanguage (CoinMessages::Language language)
	Set language.
void	setLanguage (CoinMessages::Language language)
	Pass in Message handler (not deleted at end).
CoinMessageHandler *	messageHandler () const
	Return handler.
CoinMessages &	messages ()
	Return messages.
CoinMessages *	messagesPointer ()
	Return pointer to messages.
void	setLogLevel (int value)
	Set log level.
int	logLevel () const
	Get log level.
Specialized
void	setSpecialOptions (int value)
	Set special options 0 bit (1) - check if cuts valid (if on debugger list) 1 bit (2) - use current basis to check integer solution (rather than all slack) 2 bit (4) - don't check integer solution (by solving LP) 3 bit (8) - fast analyze 4 bit (16) - non-linear model - so no well defined CoinPackedMatrix 5 bit (32) - keep names 6 bit (64) - try for dominated columns.
int	specialOptions () const
	Get special options.
bool	normalSolver () const
	Says if normal solver i.e. has well defined CoinPackedMatrix.
bool	ownObjects () const
	Now we may not own objects - just point to solver's objects.
void *	mutex ()
	Pointer to a mutex.
int	splitModel (int numberModels, CbcModel **model, int numberNodes)
	Split up nodes.
void	startSplitModel (int numberIterations)
	Start threads.
void	mergeModels (int numberModel, CbcModel **model, int numberNodes)
	Merge models.
Constructors and destructors etc
	CbcModel ()
	Default Constructor.
	CbcModel (const OsiSolverInterface &)
	Constructor from solver.
void	assignSolver (OsiSolverInterface *&solver, bool deleteSolver=true)
	Assign a solver to the model (model assumes ownership).
void	setModelOwnsSolver (bool ourSolver)
	Set ownership of solver.
bool	modelOwnsSolver ()
	Get ownership of solver.
	CbcModel (const CbcModel &rhs, bool noTree=false)
	Copy constructor .
CbcModel &	operator= (const CbcModel &rhs)
	Assignment operator.
	~CbcModel ()
	Destructor.
OsiSolverInterface *	solver () const
	Returns solver - has current state.
OsiSolverInterface *	swapSolver (OsiSolverInterface *solver)
	Returns current solver - sets new one.
OsiSolverInterface *	continuousSolver () const
	Returns solver with continuous state.
void	createContinuousSolver ()
	Create solver with continuous state.
void	clearContinuousSolver ()
	Clear solver with continuous state.
OsiSolverInterface *	referenceSolver () const
	A copy of the solver, taken at constructor or by saveReferenceSolver.
void	saveReferenceSolver ()
	Save a copy of the current solver so can be reset to.
void	resetToReferenceSolver ()
	Uses a copy of reference solver to be current solver.
void	gutsOfDestructor ()
	Clears out as much as possible (except solver).
void	gutsOfDestructor2 ()
	Clears out enough to reset CbcModel as if no branch and bound done.
void	resetModel ()
	Clears out enough to reset CbcModel cutoff etc.
void	moveInfo (const CbcModel &rhs)
	Move status, nodes etc etc across.
int	getNodeCount2 () const
	-private i.e. users should not use
void	setPointers (const OsiSolverInterface *solver)
	Set pointers for speed.
int	reducedCostFix ()
	Perform reduced cost fixing.
int	resolve (OsiSolverInterface *solver)
	Encapsulates solver resolve.
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.
int	chooseBranch (CbcNode *newNode, int numberPassesLeft, bool &resolved)
	-private i.e. users should not use
CoinWarmStartBasis *	getEmptyBasis (int ns=0, int na=0) const
	Return an empty basis object of the specified size.
void	takeOffCuts (OsiCuts &cuts, bool allowResolve, OsiCuts *saveCuts)
	Remove inactive cuts from the model.
int	addCuts (CbcNode *node, CoinWarmStartBasis *&lastws, bool canFix)
	Determine and install the active cuts that need to be added for the current subproblem.
void	addCuts1 (CbcNode *node, CoinWarmStartBasis *&lastws)
	Traverse the tree from node to root and prep the model.
void	previousBounds (CbcNode *node, CbcNodeInfo *where, int iColumn, double &lower, double &upper, int force)
	Returns bounds just before where - initially original bounds.
void	setObjectiveValue (CbcNode *thisNode, const CbcNode *parentNode) const
	Set objective value in a node.
void	convertToDynamic ()
	If numberBeforeTrust >0 then we are going to use CbcBranchDynamic.
void	zapIntegerInformation (bool leaveObjects=true)
	Zap integer information in problem (may leave object info).
int	cliquePseudoCosts (int doStatistics)
	Use cliques for pseudocost information - return nonzero if infeasible.
void	pseudoShadow (double *down, double *up)
	Fill in useful estimates.
void	fillPseudoCosts (double *downCosts, double *upCosts) const
	Return pseudo costs If not all integers or not pseudo costs - returns all zero Length of arrays are numberIntegers() and entries correspond to integerVariable()[i] User must allocate arrays before call.
void	doHeuristicsAtRoot (int deleteHeuristicsAfterwards=0)
	Do heuristics at root.
const double *	hotstartSolution () const
	Get the hotstart solution.
const int *	hotstartPriorities () const
	Get the hotstart priorities.
CbcCountRowCut **	addedCuts () const
	Return the list of cuts initially collected for this subproblem.
int	currentNumberCuts () const
	Number of entries in the list returned by addedCuts().
OsiCuts *	globalCuts ()
	Global cuts.
void	setNextRowCut (const OsiRowCut &cut)
	Copy and set a pointer to a row cut which will be added instead of normal branching.
CbcNode *	currentNode () const
	Get a pointer to current node (be careful).
CglTreeProbingInfo *	probingInfo () const
	Get a pointer to probing info.
void	setNumberStrongIterations (int number)
	Set the number of iterations done in strong branching.
int	numberStrongIterations () const
	Get the number of iterations done in strong branching.
void	incrementStrongInfo (int numberTimes, int numberIterations, int numberFixed, bool ifInfeasible)
	Increment strong info.
bool	allDynamic () const
	Says whether all dynamic integers.
void	generateCpp (FILE *fp, int options)
	Create C++ lines to get to current state.
OsiBranchingInformation	usefulInformation () const
	Generate an OsiBranchingInformation object.
void	setBestSolutionBasis (const CoinWarmStartBasis &bestSolutionBasis)
	Warm start object produced by heuristic or strong branching.
Private Attributes
Private member data
OsiSolverInterface *	solver_
	The solver associated with this model.
unsigned int	ownership_
	Ownership of objects and other stuff.
OsiSolverInterface *	continuousSolver_
	A copy of the solver, taken at the continuous (root) node.
OsiSolverInterface *	referenceSolver_
	A copy of the solver, taken at constructor or by saveReferenceSolver.
CoinMessageHandler *	handler_
	Message handler.
bool	defaultHandler_
	Flag to say if handler_ is the default handler.
CoinMessages	messages_
	Cbc messages.
int	intParam_ [CbcLastIntParam]
	Array for integer parameters.
double	dblParam_ [CbcLastDblParam]
	Array for double parameters.
CoinWarmStart *	emptyWarmStart_
	Pointer to an empty warm start object.
double	bestObjective_
	Best objective.
double	bestPossibleObjective_
	Best possible objective.
double	sumChangeObjective1_
	Sum of Changes to objective by first solve.
double	sumChangeObjective2_
	Sum of Changes to objective by subsequent solves.
double *	bestSolution_
	Array holding the incumbent (best) solution.
double *	currentSolution_
	Array holding the current solution.
const double *	testSolution_
	For testing infeasibilities - will point to currentSolution_ or solver-->getColSolution().
CoinWarmStartBasis	bestSolutionBasis_
	Warm start object produced by heuristic or strong branching.
OsiCuts	globalCuts_
	Global cuts.
double	minimumDrop_
	Minimum degradation in objective value to continue cut generation.
int	numberSolutions_
	Number of solutions.
int	stateOfSearch_
	State of search 0 - no solution 1 - only heuristic solutions 2 - branched to a solution 3 - no solution but many nodes.
double *	hotstartSolution_
	Hotstart solution.
int *	hotstartPriorities_
	Hotstart priorities.
int	numberHeuristicSolutions_
	Number of heuristic solutions.
int	numberNodes_
	Cumulative number of nodes.
int	numberNodes2_
	Cumulative number of nodes for statistics.
int	numberIterations_
	Cumulative number of iterations.
int	status_
	Status of problem - 0 finished, 1 stopped, 2 difficulties.
int	secondaryStatus_
	Secondary status of problem -1 unset (status_ will also be -1) 0 search completed with solution 1 linear relaxation not feasible (or worse than cutoff) 2 stopped on gap 3 stopped on nodes 4 stopped on time 5 stopped on user event 6 stopped on solutions.
int	numberIntegers_
	Number of integers in problem.
int	numberRowsAtContinuous_
	Number of rows at continuous.
int	maximumNumberCuts_
	Maximum number of cuts.
int	phase_
	Current phase (so heuristics etc etc can find out).
int	currentNumberCuts_
	Number of entries in addedCuts_.
int	maximumDepth_
	Current limit on search tree depth.
CbcNodeInfo **	walkback_
	Array used to assemble the path between a node and the search tree root.
CbcCountRowCut **	addedCuts_
	The list of cuts initially collected for this subproblem.
OsiRowCut *	nextRowCut_
	A pointer to a row cut which will be added instead of normal branching.
CbcNode *	currentNode_
	Current node so can be used elsewhere.
int *	integerVariable_
	Indices of integer variables.
char *	integerInfo_
	Whether of not integer.
double *	continuousSolution_
	Holds solution at continuous (after cuts).
int *	usedInSolution_
	Array marked whenever a solution is found if non-zero.
int	specialOptions_
	0 bit (1) - check if cuts valid (if on debugger list) 1 bit (2) - use current basis to check integer solution (rather than all slack) 2 bit (4) - don't check integer solution 3 bit (8) - Strong is doing well - keep on
CbcCompareBase *	nodeCompare_
	User node comparison function.
CbcFeasibilityBase *	problemFeasibility_
	User feasibility function (see CbcFeasibleBase.hpp).
CbcTree *	tree_
	Tree.
CbcModel *	subTreeModel_
	A pointer to model to be used for subtrees.
int	numberStoppedSubTrees_
	Number of times any subtree stopped on nodes, time etc.
CbcBranchDecision *	branchingMethod_
	Variable selection function.
CbcCutModifier *	cutModifier_
	Cut modifier function.
CbcStrategy *	strategy_
	Strategy.
CbcModel *	parentModel_
	Parent model.
const double *	cbcColLower_
	Whether to automatically do presolve before branch and bound.
const double *	cbcColUpper_
	Pointer to array[getNumCols()] (for speed) of column upper bounds.
const double *	cbcRowLower_
	Pointer to array[getNumRows()] (for speed) of row lower bounds.
const double *	cbcRowUpper_
	Pointer to array[getNumRows()] (for speed) of row upper bounds.
const double *	cbcColSolution_
	Pointer to array[getNumCols()] (for speed) of primal solution vector.
const double *	cbcRowPrice_
	Pointer to array[getNumRows()] (for speed) of dual prices.
const double *	cbcReducedCost_
	Get a pointer to array[getNumCols()] (for speed) of reduced costs.
const double *	cbcRowActivity_
	Pointer to array[getNumRows()] (for speed) of row activity levels.
void *	appData_
	Pointer to user-defined data structure.
void *	mutex_
	Pointer to a mutex.
int	presolve_
	Presolve for CbcTreeLocal.
int	numberStrong_
	Maximum number of candidates to consider for strong branching.
int	numberBeforeTrust_
	The number of branches before pseudo costs believed in dynamic strong branching.
int	numberPenalties_
	The number of variables for which to compute penalties in dynamic strong branching.
int	stopNumberIterations_
	For threads - stop after this many "iterations".
double	penaltyScaleFactor_
	Scale factor to make penalties match strong.
int	numberAnalyzeIterations_
	Number of analyze iterations to do.
double *	analyzeResults_
	Arrays with analysis results.
int	numberInfeasibleNodes_
	Number of nodes infeasible by normal branching (before cuts).
int	problemType_
	Problem type as set by user or found by analysis.
int	printFrequency_
	Print frequency.
int	numberCutGenerators_
	Number of cut generators.
CbcCutGenerator **	generator_
	The solver associated with this model.
CbcCutGenerator **	virginGenerator_
	The solver associated with this model.
int	numberHeuristics_
	Number of heuristics.
CbcHeuristic **	heuristic_
	Heuristic solvers.
CbcHeuristic *	lastHeuristic_
	Pointer to heuristic solver which found last solution (or NULL).
CbcEventHandler *	eventHandler_
int	numberObjects_
	Total number of objects.
OsiObject **	object_
	Integer and Clique and .
bool	ownObjects_
	Now we may not own objects - just point to solver's objects.
int *	originalColumns_
	Original columns as created by integerPresolve or preprocessing.
int	howOftenGlobalScan_
	How often to scan global cuts.
int	numberGlobalViolations_
	Number of times global cuts violated.
double	continuousObjective_
	Value of objective at continuous (Well actually after initial round of cuts).
double	originalContinuousObjective_
	Value of objective before root node cuts added.
int	continuousInfeasibilities_
	Number of infeasibilities at continuous.
int	maximumCutPassesAtRoot_
	Maximum number of cut passes at root.
int	maximumCutPasses_
	Maximum number of cut passes.
int	preferredWay_
	Preferred way of branching.
int	currentPassNumber_
	Current cut pass number.
int	maximumWhich_
	Maximum number of cuts (for whichGenerator_).
int	maximumRows_
	Maximum number of rows.
CoinWarmStartBasis	workingBasis_
	Work basis for temporary use.
int *	whichGenerator_
	Which cut generator generated this cut.
int	maximumStatistics_
	Maximum number of statistics.
CbcStatistics **	statistics_
	statistics
int	maximumDepthActual_
	Maximum depth reached.
double	numberDJFixed_
	Number of reduced cost fixings.
CglTreeProbingInfo *	probingInfo_
	Probing info.
int	numberFixedAtRoot_
	Number of fixed by analyze at root.
int	numberFixedNow_
	Number fixed by analyze so far.
bool	stoppedOnGap_
	Whether stopping on gap.
bool	eventHappened_
	Whether event happened.
int	numberLongStrong_
	Number of long strong goes.
int	numberOldActiveCuts_
	Number of old active cuts.
int	numberNewCuts_
	Number of new cuts.
int	sizeMiniTree_
	Size of mini - tree.
int	searchStrategy_
	Strategy worked out - mainly at root node.
int	numberStrongIterations_
	Number of iterations in strong branching.
int	strongInfo_ [3]
	0 - number times strong branching done, 1 - number fixed, 2 - number infeasible
OsiBabSolver *	solverCharacteristics_
	For advanced applications you may wish to modify the behavior of Cbc e.g.
bool	resolveAfterTakeOffCuts_
	Whether to force a resolve after takeOffCuts.
int	numberThreads_
	Parallel 0 - off 1 - testing 2-99 threads other special meanings.
int	threadMode_
	thread mode always use numberThreads for branching 1 set then use numberThreads in root mini branch and bound 2 set then use numberThreads for root cuts default is 0
Solve methods
void	initialSolve ()
	Solve the initial LP relaxation.
void	branchAndBound (int doStatistics=0)
	Invoke the branch & cut algorithm.
CbcModel *	cleanModel (const double *lower, const double *upper)
	create a clean model from partially fixed problem
int	subBranchAndBound (CbcModel *model2, CbcModel *presolvedModel, int maximumNodes)
	Invoke the branch & cut algorithm on partially fixed problem.
int	subBranchAndBound (const double *lower, const double *upper, int maximumNodes)
	Invoke the branch & cut algorithm on partially fixed problem.
OsiSolverInterface *	strengthenedModel ()
	Process root node and return a strengthened model.
CglPreProcess *	preProcess (int makeEquality=0, int numberPasses=5, int tuning=5)
	preProcess problem - replacing solver If makeEquality true then <= cliques converted to ==.
void	postProcess (CglPreProcess *process)
	Does postprocessing - original solver back.
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 found node NULL on return if no branches left newNode NULL if no new node created.
bool	isLocked () const
	Returns true if locked.
int	whileIterating (int numberIterations)
	Main loop (without threads but when subtrees) 1 if finished, 0 if stopped.
void	lockThread ()
	Solve the initial LP relaxation.
void	unlockThread ()
	Solve the initial LP relaxation.
int	resolve (CbcNodeInfo *parent, int whereFrom)
	Reoptimise an LP relaxation.
void	makeGlobalCuts (int numberRows, const int *which)
	Make given rows (L or G) into global cuts and remove from lp.
void	makeGlobalCut (const OsiRowCut *cut)
	Make given cut into a global cut.
void	makeGlobalCut (const OsiRowCut &cut)
	Make given cut into a global cut.
bool	solveWithCuts (OsiCuts &cuts, int numberTries, CbcNode *node)
	Evaluate a subproblem using cutting planes and heuristics.
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 operate in parallel so is given a solver and is const(ish) However we will need to keep an array of solver_ and bases and more status is 0 for normal, 1 if solution Calling code should always push nodes back on tree.
void	resizeWhichGenerator (int numberNow, int numberAfter)
	Update size of whichGenerator.
void	moveToModel (CbcModel *baseModel, int mode)
	Move/copy information from one model to another -1 - initialization 0 - from base model 1 - to base model (and reset) 2 - add in final statistics etc (and reset so can do clean destruction).

---

Detailed Description

Simple Branch and bound class.

The initialSolve() method solves the initial LP relaxation of the MIP problem. The branchAndBound() method can then be called to finish using a branch and cut algorithm.

Search Tree Traversal

Subproblems (aka nodes) requiring additional evaluation are stored using the CbcNode and CbcNodeInfo objects. Ancestry linkage is maintained in the CbcNodeInfo object. Evaluation of a subproblem within branchAndBound() proceeds as follows:

• The node representing the most promising parent subproblem is popped from the heap which holds the set of subproblems requiring further evaluation.
• Using branching instructions stored in the node, and information in its ancestors, the model and solver are adjusted to create the active subproblem.
• If the parent subproblem will require further evaluation (i.e., there are branches remaining) its node is pushed back on the heap. Otherwise, the node is deleted. This may trigger recursive deletion of ancestors.
• The newly created subproblem is evaluated.
• If the subproblem requires further evaluation, a node is created. All information needed to recreate the subproblem (branching information, row and column cuts) is placed in the node and the node is added to the set of subproblems awaiting further evaluation.

Note that there is never a node representing the active subproblem; the model and solver represent the active subproblem.

Row (Constraint) Cut Handling

For a typical subproblem, the sequence of events is as follows:

• The subproblem is rebuilt for further evaluation: One result of a call to addCuts() is a traversal of ancestors, leaving a list of all cuts used in the ancestors in addedCuts_. This list is then scanned to construct a basis that includes only tight cuts. Entries for loose cuts are set to NULL.
• The subproblem is evaluated: One result of a call to solveWithCuts() is the return of a set of newly generated cuts for the subproblem. addedCuts_ is also kept up-to-date as old cuts become loose.
• The subproblem is stored for further processing: A call to CbcNodeInfo::addCuts() adds the newly generated cuts to the CbcNodeInfo object associated with this node.

See CbcCountRowCut for details of the bookkeeping associated with cut management.

Definition at line 90 of file CbcModel.hpp.

---

Member Enumeration Documentation

enum CbcModel::CbcIntParam

Enumerator:

CbcMaxNumNode	The maximum number of nodes before terminating.
CbcMaxNumSol	The maximum number of solutions before terminating.
CbcFathomDiscipline	Fathoming discipline. Controls objective function comparisons for purposes of fathoming by bound or determining monotonic variables. If 1, action is taken only when the current objective is strictly worse than the target. Implementation is handled by adding a small tolerance to the target.
CbcPrinting	Adjusts printout 1 does different node message with number unsatisfied on last branch.
CbcLastIntParam	Just a marker, so that a static sized array can store parameters.

Definition at line 94 of file CbcModel.hpp.

enum CbcModel::CbcDblParam

Enumerator:

CbcIntegerTolerance	The maximum amount the value of an integer variable can vary from integer and still be considered feasible.
CbcInfeasibilityWeight	The objective is assumed to worsen by this amount for each integer infeasibility.
CbcCutoffIncrement	The amount by which to tighten the objective function cutoff when a new solution is discovered.
CbcAllowableGap	Stop when the gap between the objective value of the best known solution and the best bound on the objective of any solution is less than this. This is an absolute value. Conversion from a percentage is left to the client.
CbcAllowableFractionGap	Stop when the gap between the objective value of the best known solution and the best bound on the objective of any solution is less than this fraction of of the absolute value of best known solution. Code stops if either this test or CbcAllowableGap test succeeds
CbcMaximumSeconds	The maximum number of seconds before terminating. A double should be adequate!
CbcCurrentCutoff	Cutoff - stored for speed.
CbcOptimizationDirection	Optimization direction - stored for speed.
CbcCurrentObjectiveValue	Current objective value.
CbcCurrentMinimizationObjectiveValue	Current minimization objective value.
CbcStartSeconds	The time at start of model. So that other pieces of code can access
CbcLastDblParam	Just a marker, so that a static sized array can store parameters.

Definition at line 117 of file CbcModel.hpp.

---

Constructor & Destructor Documentation

CbcModel::CbcModel

(

)

Default Constructor.

CbcModel::CbcModel

(

const OsiSolverInterface &

)

Constructor from solver.

CbcModel::CbcModel	(	const CbcModel &	rhs,
		bool	noTree = false
	)

Copy constructor .

If noTree is true then tree and cuts are not copied

CbcModel::~CbcModel

(

)

Destructor.

---

Member Function Documentation

void CbcModel::initialSolve

(

)

Solve the initial LP relaxation.

Invoke the solver's initialSolve() method.

void CbcModel::branchAndBound

(

int

doStatistics = 0

)

Invoke the branch & cut algorithm.

The method assumes that initialSolve() has been called to solve the LP relaxation. It processes the root node, then proceeds to explore the branch & cut search tree. The search ends when the tree is exhausted or one of several execution limits is reached. If doStatistics is 1 summary statistics are printed if 2 then also the path to best solution (if found by branching) if 3 then also one line per node

CbcModel* CbcModel::cleanModel	(	const double *	lower,
		const double *	upper
	)

create a clean model from partially fixed problem

The method creates a new model with given bounds and with no tree.

int CbcModel::subBranchAndBound	(	CbcModel *	model2,
		CbcModel *	presolvedModel,
		int	maximumNodes
	)

Invoke the branch & cut algorithm on partially fixed problem.

The method presolves the given model and does branch and cut. The search ends when the tree is exhausted or maximum nodes is reached.

If better solution found then it is saved.

Returns 0 if search completed and solution, 1 if not completed and solution, 2 if completed and no solution, 3 if not completed and no solution.

Normally okay to do cleanModel immediately followed by subBranchandBound (== other form of subBranchAndBound) but may need to get at model for advanced features.

Deletes model2

int CbcModel::subBranchAndBound	(	const double *	lower,
		const double *	upper,
		int	maximumNodes
	)

Invoke the branch & cut algorithm on partially fixed problem.

The method creates a new model with given bounds, presolves it then proceeds to explore the branch & cut search tree. The search ends when the tree is exhausted or maximum nodes is reached.

If better solution found then it is saved.

Returns 0 if search completed and solution, 1 if not completed and solution, 2 if completed and no solution, 3 if not completed and no solution.

This is just subModel immediately followed by other version of subBranchandBound.

OsiSolverInterface* CbcModel::strengthenedModel

(

)

Process root node and return a strengthened model.

The method assumes that initialSolve() has been called to solve the LP relaxation. It processes the root node and then returns a pointer to the strengthened model (or NULL if infeasible)

CglPreProcess* CbcModel::preProcess	(	int	makeEquality = 0,
		int	numberPasses = 5,
		int	tuning = 5
	)

preProcess problem - replacing solver If makeEquality true then <= cliques converted to ==.

Presolve will be done numberPasses times.

Returns NULL if infeasible

If makeEquality is 1 add slacks to get cliques, if 2 add slacks to get sos (but only if looks plausible) and keep sos info

void CbcModel::postProcess

(

CglPreProcess *

process

)

Does postprocessing - original solver back.

User has to delete process

bool CbcModel::solveWithCuts	(	OsiCuts &	cuts,
		int	numberTries,
		CbcNode *	node
	)			[private]

Evaluate a subproblem using cutting planes and heuristics.

The method invokes a main loop which generates cuts, applies heuristics, and reoptimises using the solver's native resolve() method. It returns true if the subproblem remains feasible at the end of the evaluation.

CbcNode** CbcModel::solveOneNode	(	int	whichSolver,
		CbcNode *	node,
		int &	numberNodesOutput,
		int &	status
	)			[private]

Input one node output N nodes to put on tree and optional solution update This should be able to operate in parallel so is given a solver and is const(ish) However we will need to keep an array of solver_ and bases and more status is 0 for normal, 1 if solution Calling code should always push nodes back on tree.

void CbcModel::resizeWhichGenerator	(	int	numberNow,
		int	numberAfter
	)			[private]

Update size of whichGenerator.

int CbcModel::doOneNode	(	CbcModel *	baseModel,
		CbcNode *&	node,
		CbcNode *&	newNode
	)

Do one node - broken out for clarity? also for parallel (when baseModel!=this) Returns 1 if solution found node NULL on return if no branches left newNode NULL if no new node created.

bool CbcModel::isLocked

(

)

const

Returns true if locked.

int CbcModel::whileIterating

(

int

numberIterations

)

Main loop (without threads but when subtrees) 1 if finished, 0 if stopped.

void CbcModel::lockThread

(

)

[inline]

Solve the initial LP relaxation.

Invoke the solver's initialSolve() method.

Definition at line 303 of file CbcModel.hpp.

void CbcModel::unlockThread

(

)

[inline]

Solve the initial LP relaxation.

Invoke the solver's initialSolve() method.

Definition at line 304 of file CbcModel.hpp.

void CbcModel::moveToModel	(	CbcModel *	baseModel,
		int	mode
	)			[private]

Move/copy information from one model to another -1 - initialization 0 - from base model 1 - to base model (and reset) 2 - add in final statistics etc (and reset so can do clean destruction).

int CbcModel::resolve	(	CbcNodeInfo *	parent,
		int	whereFrom
	)

Reoptimise an LP relaxation.

Invoke the solver's resolve() method. whereFrom - 0 - initial continuous 1 - resolve on branch (before new cuts) 2 - after new cuts 3 - obsolete code or something modified problem in unexpected way 10 - after strong branching has fixed variables at root 11 - after strong branching has fixed variables in tree

returns 1 feasible, 0 infeasible, -1 feasible but skip cuts

void CbcModel::makeGlobalCuts	(	int	numberRows,
		const int *	which
	)

Make given rows (L or G) into global cuts and remove from lp.

void CbcModel::makeGlobalCut

(

const OsiRowCut *

cut

)

Make given cut into a global cut.

void CbcModel::makeGlobalCut

(

const OsiRowCut &

cut

)

Make given cut into a global cut.

CbcModel* CbcModel::findCliques	(	bool	makeEquality,
		int	atLeastThisMany,
		int	lessThanThis,
		int	defaultValue = 1000
	)

Identify cliques and construct corresponding objects.

Find cliques with size in the range [atLeastThisMany, lessThanThis] and construct corresponding CbcClique objects. If makeEquality is true then a new model may be returned if modifications had to be made, otherwise this is returned. If the problem is infeasible numberObjects_ is set to -1. A client must use deleteObjects() before a second call to findCliques(). If priorities exist, clique priority is set to the default.

CbcModel* CbcModel::integerPresolve

(

bool

weak = false

)

Do integer presolve, creating a new (presolved) model.

Returns the new model, or NULL if feasibility is lost. If weak is true then just does a normal presolve

Todo:

It remains to work out the cleanest way of getting a solution to the original problem at the end. So this is very preliminary.

bool CbcModel::integerPresolveThisModel	(	OsiSolverInterface *	originalSolver,
		bool	weak = false
	)

Do integer presolve, modifying the current model.

Returns true if the model remains feasible after presolve.

void CbcModel::originalModel	(	CbcModel *	presolvedModel,
		bool	weak
	)

Put back information into the original model after integer presolve.

bool CbcModel::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.

Returns false if feasibility is lost. If CglProbing is available, it will be tried as well to see if it can tighten bounds. This routine is just a front end for tightenVubs(int,const int*,double).

If type = -1 all variables are processed (could be very slow). If type = 0 only variables involved in VUBs are processed. If type = n > 0, only the n most expensive VUB variables are processed, where it is assumed that x is at its maximum so delta would have to go to 1 (if x not at bound).

If allowMultipleBinary is true, then a VUB constraint is a row with one continuous variable and any number of binary variables.

If useCutoff < 1.0e30, the original objective is installed as a constraint with useCutoff as a bound.

bool CbcModel::tightenVubs	(	int	numberVubs,
		const int *	which,
		double	useCutoff = 1.0e50
	)

For variables involved in VUB constraints, see if we can tighten bounds by solving lp's.

This version is just handed a list of variables to be processed.

void CbcModel::analyzeObjective

(

)

Analyze problem to find a minimum change in the objective function.

int CbcModel::numberObjects

(

)

const [inline]

Get the number of objects.

Definition at line 419 of file CbcModel.hpp.

void CbcModel::setNumberObjects

(

int

number

)

[inline]

Set the number of objects.

Definition at line 421 of file CbcModel.hpp.

OsiObject** CbcModel::objects

(

)

const [inline]

Get the array of objects.

Definition at line 425 of file CbcModel.hpp.

const OsiObject* CbcModel::object

(

int

which

)

const [inline]

Get the specified object.

Definition at line 428 of file CbcModel.hpp.

OsiObject* CbcModel::modifiableObject

(

int

which

)

const [inline]

Get the specified object.

Definition at line 430 of file CbcModel.hpp.

void CbcModel::deleteObjects

(

bool

findIntegers = true

)

Delete all object information (and just back to integers if true).

void CbcModel::addObjects	(	int	numberObjects,
		OsiObject **	objects
	)

Add in object information.

Objects are cloned; the owner can delete the originals.

void CbcModel::addObjects	(	int	numberObjects,
		CbcObject **	objects
	)

Add in object information.

Objects are cloned; the owner can delete the originals.

void CbcModel::synchronizeModel

(

)

Ensure attached objects point to this model.

void CbcModel::findIntegers	(	bool	startAgain,
		int	type = 0
	)

Identify integer variables and create corresponding objects.

Record integer variables and create an CbcSimpleInteger object for each one. If startAgain is true, a new scan is forced, overwriting any existing integer variable information. If type > 0 then 1==PseudoCost

bool CbcModel::setIntParam	(	CbcIntParam	key,
		int	value
	)			[inline]

Set an integer parameter.

Definition at line 475 of file CbcModel.hpp.

bool CbcModel::setDblParam	(	CbcDblParam	key,
		double	value
	)			[inline]

Set a double parameter.

Definition at line 480 of file CbcModel.hpp.

int CbcModel::getIntParam

(

CbcIntParam

key

)

const [inline]

Get an integer parameter.

Definition at line 485 of file CbcModel.hpp.

double CbcModel::getDblParam

(

CbcDblParam

key

)

const [inline]

Get a double parameter.

Definition at line 489 of file CbcModel.hpp.

void CbcModel::setCutoff

(

double

value

)

Set cutoff bound on the objective function.

When using strict comparison, the bound is adjusted by a tolerance to avoid accidentally cutting off the optimal solution.

double CbcModel::getCutoff

(

)

const [inline]

Get the cutoff bound on the objective function - always as minimize.

Definition at line 500 of file CbcModel.hpp.

bool CbcModel::setMaximumNodes

(

int

value

)

[inline]

Set the maximum node limit .

Definition at line 508 of file CbcModel.hpp.

int CbcModel::getMaximumNodes

(

)

const [inline]

Get the maximum node limit .

Definition at line 512 of file CbcModel.hpp.

bool CbcModel::setMaximumSolutions

(

int

value

)

[inline]

Set the maximum number of solutions desired.

Definition at line 519 of file CbcModel.hpp.

int CbcModel::getMaximumSolutions

(

)

const [inline]

Get the maximum number of solutions desired.

Definition at line 526 of file CbcModel.hpp.

bool CbcModel::setPrintingMode

(

int

value

)

[inline]

Set the printing mode.

Definition at line 530 of file CbcModel.hpp.

int CbcModel::getPrintingMode

(

)

const [inline]

Get the printing mode.

Definition at line 534 of file CbcModel.hpp.

bool CbcModel::setMaximumSeconds

(

double

value

)

[inline]

Set the maximum number of seconds desired.

Definition at line 541 of file CbcModel.hpp.

double CbcModel::getMaximumSeconds

(

)

const [inline]

Get the maximum number of seconds desired.

Definition at line 548 of file CbcModel.hpp.

double CbcModel::getCurrentSeconds

(

)

const

Current time since start of branchAndbound.

bool CbcModel::setIntegerTolerance

(

double

value

)

[inline]

Set the integrality tolerance .

Definition at line 557 of file CbcModel.hpp.

double CbcModel::getIntegerTolerance

(

)

const [inline]

Get the integrality tolerance .

Definition at line 563 of file CbcModel.hpp.

bool CbcModel::setInfeasibilityWeight

(

double

value

)

[inline]

Set the weight per integer infeasibility .

Definition at line 571 of file CbcModel.hpp.

double CbcModel::getInfeasibilityWeight

(

)

const [inline]

Get the weight per integer infeasibility .

Definition at line 578 of file CbcModel.hpp.

bool CbcModel::setAllowableGap

(

double

value

)

[inline]

Set the allowable gap between the best known solution and the best possible solution.

Definition at line 585 of file CbcModel.hpp.

double CbcModel::getAllowableGap

(

)

const [inline]

Get the allowable gap between the best known solution and the best possible solution.

Definition at line 591 of file CbcModel.hpp.

bool CbcModel::setAllowableFractionGap

(

double

value

)

[inline]

Set the fraction allowable gap between the best known solution and the best possible solution.

Definition at line 598 of file CbcModel.hpp.

double CbcModel::getAllowableFractionGap

(

)

const [inline]

Get the fraction allowable gap between the best known solution and the best possible solution.

Definition at line 604 of file CbcModel.hpp.

bool CbcModel::setAllowablePercentageGap

(

double

value

)

[inline]

Set the percentage allowable gap between the best known solution and the best possible solution.

Definition at line 610 of file CbcModel.hpp.

double CbcModel::getAllowablePercentageGap

(

)

const [inline]

Get the percentage allowable gap between the best known solution and the best possible solution.

Definition at line 616 of file CbcModel.hpp.

bool CbcModel::setCutoffIncrement

(

double

value

)

[inline]

Set the CbcModel::CbcCutoffIncrement desired.

Definition at line 623 of file CbcModel.hpp.

double CbcModel::getCutoffIncrement

(

)

const [inline]

Get the CbcModel::CbcCutoffIncrement desired.

Definition at line 630 of file CbcModel.hpp.

void CbcModel::setHotstartSolution	(	const double *	solution,
		const int *	priorities = NULL
	)

Pass in target solution and optional priorities.

If priorities then >0 means only branch if incorrect while <0 means branch even if correct. +1 or -1 are highest priority

void CbcModel::setMinimumDrop

(

double

value

)

[inline]

Set the minimum drop to continue cuts.

Definition at line 641 of file CbcModel.hpp.

double CbcModel::getMinimumDrop

(

)

const [inline]

Get the minimum drop to continue cuts.

Definition at line 644 of file CbcModel.hpp.

void CbcModel::setMaximumCutPassesAtRoot

(

int

value

)

[inline]

Set the maximum number of cut passes at root node (default 20) Minimum drop can also be used for fine tuning.

Definition at line 649 of file CbcModel.hpp.

int CbcModel::getMaximumCutPassesAtRoot

(

)

const [inline]

Get the maximum number of cut passes at root node.

Definition at line 652 of file CbcModel.hpp.

void CbcModel::setMaximumCutPasses

(

int

value

)

[inline]

Set the maximum number of cut passes at other nodes (default 10) Minimum drop can also be used for fine tuning.

Definition at line 657 of file CbcModel.hpp.

int CbcModel::getMaximumCutPasses

(

)

const [inline]

Get the maximum number of cut passes at other nodes (default 10).

Definition at line 660 of file CbcModel.hpp.

int CbcModel::getCurrentPassNumber

(

)

const [inline]

Get current cut pass number in this round of cuts.

(1 is first pass)

Definition at line 664 of file CbcModel.hpp.

void CbcModel::setNumberStrong

(

int

number

)

Set the maximum number of candidates to be evaluated for strong branching.

A value of 0 disables strong branching.

int CbcModel::numberStrong

(

)

const [inline]

Get the maximum number of candidates to be evaluated for strong branching.

Definition at line 676 of file CbcModel.hpp.

void CbcModel::setPreferredWay

(

int

value

)

[inline]

Set global preferred way to branch -1 down, +1 up, 0 no preference.

Definition at line 680 of file CbcModel.hpp.

int CbcModel::getPreferredWay

(

)

const [inline]

Get the preferred way to branch (default 0).

Definition at line 683 of file CbcModel.hpp.

void CbcModel::setSizeMiniTree

(

int

value

)

[inline]

Set size of mini - tree.

If > 1 then does total enumeration of tree given by this best variables to branch on

Definition at line 688 of file CbcModel.hpp.

int CbcModel::sizeMiniTree

(

)

const [inline]

Set an integer parameter.

Definition at line 690 of file CbcModel.hpp.

void CbcModel::setNumberBeforeTrust

(

int

number

)

Set the number of branches before pseudo costs believed in dynamic strong branching.

A value of 0 disables dynamic strong branching.

int CbcModel::numberBeforeTrust

(

)

const [inline]

get the number of branches before pseudo costs believed in dynamic strong branching.

Definition at line 701 of file CbcModel.hpp.

void CbcModel::setNumberPenalties

(

int

number

)

Set the number of variables for which to compute penalties in dynamic strong branching.

A value of 0 disables penalties.

int CbcModel::numberPenalties

(

)

const [inline]

get the number of variables for which to compute penalties in dynamic strong branching.

Definition at line 711 of file CbcModel.hpp.

void CbcModel::setNumberAnalyzeIterations

(

int

number

)

[inline]

Number of analyze iterations to do.

Definition at line 714 of file CbcModel.hpp.

int CbcModel::numberAnalyzeIterations

(

)

const [inline]

Set an integer parameter.

Definition at line 716 of file CbcModel.hpp.

double CbcModel::penaltyScaleFactor

(

)

const [inline]

Get scale factor to make penalties match strong.

Should/will be computed

Definition at line 720 of file CbcModel.hpp.

void CbcModel::setPenaltyScaleFactor

(

double

value

)

Set scale factor to make penalties match strong.

Should/will be computed

void CbcModel::setProblemType

(

int

number

)

[inline]

Problem type as set by user or found by analysis.

This will be extended 0 - not known 1 - Set partitioning <= 2 - Set partitioning == 3 - Set covering 4 - all +- 1 or all +1 and odd

Definition at line 732 of file CbcModel.hpp.

int CbcModel::problemType

(

)

const [inline]

Set an integer parameter.

Definition at line 734 of file CbcModel.hpp.

void CbcModel::setHowOftenGlobalScan

(

int

number

)

Set how often to scan global cuts.

int CbcModel::howOftenGlobalScan

(

)

const [inline]

Get how often to scan global cuts.

Definition at line 740 of file CbcModel.hpp.

int* CbcModel::originalColumns

(

)

const [inline]

Original columns as created by integerPresolve or preprocessing.

Definition at line 743 of file CbcModel.hpp.

void CbcModel::setOriginalColumns

(

const int *

originalColumns

)

Set original columns as created by preprocessing.

void CbcModel::setPrintFrequency

(

int

number

)

[inline]

Set the print frequency.

Controls the number of nodes evaluated between status prints. If number <=0 the print frequency is set to 100 nodes for large problems, 1000 for small problems. Print frequency has very slight overhead if small.

Definition at line 755 of file CbcModel.hpp.

int CbcModel::printFrequency

(

)

const [inline]

Get the print frequency.

Definition at line 758 of file CbcModel.hpp.

bool CbcModel::isAbandoned

(

)

const

Are there a numerical difficulties?

bool CbcModel::isProvenOptimal

(

)

const

Is optimality proven?

bool CbcModel::isProvenInfeasible

(

)

const

Is infeasiblity proven (or none better than cutoff)?

bool CbcModel::isContinuousUnbounded

(

)

const

Was continuous solution unbounded.

bool CbcModel::isProvenDualInfeasible

(

)

const

Was continuous solution unbounded.

bool CbcModel::isNodeLimitReached

(

)

const

Node limit reached?

bool CbcModel::isSecondsLimitReached

(

)

const

Time limit reached?

bool CbcModel::isSolutionLimitReached

(

)

const

Solution limit reached?

int CbcModel::getIterationCount

(

)

const [inline]

Get how many iterations it took to solve the problem.

Definition at line 782 of file CbcModel.hpp.

int CbcModel::getNodeCount

(

)

const [inline]

Get how many Nodes it took to solve the problem.

Definition at line 785 of file CbcModel.hpp.

int CbcModel::status

(

)

const [inline]

Final status of problem Some of these can be found out by is.

..... functions -1 before branchAndBound 0 finished - check isProvenOptimal or isProvenInfeasible to see if solution found (or check value of best solution) 1 stopped - on maxnodes, maxsols, maxtime 2 difficulties so run was abandoned (5 event user programmed event occurred)

Definition at line 796 of file CbcModel.hpp.

void CbcModel::setProblemStatus

(

int

value

)

[inline]

Are there a numerical difficulties?

Definition at line 798 of file CbcModel.hpp.

int CbcModel::secondaryStatus

(

)

const [inline]

Secondary status of problem -1 unset (status_ will also be -1) 0 search completed with solution 1 linear relaxation not feasible (or worse than cutoff) 2 stopped on gap 3 stopped on nodes 4 stopped on time 5 stopped on user event 6 stopped on solutions 7 linear relaxation unbounded.

Definition at line 811 of file CbcModel.hpp.

void CbcModel::setSecondaryStatus

(

int

value

)

[inline]

Are there a numerical difficulties?

Definition at line 813 of file CbcModel.hpp.

bool CbcModel::isInitialSolveAbandoned

(

)

const

Are there numerical difficulties (for initialSolve) ?

bool CbcModel::isInitialSolveProvenOptimal

(

)

const

Is optimality proven (for initialSolve) ?

bool CbcModel::isInitialSolveProvenPrimalInfeasible

(

)

const

Is primal infeasiblity proven (for initialSolve) ?

bool CbcModel::isInitialSolveProvenDualInfeasible

(

)

const

Is dual infeasiblity proven (for initialSolve) ?

int CbcModel::numberRowsAtContinuous

(

)

const [inline]

Number of rows in continuous (root) problem.

Definition at line 840 of file CbcModel.hpp.

int CbcModel::getNumCols

(

)

const [inline]

Get number of columns.

Definition at line 844 of file CbcModel.hpp.

int CbcModel::getNumRows

(

)

const [inline]

Get number of rows.

Definition at line 848 of file CbcModel.hpp.

CoinBigIndex CbcModel::getNumElements

(

)

const [inline]

Get number of nonzero elements.

Definition at line 852 of file CbcModel.hpp.

int CbcModel::numberIntegers

(

)

const [inline]

Number of integers in problem.

Definition at line 856 of file CbcModel.hpp.

const int* CbcModel::integerVariable

(

)

const [inline]

Number of rows in continuous (root) problem.

Definition at line 859 of file CbcModel.hpp.

char CbcModel::integerType

(

int

i

)

const [inline]

Whether or not integer.

Definition at line 862 of file CbcModel.hpp.

const char* CbcModel::integerType

(

)

const [inline]

Whether or not integer.

Definition at line 865 of file CbcModel.hpp.

const double* CbcModel::getColLower

(

)

const [inline]

Get pointer to array[getNumCols()] of column lower bounds.

Definition at line 869 of file CbcModel.hpp.

const double* CbcModel::getColUpper

(

)

const [inline]

Get pointer to array[getNumCols()] of column upper bounds.

Definition at line 873 of file CbcModel.hpp.

const char* CbcModel::getRowSense

(

)

const [inline]

Get pointer to array[getNumRows()] of row constraint senses.

• 'L': <= constraint
• 'E': = constraint
• 'G': >= constraint
• 'R': ranged constraint
• 'N': free constraint

Definition at line 885 of file CbcModel.hpp.

const double* CbcModel::getRightHandSide

(

)

const [inline]

Get pointer to array[getNumRows()] of rows right-hand sides.

• if rowsense()[i] == 'L' then rhs()[i] == rowupper()[i]
• if rowsense()[i] == 'G' then rhs()[i] == rowlower()[i]
• if rowsense()[i] == 'R' then rhs()[i] == rowupper()[i]
• if rowsense()[i] == 'N' then rhs()[i] == 0.0

Definition at line 896 of file CbcModel.hpp.

const double* CbcModel::getRowRange

(

)

const [inline]

Get pointer to array[getNumRows()] of row ranges.

• if rowsense()[i] == 'R' then rowrange()[i] == rowupper()[i] - rowlower()[i]
• if rowsense()[i] != 'R' then rowrange()[i] is 0.0

Definition at line 907 of file CbcModel.hpp.

const double* CbcModel::getRowLower

(

)

const [inline]

Get pointer to array[getNumRows()] of row lower bounds.

Definition at line 911 of file CbcModel.hpp.

const double* CbcModel::getRowUpper

(

)

const [inline]

Get pointer to array[getNumRows()] of row upper bounds.

Definition at line 915 of file CbcModel.hpp.

const double* CbcModel::getObjCoefficients

(

)

const [inline]

Get pointer to array[getNumCols()] of objective function coefficients.

Definition at line 919 of file CbcModel.hpp.

double CbcModel::getObjSense

(

)

const [inline]

Get objective function sense (1 for min (default), -1 for max).

Definition at line 923 of file CbcModel.hpp.

bool CbcModel::isContinuous

(

int

colIndex

)

const [inline]

Return true if variable is continuous.

Definition at line 929 of file CbcModel.hpp.

bool CbcModel::isBinary

(

int

colIndex

)

const [inline]

Return true if variable is binary.

Definition at line 933 of file CbcModel.hpp.

bool CbcModel::isInteger

(

int

colIndex

)

const [inline]

Return true if column is integer.

Note: This function returns true if the the column is binary or a general integer.

Definition at line 940 of file CbcModel.hpp.

bool CbcModel::isIntegerNonBinary

(

int

colIndex

)

const [inline]

Return true if variable is general integer.

Definition at line 944 of file CbcModel.hpp.

bool CbcModel::isFreeBinary

(

int

colIndex

)

const [inline]

Return true if variable is binary and not fixed at either bound.

Definition at line 948 of file CbcModel.hpp.

const CoinPackedMatrix* CbcModel::getMatrixByRow

(

)

const [inline]

Get pointer to row-wise copy of matrix.

Definition at line 952 of file CbcModel.hpp.

const CoinPackedMatrix* CbcModel::getMatrixByCol

(

)

const [inline]

Get pointer to column-wise copy of matrix.

Definition at line 956 of file CbcModel.hpp.

double CbcModel::getInfinity

(

)

const [inline]

Get solver's value for infinity.

Definition at line 960 of file CbcModel.hpp.

const double* CbcModel::getCbcColLower

(

)

const [inline]

Get pointer to array[getNumCols()] (for speed) of column lower bounds.

Definition at line 963 of file CbcModel.hpp.

const double* CbcModel::getCbcColUpper

(

)

const [inline]

Get pointer to array[getNumCols()] (for speed) of column upper bounds.

Definition at line 966 of file CbcModel.hpp.

const double* CbcModel::getCbcRowLower

(

)

const [inline]

Get pointer to array[getNumRows()] (for speed) of row lower bounds.

Definition at line 969 of file CbcModel.hpp.

const double* CbcModel::getCbcRowUpper

(

)

const [inline]

Get pointer to array[getNumRows()] (for speed) of row upper bounds.

Definition at line 972 of file CbcModel.hpp.

const double* CbcModel::getCbcColSolution

(

)

const [inline]

Get pointer to array[getNumCols()] (for speed) of primal solution vector.

Definition at line 975 of file CbcModel.hpp.

const double* CbcModel::getCbcRowPrice

(

)

const [inline]

Get pointer to array[getNumRows()] (for speed) of dual prices.

Definition at line 978 of file CbcModel.hpp.

const double* CbcModel::getCbcReducedCost

(

)

const [inline]

Get a pointer to array[getNumCols()] (for speed) of reduced costs.

Definition at line 981 of file CbcModel.hpp.

const double* CbcModel::getCbcRowActivity

(

)

const [inline]

Get pointer to array[getNumRows()] (for speed) of row activity levels.

Definition at line 984 of file CbcModel.hpp.

double* CbcModel::continuousSolution

(

)

const [inline]

Holds solution at continuous (after cuts if branchAndBound called).

Definition at line 992 of file CbcModel.hpp.

int* CbcModel::usedInSolution

(

)

const [inline]

Array marked whenever a solution is found if non-zero.

Code marks if heuristic returns better so heuristic need only mark if it wants to on solutions which are worse than current

Definition at line 998 of file CbcModel.hpp.

void CbcModel::incrementUsed

(

const double *

solution

)

Increases usedInSolution for nonzeros.

void CbcModel::setBestSolution	(	CBC_Message	how,
		double &	objectiveValue,
		const double *	solution,
		bool	fixVariables = false
	)

Record a new incumbent solution and update objectiveValue.

void CbcModel::setBestObjectiveValue

(

double

objectiveValue

)

Just update objectiveValue.

double CbcModel::checkSolution	(	double	cutoff,
		double *	solution,
		bool	fixVariables,
		double	originalObjValue
	)

Call this to really test if a valid solution can be feasible Solution is number columns in size.

If fixVariables true then bounds of continuous solver updated. Returns objective value (worse than cutoff if not feasible) Previously computed objective value is now passed in (in case user does not do solve)

bool CbcModel::feasibleSolution	(	int &	numberIntegerInfeasibilities,
		int &	numberObjectInfeasibilities
	)			const

Test the current solution for feasiblility.

Scan all objects for indications of infeasibility. This is broken down into simple integer infeasibility (numberIntegerInfeasibilities) and all other reports of infeasibility (numberObjectInfeasibilities).

double* CbcModel::currentSolution

(

)

const [inline]

Solution to the most recent lp relaxation.

The solver's solution to the most recent lp relaxation.

Definition at line 1031 of file CbcModel.hpp.

const double* CbcModel::testSolution

(

)

const [inline]

For testing infeasibilities - will point to currentSolution_ or solver-->getColSolution().

Definition at line 1036 of file CbcModel.hpp.

void CbcModel::setTestSolution

(

const double *

solution

)

[inline]

Holds solution at continuous (after cuts if branchAndBound called).

Definition at line 1038 of file CbcModel.hpp.

void CbcModel::reserveCurrentSolution

(

const double *

solution = NULL

)

Make sure region there and optionally copy solution.

const double* CbcModel::getColSolution

(

)

const [inline]

Get pointer to array[getNumCols()] of primal solution vector.

Definition at line 1044 of file CbcModel.hpp.

const double* CbcModel::getRowPrice

(

)

const [inline]

Get pointer to array[getNumRows()] of dual prices.

Definition at line 1048 of file CbcModel.hpp.

const double* CbcModel::getReducedCost

(

)

const [inline]

Get a pointer to array[getNumCols()] of reduced costs.

Definition at line 1052 of file CbcModel.hpp.

const double* CbcModel::getRowActivity

(

)

const [inline]

Get pointer to array[getNumRows()] of row activity levels.

Definition at line 1056 of file CbcModel.hpp.

double CbcModel::getCurrentObjValue

(

)

const [inline]

Get current objective function value.

Definition at line 1060 of file CbcModel.hpp.

double CbcModel::getCurrentMinimizationObjValue

(

)

const [inline]

Get current minimization objective function value.

Definition at line 1063 of file CbcModel.hpp.

double CbcModel::getMinimizationObjValue

(

)

const [inline]

Get best objective function value as minimization.

Definition at line 1067 of file CbcModel.hpp.

void CbcModel::setMinimizationObjValue

(

double

value

)

[inline]

Set best objective function value as minimization.

Definition at line 1070 of file CbcModel.hpp.

double CbcModel::getObjValue

(

)

const [inline]

Get best objective function value.

Definition at line 1074 of file CbcModel.hpp.

double CbcModel::getBestPossibleObjValue

(

)

const

Get best possible objective function value.

This is better of best possible left on tree and best solution found. If called from within branch and cut may be optimistic.

void CbcModel::setObjValue

(

double

value

)

[inline]

Set best objective function value.

Definition at line 1083 of file CbcModel.hpp.

double* CbcModel::bestSolution

(

)

const [inline]

The best solution to the integer programming problem.

The best solution to the integer programming problem found during the search. If no solution is found, the method returns null.

Definition at line 1092 of file CbcModel.hpp.

void CbcModel::setBestSolution	(	const double *	solution,
		int	numberColumns,
		double	objectiveValue
	)

Holds solution at continuous (after cuts if branchAndBound called).

int CbcModel::getSolutionCount

(

)

const [inline]

Get number of solutions.

Definition at line 1097 of file CbcModel.hpp.

void CbcModel::setSolutionCount

(

int

value

)

[inline]

Set number of solutions (so heuristics will be different).

Definition at line 1101 of file CbcModel.hpp.

int CbcModel::phase

(

)

const [inline]

Current phase (so heuristics etc etc can find out).

0 - initial solve 1 - solve with cuts at root 2 - solve with cuts 3 - other e.g. strong branching 4 - trying to validate a solution 5 - at end of search

Definition at line 1111 of file CbcModel.hpp.

int CbcModel::getNumberHeuristicSolutions

(

)

const [inline]

Get number of heuristic solutions.

Definition at line 1115 of file CbcModel.hpp.

void CbcModel::setNumberHeuristicSolutions

(

int

value

)

[inline]

Set number of heuristic solutions.

Definition at line 1117 of file CbcModel.hpp.

void CbcModel::setObjSense

(

double

s

)

[inline]

Set objective function sense (1 for min (default), -1 for max,).

Definition at line 1120 of file CbcModel.hpp.

double CbcModel::getContinuousObjective

(

)

const [inline]

Value of objective at continuous.

Definition at line 1124 of file CbcModel.hpp.

void CbcModel::setContinuousObjective

(

double

value

)

[inline]

Holds solution at continuous (after cuts if branchAndBound called).

Definition at line 1126 of file CbcModel.hpp.

int CbcModel::getContinuousInfeasibilities

(

)

const [inline]

Number of infeasibilities at continuous.

Definition at line 1129 of file CbcModel.hpp.

void CbcModel::setContinuousInfeasibilities

(

int

value

)

[inline]

Holds solution at continuous (after cuts if branchAndBound called).

Definition at line 1131 of file CbcModel.hpp.

double CbcModel::rootObjectiveAfterCuts

(

)

const [inline]

Value of objective after root node cuts added.

Definition at line 1134 of file CbcModel.hpp.

double CbcModel::sumChangeObjective

(

)

const [inline]

Sum of Changes to objective by first solve.

Definition at line 1137 of file CbcModel.hpp.

int CbcModel::numberGlobalViolations

(

)

const [inline]

Number of times global cuts violated.

When global cut pool then this should be kept for each cut and type of cut

Definition at line 1141 of file CbcModel.hpp.

void CbcModel::clearNumberGlobalViolations

(

)

[inline]

Holds solution at continuous (after cuts if branchAndBound called).

Definition at line 1143 of file CbcModel.hpp.

bool CbcModel::resolveAfterTakeOffCuts

(

)

const [inline]

Whether to force a resolve after takeOffCuts.

Definition at line 1146 of file CbcModel.hpp.

void CbcModel::setResolveAfterTakeOffCuts

(

bool

yesNo

)

[inline]

Holds solution at continuous (after cuts if branchAndBound called).

Definition at line 1148 of file CbcModel.hpp.

int CbcModel::maximumRows

(

)

const [inline]

Maximum number of rows.

Definition at line 1151 of file CbcModel.hpp.

CoinWarmStartBasis& CbcModel::workingBasis

(

)

[inline]

Work basis for temporary use.

Definition at line 1154 of file CbcModel.hpp.

int CbcModel::getNumberThreads

(

)

const [inline]

Get number of threads.

Definition at line 1157 of file CbcModel.hpp.

void CbcModel::setNumberThreads

(

int

value

)

[inline]

Set number of threads.

Definition at line 1160 of file CbcModel.hpp.

int CbcModel::getThreadMode

(

)

const [inline]

Get thread mode.

Definition at line 1163 of file CbcModel.hpp.

void CbcModel::setThreadMode

(

int

value

)

[inline]

Set thread mode always use numberThreads for branching 1 set then use numberThreads in root mini branch and bound 2 set then use numberThreads for root cuts default is 0.

Definition at line 1171 of file CbcModel.hpp.

int CbcModel::getStopNumberIterations

(

)

const [inline]

Get number of "iterations" to stop after.

Definition at line 1174 of file CbcModel.hpp.

void CbcModel::setStopNumberIterations

(

int

value

)

[inline]

Set number of "iterations" to stop after.

Definition at line 1177 of file CbcModel.hpp.

CbcCompareBase* CbcModel::nodeComparison

(

)

const [inline]

Definition at line 1184 of file CbcModel.hpp.

void CbcModel::setNodeComparison

(

CbcCompareBase *

compare

)

void CbcModel::setNodeComparison

(

CbcCompareBase &

compare

)

CbcFeasibilityBase* CbcModel::problemFeasibility

(

)

const [inline]

Definition at line 1193 of file CbcModel.hpp.

void CbcModel::setProblemFeasibility

(

CbcFeasibilityBase *

feasibility

)

void CbcModel::setProblemFeasibility

(

CbcFeasibilityBase &

feasibility

)

CbcTree* CbcModel::tree

(

)

const [inline]

Tree method e.g. heap (which may be overridden by inheritance).

Definition at line 1202 of file CbcModel.hpp.

void CbcModel::passInTreeHandler

(

CbcTree &

tree

)

For modifying tree handling (original is cloned).

void CbcModel::passInSubTreeModel

(

CbcModel &

model

)

For passing in an CbcModel to do a sub Tree (with derived tree handlers).

Passed in model must exist for duration of branch and bound

CbcModel* CbcModel::subTreeModel

(

OsiSolverInterface *

solver = NULL

)

const

For retrieving a copy of subtree model with given OsiSolver.

If no subtree model will use self (up to user to reset cutoff etc). If solver NULL uses current

int CbcModel::numberStoppedSubTrees

(

)

const [inline]

Returns number of times any subtree stopped on nodes, time etc.

Definition at line 1216 of file CbcModel.hpp.

void CbcModel::incrementSubTreeStopped

(

)

[inline]

Says a sub tree was stopped.

Definition at line 1219 of file CbcModel.hpp.

int CbcModel::typePresolve

(

)

const [inline]

Whether to automatically do presolve before branch and bound (subTrees).

0 - no 1 - ordinary presolve 2 - integer presolve (dodgy)

Definition at line 1226 of file CbcModel.hpp.

void CbcModel::setTypePresolve

(

int

value

)

[inline]

Tree method e.g. heap (which may be overridden by inheritance).

Definition at line 1228 of file CbcModel.hpp.

CbcBranchDecision* CbcModel::branchingMethod

(

)

const [inline]

Get the current branching decision method.

Definition at line 1240 of file CbcModel.hpp.

void CbcModel::setBranchingMethod

(

CbcBranchDecision *

method

)

[inline]

Set the branching decision method.

Definition at line 1243 of file CbcModel.hpp.

void CbcModel::setBranchingMethod

(

CbcBranchDecision &

method

)

[inline]

Set the branching method.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 1249 of file CbcModel.hpp.

CbcCutModifier* CbcModel::cutModifier

(

)

const [inline]

Get the current cut modifier method.

Definition at line 1252 of file CbcModel.hpp.

void CbcModel::setCutModifier

(

CbcCutModifier *

modifier

)

Set the cut modifier method.

void CbcModel::setCutModifier

(

CbcCutModifier &

modifier

)

Set the cut modifier method.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

int CbcModel::stateOfSearch

(

)

const [inline]

State of search 0 - no solution 1 - only heuristic solutions 2 - branched to a solution 3 - no solution but many nodes.

Definition at line 1272 of file CbcModel.hpp.

void CbcModel::setStateOfSearch

(

int

state

)

[inline]

State of search 0 - no solution 1 - only heuristic solutions 2 - branched to a solution 3 - no solution but many nodes.

Definition at line 1274 of file CbcModel.hpp.

int CbcModel::searchStrategy

(

)

const [inline]

Strategy worked out - mainly at root node for use by CbcNode.

Definition at line 1277 of file CbcModel.hpp.

void CbcModel::setSearchStrategy

(

int

value

)

[inline]

Set strategy worked out - mainly at root node for use by CbcNode.

Definition at line 1280 of file CbcModel.hpp.

int CbcModel::numberCutGenerators

(

)

const [inline]

Get the number of cut generators.

Definition at line 1284 of file CbcModel.hpp.

CbcCutGenerator** CbcModel::cutGenerators

(

)

const [inline]

Get the list of cut generators.

Definition at line 1287 of file CbcModel.hpp.

CbcCutGenerator* CbcModel::cutGenerator

(

int

i

)

const [inline]

Get the specified cut generator.

Definition at line 1290 of file CbcModel.hpp.

CbcCutGenerator* CbcModel::virginCutGenerator

(

int

i

)

const [inline]

Get the specified cut generator before any changes.

Definition at line 1293 of file CbcModel.hpp.

void CbcModel::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.

howoften affects how generator is used. 0 or 1 means always, >1 means every that number of nodes. Negative values have same meaning as positive but they may be switched off (-> -100) by code if not many cuts generated at continuous. -99 is just done at root. Name is just for printout. If depth >0 overrides how often generator is called (if howOften==-1 or >0).

CbcStrategy* CbcModel::strategy

(

)

const [inline]

Get the current strategy.

Definition at line 1316 of file CbcModel.hpp.

void CbcModel::setStrategy

(

CbcStrategy &

strategy

)

Set the strategy. Clones.

CbcModel* CbcModel::parentModel

(

)

const [inline]

Get the current parent model.

Definition at line 1321 of file CbcModel.hpp.

void CbcModel::setParentModel

(

CbcModel &

parentModel

)

[inline]

Set the parent model.

Definition at line 1324 of file CbcModel.hpp.

void CbcModel::addHeuristic	(	CbcHeuristic *	generator,
		const char *	name = NULL
	)

Add one heuristic - up to user to delete.

The name is just used for print messages.

CbcHeuristic* CbcModel::heuristic

(

int

i

)

const [inline]

Get the specified heuristic.

Definition at line 1337 of file CbcModel.hpp.

int CbcModel::numberHeuristics

(

)

const [inline]

Get the number of heuristics.

Definition at line 1340 of file CbcModel.hpp.

CbcHeuristic* CbcModel::lastHeuristic

(

)

const [inline]

Pointer to heuristic solver which found last solution (or NULL).

Definition at line 1343 of file CbcModel.hpp.

void CbcModel::setLastHeuristic

(

CbcHeuristic *

last

)

[inline]

set last heuristic which found a solution

Definition at line 1346 of file CbcModel.hpp.

void CbcModel::passInPriorities	(	const int *	priorities,
		bool	ifNotSimpleIntegers
	)

Pass in branching priorities.

If ifClique then priorities are on cliques otherwise priorities are on integer variables. Other type (if exists set to default) 1 is highest priority. (well actually -INT_MAX is but that's ugly) If hotstart > 0 then branches are created to force the variable to the value given by best solution. This enables a sort of hot start. The node choice should be greatest depth and hotstart should normally be switched off after a solution.

If ifNotSimpleIntegers true then appended to normal integers

This is now deprecated except for simple usage. If user creates Cbcobjects then set priority in them

int CbcModel::priority

(

int

sequence

)

const [inline]

Returns priority level for an object (or 1000 if no priorities exist).

Definition at line 1370 of file CbcModel.hpp.

void CbcModel::passInEventHandler

(

const CbcEventHandler *

eventHandler

)

Set an event handler.

A clone of the handler passed as a parameter is stored in CbcModel.

CbcEventHandler* CbcModel::getEventHandler

(

)

const [inline]

Retrieve a pointer to the event handler.

Definition at line 1380 of file CbcModel.hpp.

void CbcModel::setApplicationData

(

void *

appData

)

Set application data.

This is a pointer that the application can store into and retrieve from the solver interface. This field is available for the application to optionally define and use.

void* CbcModel::getApplicationData

(

)

const

Get application data.

void CbcModel::passInSolverCharacteristics

(

OsiBabSolver *

solverCharacteristics

)

For advanced applications you may wish to modify the behavior of Cbc e.g.

if the solver is a NLP solver then you may not have an exact optimum solution at each step. Information could be built into OsiSolverInterface but this is an alternative so that that interface does not have to be changed. If something similar is useful to enough solvers then it could be migrated You can also pass in by using solver->setAuxiliaryInfo. You should do that if solver is odd - if solver is normal simplex then use this. NOTE - characteristics are not cloned

const OsiBabSolver* CbcModel::solverCharacteristics

(

)

const [inline]

Get solver characteristics.

Definition at line 1412 of file CbcModel.hpp.

void CbcModel::passInMessageHandler

(

CoinMessageHandler *

handler

)

Pass in Message handler (not deleted at end).

void CbcModel::newLanguage

(

CoinMessages::Language

language

)

Set language.

void CbcModel::setLanguage

(

CoinMessages::Language

language

)

[inline]

Pass in Message handler (not deleted at end).

Definition at line 1424 of file CbcModel.hpp.

CoinMessageHandler* CbcModel::messageHandler

(

)

const [inline]

Return handler.

Definition at line 1427 of file CbcModel.hpp.

CoinMessages& CbcModel::messages

(

)

[inline]

Return messages.

Definition at line 1430 of file CbcModel.hpp.

CoinMessages* CbcModel::messagesPointer

(

)

[inline]

Return pointer to messages.

Definition at line 1433 of file CbcModel.hpp.

void CbcModel::setLogLevel

(

int

value

)

Set log level.

int CbcModel::logLevel

(

)

const [inline]

Get log level.

Definition at line 1438 of file CbcModel.hpp.

void CbcModel::setSpecialOptions

(

int

value

)

[inline]

Set special options 0 bit (1) - check if cuts valid (if on debugger list) 1 bit (2) - use current basis to check integer solution (rather than all slack) 2 bit (4) - don't check integer solution (by solving LP) 3 bit (8) - fast analyze 4 bit (16) - non-linear model - so no well defined CoinPackedMatrix 5 bit (32) - keep names 6 bit (64) - try for dominated columns.

Set special options

Definition at line 1456 of file CbcModel.hpp.

int CbcModel::specialOptions

(

)

const [inline]

Get special options.

Definition at line 1459 of file CbcModel.hpp.

bool CbcModel::normalSolver

(

)

const [inline]

Says if normal solver i.e. has well defined CoinPackedMatrix.

Definition at line 1462 of file CbcModel.hpp.

bool CbcModel::ownObjects

(

)

const [inline]

Now we may not own objects - just point to solver's objects.

Definition at line 1465 of file CbcModel.hpp.

void* CbcModel::mutex

(

)

[inline]

Pointer to a mutex.

Definition at line 1468 of file CbcModel.hpp.

int CbcModel::splitModel	(	int	numberModels,
		CbcModel **	model,
		int	numberNodes
	)

Split up nodes.

void CbcModel::startSplitModel

(

int

numberIterations

)

Start threads.

void CbcModel::mergeModels	(	int	numberModel,
		CbcModel **	model,
		int	numberNodes
	)

Merge models.

void CbcModel::assignSolver	(	OsiSolverInterface *&	solver,
		bool	deleteSolver = true
	)

Assign a solver to the model (model assumes ownership).

On return, solver will be NULL. If deleteSolver then current solver deleted (if model owned)

Note:

Parameter settings in the outgoing solver are not inherited by the incoming solver.

void CbcModel::setModelOwnsSolver

(

bool

ourSolver

)

[inline]

Set ownership of solver.

A parameter of false tells CbcModel it does not own the solver and should not delete it. Once you claim ownership of the solver, you're responsible for eventually deleting it. Note that CbcModel clones solvers with abandon. Unless you have a deep understanding of the workings of CbcModel, the only time you want to claim ownership is when you're about to delete the CbcModel object but want the solver to continue to exist (as, for example, when branchAndBound has finished and you want to hang on to the answer).

Definition at line 1510 of file CbcModel.hpp.

bool CbcModel::modelOwnsSolver

(

)

[inline]

Get ownership of solver.

A return value of true means that CbcModel owns the solver and will take responsibility for deleting it when that becomes necessary.

Definition at line 1518 of file CbcModel.hpp.

CbcModel& CbcModel::operator=

(

const CbcModel &

rhs

)

Assignment operator.

OsiSolverInterface* CbcModel::solver

(

)

const [inline]

Returns solver - has current state.

Definition at line 1532 of file CbcModel.hpp.

OsiSolverInterface* CbcModel::swapSolver

(

OsiSolverInterface *

solver

)

[inline]

Returns current solver - sets new one.

Definition at line 1536 of file CbcModel.hpp.

OsiSolverInterface* CbcModel::continuousSolver

(

)

const [inline]

Returns solver with continuous state.

Definition at line 1540 of file CbcModel.hpp.

void CbcModel::createContinuousSolver

(

)

[inline]

Create solver with continuous state.

Definition at line 1544 of file CbcModel.hpp.

void CbcModel::clearContinuousSolver

(

)

[inline]

Clear solver with continuous state.

Definition at line 1547 of file CbcModel.hpp.

OsiSolverInterface* CbcModel::referenceSolver

(

)

const [inline]

A copy of the solver, taken at constructor or by saveReferenceSolver.

Definition at line 1551 of file CbcModel.hpp.

void CbcModel::saveReferenceSolver

(

)

Save a copy of the current solver so can be reset to.

void CbcModel::resetToReferenceSolver

(

)

Uses a copy of reference solver to be current solver.

Because of possible mismatches all exotic integer information is loat (apart from normal information in OsiSolverInterface) so SOS etc and priorities will have to be redone

void CbcModel::gutsOfDestructor

(

)

Clears out as much as possible (except solver).

void CbcModel::gutsOfDestructor2

(

)

Clears out enough to reset CbcModel as if no branch and bound done.

void CbcModel::resetModel

(

)

Clears out enough to reset CbcModel cutoff etc.

void CbcModel::moveInfo

(

const CbcModel &

rhs

)

Move status, nodes etc etc across.

int CbcModel::getNodeCount2

(

)

const [inline]

-private i.e. users should not use

Get how many Nodes it took to solve the problem.

Definition at line 1579 of file CbcModel.hpp.

void CbcModel::setPointers

(

const OsiSolverInterface *

solver

)

Set pointers for speed.

int CbcModel::reducedCostFix

(

)

Perform reduced cost fixing.

Fixes integer variables at their current value based on reduced cost penalties. Returns number fixed

int CbcModel::resolve

(

OsiSolverInterface *

solver

)

Encapsulates solver resolve.

int CbcModel::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.

int CbcModel::chooseBranch	(	CbcNode *	newNode,
		int	numberPassesLeft,
		bool &	resolved
	)

-private i.e. users should not use

Get how many Nodes it took to solve the problem.

CoinWarmStartBasis* CbcModel::getEmptyBasis	(	int	ns = 0,
		int	na = 0
	)			const

Return an empty basis object of the specified size.

A useful utility when constructing a basis for a subproblem from scratch. The object returned will be of the requested capacity and appropriate for the solver attached to the model.

void CbcModel::takeOffCuts	(	OsiCuts &	cuts,
		bool	allowResolve,
		OsiCuts *	saveCuts
	)

Remove inactive cuts from the model.

An OsiSolverInterface is expected to maintain a valid basis, but not a valid solution, when loose cuts are deleted. Restoring a valid solution requires calling the solver to reoptimise. If it's certain the solution will not be required, set allowResolve to false to suppress reoptimisation. If saveCuts then slack cuts will be saved

int CbcModel::addCuts	(	CbcNode *	node,
		CoinWarmStartBasis *&	lastws,
		bool	canFix
	)

Determine and install the active cuts that need to be added for the current subproblem.

The whole truth is a bit more complicated. The first action is a call to addCuts1(). addCuts() then sorts through the list, installs the tight cuts in the model, and does bookkeeping (adjusts reference counts). The basis returned from addCuts1() is adjusted accordingly.

If it turns out that the node should really be fathomed by bound, addCuts() simply treats all the cuts as loose as it does the bookkeeping.

canFix true if extra information being passed

void CbcModel::addCuts1	(	CbcNode *	node,
		CoinWarmStartBasis *&	lastws
	)

Traverse the tree from node to root and prep the model.

addCuts1() begins the job of prepping the model to match the current subproblem. The model is stripped of all cuts, and the search tree is traversed from node to root to determine the changes required. Appropriate bounds changes are installed, a list of cuts is collected but not installed, and an appropriate basis (minus the cuts, but big enough to accommodate them) is constructed.

Todo:

addCuts1() is called in contexts where it's known in advance that all that's desired is to determine a list of cuts and do the bookkeeping (adjust the reference counts). The work of installing bounds and building a basis goes to waste.

void CbcModel::previousBounds	(	CbcNode *	node,
		CbcNodeInfo *	where,
		int	iColumn,
		double &	lower,
		double &	upper,
		int	force
	)

Returns bounds just before where - initially original bounds.

Also sets downstream nodes (lower if force 1, upper if 2)

void CbcModel::setObjectiveValue	(	CbcNode *	thisNode,
		const CbcNode *	parentNode
	)			const

Set objective value in a node.

This is separated out so that odd solvers can use. It may look at extra information in solverCharacteriscs_ and will also use bound from parent node

void CbcModel::convertToDynamic

(

)

If numberBeforeTrust >0 then we are going to use CbcBranchDynamic.

Scan and convert CbcSimpleInteger objects

void CbcModel::zapIntegerInformation

(

bool

leaveObjects = true

)

Zap integer information in problem (may leave object info).

int CbcModel::cliquePseudoCosts

(

int

doStatistics

)

Use cliques for pseudocost information - return nonzero if infeasible.

void CbcModel::pseudoShadow	(	double *	down,
		double *	up
	)

Fill in useful estimates.

void CbcModel::fillPseudoCosts	(	double *	downCosts,
		double *	upCosts
	)			const

Return pseudo costs If not all integers or not pseudo costs - returns all zero Length of arrays are numberIntegers() and entries correspond to integerVariable()[i] User must allocate arrays before call.

void CbcModel::doHeuristicsAtRoot

(

int

deleteHeuristicsAfterwards = 0

)

Do heuristics at root.

0 - don't delete 1 - delete 2 - just delete - don't even use

const double* CbcModel::hotstartSolution

(

)

const [inline]

Get the hotstart solution.

Definition at line 1687 of file CbcModel.hpp.

const int* CbcModel::hotstartPriorities

(

)

const [inline]

Get the hotstart priorities.

Definition at line 1690 of file CbcModel.hpp.

CbcCountRowCut** CbcModel::addedCuts

(

)

const [inline]

Return the list of cuts initially collected for this subproblem.

Definition at line 1694 of file CbcModel.hpp.

int CbcModel::currentNumberCuts

(

)

const [inline]

Number of entries in the list returned by addedCuts().

Definition at line 1697 of file CbcModel.hpp.

OsiCuts* CbcModel::globalCuts

(

)

[inline]

Global cuts.

Definition at line 1700 of file CbcModel.hpp.

void CbcModel::setNextRowCut

(

const OsiRowCut &

cut

)

Copy and set a pointer to a row cut which will be added instead of normal branching.

CbcNode* CbcModel::currentNode

(

)

const [inline]

Get a pointer to current node (be careful).

Definition at line 1705 of file CbcModel.hpp.

CglTreeProbingInfo* CbcModel::probingInfo

(

)

const [inline]

Get a pointer to probing info.

Definition at line 1708 of file CbcModel.hpp.

void CbcModel::setNumberStrongIterations

(

int

number

)

[inline]

Set the number of iterations done in strong branching.

Definition at line 1711 of file CbcModel.hpp.

int CbcModel::numberStrongIterations

(

)

const [inline]

Get the number of iterations done in strong branching.

Definition at line 1714 of file CbcModel.hpp.

void CbcModel::incrementStrongInfo	(	int	numberTimes,
		int	numberIterations,
		int	numberFixed,
		bool	ifInfeasible
	)

Increment strong info.

bool CbcModel::allDynamic

(

)

const [inline]

Says whether all dynamic integers.

Definition at line 1720 of file CbcModel.hpp.

void CbcModel::generateCpp	(	FILE *	fp,
		int	options
	)

Create C++ lines to get to current state.

OsiBranchingInformation CbcModel::usefulInformation

(

)

const

Generate an OsiBranchingInformation object.

void CbcModel::setBestSolutionBasis

(

const CoinWarmStartBasis &

bestSolutionBasis

)

[inline]

Warm start object produced by heuristic or strong branching.

If get a valid integer solution outside branch and bound then it can take a reasonable time to solve LP which produces clean solution. If this object has any size then it will be used in solve.

Definition at line 1731 of file CbcModel.hpp.

---

Member Data Documentation

OsiSolverInterface* CbcModel::solver_ [private]

The solver associated with this model.

Definition at line 1742 of file CbcModel.hpp.

unsigned int CbcModel::ownership_ [private]

Ownership of objects and other stuff.

0x80000000 model owns solver 0x40000000 all variables CbcDynamicPseudoCost

Definition at line 1749 of file CbcModel.hpp.

OsiSolverInterface* CbcModel::continuousSolver_ [private]

A copy of the solver, taken at the continuous (root) node.

Definition at line 1752 of file CbcModel.hpp.

OsiSolverInterface* CbcModel::referenceSolver_ [private]

A copy of the solver, taken at constructor or by saveReferenceSolver.

Definition at line 1755 of file CbcModel.hpp.

CoinMessageHandler* CbcModel::handler_ [private]

Message handler.

Definition at line 1758 of file CbcModel.hpp.

bool CbcModel::defaultHandler_ [private]

Flag to say if handler_ is the default handler.

The default handler is deleted when the model is deleted. Other handlers (supplied by the client) will not be deleted.

Definition at line 1765 of file CbcModel.hpp.

CoinMessages CbcModel::messages_ [private]

Cbc messages.

Definition at line 1768 of file CbcModel.hpp.

int CbcModel::intParam_[CbcLastIntParam] [private]

Array for integer parameters.

Definition at line 1771 of file CbcModel.hpp.

double CbcModel::dblParam_[CbcLastDblParam] [private]

Array for double parameters.

Definition at line 1774 of file CbcModel.hpp.

CoinWarmStart* CbcModel::emptyWarmStart_ [mutable, private]

Pointer to an empty warm start object.

It turns out to be useful to have this available as a base from which to build custom warm start objects. This is typed as CoinWarmStart rather than CoinWarmStartBasis to allow for the possibility that a client might want to apply a solver that doesn't use a basis-based warm start. See getEmptyBasis for an example of how this field can be used.

Definition at line 1784 of file CbcModel.hpp.

double CbcModel::bestObjective_ [private]

Best objective.

Definition at line 1787 of file CbcModel.hpp.

double CbcModel::bestPossibleObjective_ [private]

Best possible objective.

Definition at line 1789 of file CbcModel.hpp.

double CbcModel::sumChangeObjective1_ [private]

Sum of Changes to objective by first solve.

Definition at line 1791 of file CbcModel.hpp.

double CbcModel::sumChangeObjective2_ [private]

Sum of Changes to objective by subsequent solves.

Definition at line 1793 of file CbcModel.hpp.

double* CbcModel::bestSolution_ [private]

Array holding the incumbent (best) solution.

Definition at line 1796 of file CbcModel.hpp.

double* CbcModel::currentSolution_ [private]

Array holding the current solution.

This array is used more as a temporary.

Definition at line 1802 of file CbcModel.hpp.

const double* CbcModel::testSolution_ [mutable, private]

For testing infeasibilities - will point to currentSolution_ or solver-->getColSolution().

Definition at line 1806 of file CbcModel.hpp.

CoinWarmStartBasis CbcModel::bestSolutionBasis_ [private]

Warm start object produced by heuristic or strong branching.

If get a valid integer solution outside branch and bound then it can take a reasonable time to solve LP which produces clean solution. If this object has any size then it will be used in solve.

Definition at line 1813 of file CbcModel.hpp.

OsiCuts CbcModel::globalCuts_ [private]

Global cuts.

Definition at line 1815 of file CbcModel.hpp.

double CbcModel::minimumDrop_ [private]

Minimum degradation in objective value to continue cut generation.

Definition at line 1818 of file CbcModel.hpp.

int CbcModel::numberSolutions_ [private]

Number of solutions.

Definition at line 1820 of file CbcModel.hpp.

int CbcModel::stateOfSearch_ [private]

State of search 0 - no solution 1 - only heuristic solutions 2 - branched to a solution 3 - no solution but many nodes.

Definition at line 1827 of file CbcModel.hpp.

double* CbcModel::hotstartSolution_ [private]

Hotstart solution.

Definition at line 1829 of file CbcModel.hpp.

int* CbcModel::hotstartPriorities_ [private]

Hotstart priorities.

Definition at line 1831 of file CbcModel.hpp.

int CbcModel::numberHeuristicSolutions_ [private]

Number of heuristic solutions.

Definition at line 1833 of file CbcModel.hpp.

int CbcModel::numberNodes_ [private]

Cumulative number of nodes.

Definition at line 1835 of file CbcModel.hpp.

int CbcModel::numberNodes2_ [private]

Cumulative number of nodes for statistics.

Must fix to match up

Definition at line 1839 of file CbcModel.hpp.

int CbcModel::numberIterations_ [private]

Cumulative number of iterations.

Definition at line 1841 of file CbcModel.hpp.

int CbcModel::status_ [private]

Status of problem - 0 finished, 1 stopped, 2 difficulties.

Definition at line 1843 of file CbcModel.hpp.

int CbcModel::secondaryStatus_ [private]

Secondary status of problem -1 unset (status_ will also be -1) 0 search completed with solution 1 linear relaxation not feasible (or worse than cutoff) 2 stopped on gap 3 stopped on nodes 4 stopped on time 5 stopped on user event 6 stopped on solutions.

Definition at line 1854 of file CbcModel.hpp.

int CbcModel::numberIntegers_ [private]

Number of integers in problem.

Definition at line 1856 of file CbcModel.hpp.

int CbcModel::numberRowsAtContinuous_ [private]

Number of rows at continuous.

Definition at line 1858 of file CbcModel.hpp.

int CbcModel::maximumNumberCuts_ [private]

Maximum number of cuts.

Definition at line 1860 of file CbcModel.hpp.

int CbcModel::phase_ [private]

Current phase (so heuristics etc etc can find out).

0 - initial solve 1 - solve with cuts at root 2 - solve with cuts 3 - other e.g. strong branching 4 - trying to validate a solution 5 - at end of search

Definition at line 1869 of file CbcModel.hpp.

int CbcModel::currentNumberCuts_ [private]

Number of entries in addedCuts_.

Definition at line 1872 of file CbcModel.hpp.

int CbcModel::maximumDepth_ [private]

Current limit on search tree depth.

The allocated size of walkback_. Increased as needed.

Definition at line 1878 of file CbcModel.hpp.

CbcNodeInfo** CbcModel::walkback_ [private]

Array used to assemble the path between a node and the search tree root.

The array is resized when necessary. maximumDepth_ is the current allocated size.

Definition at line 1884 of file CbcModel.hpp.

CbcCountRowCut** CbcModel::addedCuts_ [private]

The list of cuts initially collected for this subproblem.

When the subproblem at this node is rebuilt, a set of cuts is collected for inclusion in the constraint system. If any of these cuts are subsequently removed because they have become loose, the corresponding entry is set to NULL.

Definition at line 1893 of file CbcModel.hpp.

OsiRowCut* CbcModel::nextRowCut_ [private]

A pointer to a row cut which will be added instead of normal branching.

After use it should be set to NULL.

Definition at line 1898 of file CbcModel.hpp.

CbcNode* CbcModel::currentNode_ [private]

Current node so can be used elsewhere.

Definition at line 1901 of file CbcModel.hpp.

int* CbcModel::integerVariable_ [private]

Indices of integer variables.

Definition at line 1904 of file CbcModel.hpp.

char* CbcModel::integerInfo_ [private]

Whether of not integer.

Definition at line 1906 of file CbcModel.hpp.

double* CbcModel::continuousSolution_ [private]

Holds solution at continuous (after cuts).

Definition at line 1908 of file CbcModel.hpp.

int* CbcModel::usedInSolution_ [private]

Array marked whenever a solution is found if non-zero.

Definition at line 1910 of file CbcModel.hpp.

int CbcModel::specialOptions_ [private]

0 bit (1) - check if cuts valid (if on debugger list) 1 bit (2) - use current basis to check integer solution (rather than all slack) 2 bit (4) - don't check integer solution 3 bit (8) - Strong is doing well - keep on

Definition at line 1917 of file CbcModel.hpp.

CbcCompareBase* CbcModel::nodeCompare_ [private]

User node comparison function.

Definition at line 1919 of file CbcModel.hpp.

CbcFeasibilityBase* CbcModel::problemFeasibility_ [private]

User feasibility function (see CbcFeasibleBase.hpp).

Definition at line 1921 of file CbcModel.hpp.

CbcTree* CbcModel::tree_ [private]

Tree.

Definition at line 1923 of file CbcModel.hpp.

CbcModel* CbcModel::subTreeModel_ [private]

A pointer to model to be used for subtrees.

Definition at line 1925 of file CbcModel.hpp.

int CbcModel::numberStoppedSubTrees_ [private]

Number of times any subtree stopped on nodes, time etc.

Definition at line 1927 of file CbcModel.hpp.

CbcBranchDecision* CbcModel::branchingMethod_ [private]

Variable selection function.

Definition at line 1929 of file CbcModel.hpp.

CbcCutModifier* CbcModel::cutModifier_ [private]

Cut modifier function.

Definition at line 1931 of file CbcModel.hpp.

CbcStrategy* CbcModel::strategy_ [private]

Strategy.

Definition at line 1933 of file CbcModel.hpp.

CbcModel* CbcModel::parentModel_ [private]

Parent model.

Definition at line 1935 of file CbcModel.hpp.

const double* CbcModel::cbcColLower_ [private]

Whether to automatically do presolve before branch and bound.

0 - no 1 - ordinary presolve 2 - integer presolve (dodgy) Pointer to array[getNumCols()] (for speed) of column lower bounds

Definition at line 1942 of file CbcModel.hpp.

const double* CbcModel::cbcColUpper_ [private]

Pointer to array[getNumCols()] (for speed) of column upper bounds.

Definition at line 1944 of file CbcModel.hpp.

const double* CbcModel::cbcRowLower_ [private]

Pointer to array[getNumRows()] (for speed) of row lower bounds.

Definition at line 1946 of file CbcModel.hpp.

const double* CbcModel::cbcRowUpper_ [private]

Pointer to array[getNumRows()] (for speed) of row upper bounds.

Definition at line 1948 of file CbcModel.hpp.

const double* CbcModel::cbcColSolution_ [private]

Pointer to array[getNumCols()] (for speed) of primal solution vector.

Definition at line 1950 of file CbcModel.hpp.

const double* CbcModel::cbcRowPrice_ [private]

Pointer to array[getNumRows()] (for speed) of dual prices.

Definition at line 1952 of file CbcModel.hpp.

const double* CbcModel::cbcReducedCost_ [private]

Get a pointer to array[getNumCols()] (for speed) of reduced costs.

Definition at line 1954 of file CbcModel.hpp.

const double* CbcModel::cbcRowActivity_ [private]

Pointer to array[getNumRows()] (for speed) of row activity levels.

Definition at line 1956 of file CbcModel.hpp.

void* CbcModel::appData_ [private]

Pointer to user-defined data structure.

Definition at line 1958 of file CbcModel.hpp.

void* CbcModel::mutex_ [private]

Pointer to a mutex.

Definition at line 1960 of file CbcModel.hpp.

int CbcModel::presolve_ [private]

Presolve for CbcTreeLocal.

Definition at line 1962 of file CbcModel.hpp.

int CbcModel::numberStrong_ [private]

Maximum number of candidates to consider for strong branching.

To disable strong branching, set this to 0.

Definition at line 1966 of file CbcModel.hpp.

int CbcModel::numberBeforeTrust_ [private]

The number of branches before pseudo costs believed in dynamic strong branching.

A value of 0 is off.

Definition at line 1972 of file CbcModel.hpp.

int CbcModel::numberPenalties_ [private]

The number of variables for which to compute penalties in dynamic strong branching.

Definition at line 1976 of file CbcModel.hpp.

int CbcModel::stopNumberIterations_ [private]

For threads - stop after this many "iterations".

Definition at line 1978 of file CbcModel.hpp.

double CbcModel::penaltyScaleFactor_ [private]

Scale factor to make penalties match strong.

Should/will be computed

Definition at line 1981 of file CbcModel.hpp.

int CbcModel::numberAnalyzeIterations_ [private]

Number of analyze iterations to do.

Definition at line 1983 of file CbcModel.hpp.

double* CbcModel::analyzeResults_ [private]

Arrays with analysis results.

Definition at line 1985 of file CbcModel.hpp.

int CbcModel::numberInfeasibleNodes_ [private]

Number of nodes infeasible by normal branching (before cuts).

Definition at line 1987 of file CbcModel.hpp.

int CbcModel::problemType_ [private]

Problem type as set by user or found by analysis.

This will be extended 0 - not known 1 - Set partitioning <= 2 - Set partitioning == 3 - Set covering

Definition at line 1994 of file CbcModel.hpp.

int CbcModel::printFrequency_ [private]

Print frequency.

Definition at line 1996 of file CbcModel.hpp.

int CbcModel::numberCutGenerators_ [private]

Number of cut generators.

Definition at line 1998 of file CbcModel.hpp.

CbcCutGenerator** CbcModel::generator_ [private]

The solver associated with this model.

Definition at line 2000 of file CbcModel.hpp.

CbcCutGenerator** CbcModel::virginGenerator_ [private]

The solver associated with this model.

Definition at line 2002 of file CbcModel.hpp.

int CbcModel::numberHeuristics_ [private]

Number of heuristics.

Definition at line 2004 of file CbcModel.hpp.

CbcHeuristic** CbcModel::heuristic_ [private]

Heuristic solvers.

Definition at line 2006 of file CbcModel.hpp.

CbcHeuristic* CbcModel::lastHeuristic_ [private]

Pointer to heuristic solver which found last solution (or NULL).

Definition at line 2008 of file CbcModel.hpp.

CbcEventHandler* CbcModel::eventHandler_ [private]

Pointer to the event handler

Definition at line 2013 of file CbcModel.hpp.

int CbcModel::numberObjects_ [private]

Total number of objects.

Definition at line 2017 of file CbcModel.hpp.

OsiObject** CbcModel::object_ [private]

Integer and Clique and .

.. information

Note:

The code assumes that the first objects on the list will be SimpleInteger objects for each integer variable, followed by Clique objects. Portions of the code that understand Clique objects will fail if they do not immediately follow the SimpleIntegers. Large chunks of the code will fail if the first objects are not SimpleInteger. As of 2003.08, SimpleIntegers and Cliques are the only objects.

Definition at line 2029 of file CbcModel.hpp.

bool CbcModel::ownObjects_ [private]

Now we may not own objects - just point to solver's objects.

Definition at line 2031 of file CbcModel.hpp.

int* CbcModel::originalColumns_ [private]

Original columns as created by integerPresolve or preprocessing.

Definition at line 2034 of file CbcModel.hpp.

int CbcModel::howOftenGlobalScan_ [private]

How often to scan global cuts.

Definition at line 2036 of file CbcModel.hpp.

int CbcModel::numberGlobalViolations_ [private]

Number of times global cuts violated.

When global cut pool then this should be kept for each cut and type of cut

Definition at line 2039 of file CbcModel.hpp.

double CbcModel::continuousObjective_ [private]

Value of objective at continuous (Well actually after initial round of cuts).

Definition at line 2043 of file CbcModel.hpp.

double CbcModel::originalContinuousObjective_ [private]

Value of objective before root node cuts added.

Definition at line 2046 of file CbcModel.hpp.

int CbcModel::continuousInfeasibilities_ [private]

Number of infeasibilities at continuous.

Definition at line 2048 of file CbcModel.hpp.

int CbcModel::maximumCutPassesAtRoot_ [private]

Maximum number of cut passes at root.

Definition at line 2050 of file CbcModel.hpp.

int CbcModel::maximumCutPasses_ [private]

Maximum number of cut passes.

Definition at line 2052 of file CbcModel.hpp.

int CbcModel::preferredWay_ [private]

Preferred way of branching.

Definition at line 2054 of file CbcModel.hpp.

int CbcModel::currentPassNumber_ [private]

Current cut pass number.

Definition at line 2056 of file CbcModel.hpp.

int CbcModel::maximumWhich_ [private]

Maximum number of cuts (for whichGenerator_).

Definition at line 2058 of file CbcModel.hpp.

int CbcModel::maximumRows_ [private]

Maximum number of rows.

Definition at line 2060 of file CbcModel.hpp.

CoinWarmStartBasis CbcModel::workingBasis_ [private]

Work basis for temporary use.

Definition at line 2062 of file CbcModel.hpp.

int* CbcModel::whichGenerator_ [private]

Which cut generator generated this cut.

Definition at line 2064 of file CbcModel.hpp.

int CbcModel::maximumStatistics_ [private]

Maximum number of statistics.

Definition at line 2066 of file CbcModel.hpp.

CbcStatistics** CbcModel::statistics_ [private]

statistics

Definition at line 2068 of file CbcModel.hpp.

int CbcModel::maximumDepthActual_ [private]

Maximum depth reached.

Definition at line 2070 of file CbcModel.hpp.

double CbcModel::numberDJFixed_ [private]

Number of reduced cost fixings.

Definition at line 2072 of file CbcModel.hpp.

CglTreeProbingInfo* CbcModel::probingInfo_ [private]

Probing info.

Definition at line 2074 of file CbcModel.hpp.

int CbcModel::numberFixedAtRoot_ [private]

Number of fixed by analyze at root.

Definition at line 2076 of file CbcModel.hpp.

int CbcModel::numberFixedNow_ [private]

Number fixed by analyze so far.

Definition at line 2078 of file CbcModel.hpp.

bool CbcModel::stoppedOnGap_ [private]

Whether stopping on gap.

Definition at line 2080 of file CbcModel.hpp.

bool CbcModel::eventHappened_ [private]

Whether event happened.

Definition at line 2082 of file CbcModel.hpp.

int CbcModel::numberLongStrong_ [private]

Number of long strong goes.

Definition at line 2084 of file CbcModel.hpp.

int CbcModel::numberOldActiveCuts_ [private]

Number of old active cuts.

Definition at line 2086 of file CbcModel.hpp.

int CbcModel::numberNewCuts_ [private]

Number of new cuts.

Definition at line 2088 of file CbcModel.hpp.

int CbcModel::sizeMiniTree_ [private]

Size of mini - tree.

Definition at line 2090 of file CbcModel.hpp.

int CbcModel::searchStrategy_ [private]

Strategy worked out - mainly at root node.

Definition at line 2092 of file CbcModel.hpp.

int CbcModel::numberStrongIterations_ [private]

Number of iterations in strong branching.

Definition at line 2094 of file CbcModel.hpp.

int CbcModel::strongInfo_[3] [private]

0 - number times strong branching done, 1 - number fixed, 2 - number infeasible

Definition at line 2096 of file CbcModel.hpp.

OsiBabSolver* CbcModel::solverCharacteristics_ [private]

For advanced applications you may wish to modify the behavior of Cbc e.g.

if the solver is a NLP solver then you may not have an exact optimum solution at each step. This gives characteristics - just for one BAB. For actually saving/restoring a solution you need the actual solver one.

Definition at line 2103 of file CbcModel.hpp.

bool CbcModel::resolveAfterTakeOffCuts_ [private]

Whether to force a resolve after takeOffCuts.

Definition at line 2105 of file CbcModel.hpp.

int CbcModel::numberThreads_ [private]

Parallel 0 - off 1 - testing 2-99 threads other special meanings.

Definition at line 2121 of file CbcModel.hpp.

int CbcModel::threadMode_ [private]

thread mode always use numberThreads for branching 1 set then use numberThreads in root mini branch and bound 2 set then use numberThreads for root cuts default is 0

Definition at line 2128 of file CbcModel.hpp.

---

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

• /home/coin/svn-release/OptimizationSuite-1.1.0/Cbc/src/CbcModel.hpp