CbcGeneral Class Reference

Define a catch all class. More...

#include <CbcGeneral.hpp>

Inheritance diagram for CbcGeneral:

List of all members.

Public Member Functions
	CbcGeneral ()
	CbcGeneral (CbcModel *model)
	Useful constructor Just needs to point to model.
	CbcGeneral (const CbcGeneral &)
virtual CbcObject *	clone () const =0
	Clone.
CbcGeneral &	operator= (const CbcGeneral &rhs)
	~CbcGeneral ()
virtual double	infeasibility (const OsiBranchingInformation *info, int &preferredWay) const
	Infeasibility - large is 0.5.
virtual void	feasibleRegion ()=0
	This looks at solution and sets bounds to contain solution.
virtual CbcBranchingObject *	createCbcBranch (OsiSolverInterface *solver, const OsiBranchingInformation *info, int way)
	Creates a branching object.
virtual void	redoSequenceEtc (CbcModel *model, int numberColumns, const int *originalColumns)=0
	Redoes data when sequence numbers change.
	CbcGeneral ()
	CbcGeneral (CbcModel *model)
	Useful constructor Just needs to point to model.
	CbcGeneral (const CbcGeneral &)
virtual CbcObject *	clone () const =0
	Clone.
CbcGeneral &	operator= (const CbcGeneral &rhs)
	~CbcGeneral ()
virtual double	infeasibility (const OsiBranchingInformation *info, int &preferredWay) const
	Infeasibility - large is 0.5.
virtual void	feasibleRegion ()=0
	This looks at solution and sets bounds to contain solution.
virtual CbcBranchingObject *	createCbcBranch (OsiSolverInterface *solver, const OsiBranchingInformation *info, int way)
	Creates a branching object.
virtual void	redoSequenceEtc (CbcModel *model, int numberColumns, const int *originalColumns)=0
	Redoes data when sequence numbers change.
Public Member Functions inherited from CbcObject
	CbcObject ()
	CbcObject (CbcModel *model)
	CbcObject (const CbcObject &)
CbcObject &	operator= (const CbcObject &rhs)
virtual	~CbcObject ()
	Destructor.
virtual double	infeasibility (int &) const
virtual double	feasibleRegion (OsiSolverInterface *solver, const OsiBranchingInformation *info) const
	Dummy one for compatibility.
virtual double	feasibleRegion (OsiSolverInterface *solver) const
	For the variable(s) referenced by the object, look at the current solution and set bounds to match the solution.
virtual CbcBranchingObject *	createBranch (OsiSolverInterface *, const OsiBranchingInformation *, int)
virtual OsiBranchingObject *	createOsiBranch (OsiSolverInterface *solver, const OsiBranchingInformation *info, int way) const
	Create an Osibranching object and indicate which way to branch first.
virtual OsiSolverBranch *	solverBranch () const
	Create an OsiSolverBranch object.
virtual CbcBranchingObject *	preferredNewFeasible () const
	Given a valid solution (with reduced costs, etc.), return a branching object which would give a new feasible point in a good direction.
virtual CbcBranchingObject *	notPreferredNewFeasible () const
	Given a valid solution (with reduced costs, etc.), return a branching object which would give a new feasible point in a bad direction.
virtual void	resetBounds (const OsiSolverInterface *)
	Reset variable bounds to their original values.
virtual void	floorCeiling (double &floorValue, double &ceilingValue, double value, double tolerance) const
	Returns floor and ceiling i.e.
virtual CbcObjectUpdateData	createUpdateInformation (const OsiSolverInterface *solver, const CbcNode *node, const CbcBranchingObject *branchingObject)
	Pass in information on branch just done and create CbcObjectUpdateData instance.
virtual void	updateInformation (const CbcObjectUpdateData &)
	Update object by CbcObjectUpdateData.
int	id () const
	Identifier (normally column number in matrix)
void	setId (int value)
	Set identifier (normally column number in matrix) but 1000000000 to 1100000000 means optional branching object i.e.
bool	optionalObject () const
	Return true if optional branching object i.e.
int	position () const
	Get position in object_ list.
void	setPosition (int position)
	Set position in object_ list.
void	setModel (CbcModel *model)
	update model
CbcModel *	model () const
	Return model.
int	preferredWay () const
	If -1 down always chosen first, +1 up always, 0 normal.
void	setPreferredWay (int value)
	Set -1 down always chosen first, +1 up always, 0 normal.
	CbcObject ()
	CbcObject (CbcModel *model)
	CbcObject (const CbcObject &)
CbcObject &	operator= (const CbcObject &rhs)
virtual	~CbcObject ()
	Destructor.
virtual double	infeasibility (int &) const
virtual double	feasibleRegion (OsiSolverInterface *solver, const OsiBranchingInformation *info) const
	Dummy one for compatibility.
virtual double	feasibleRegion (OsiSolverInterface *solver) const
	For the variable(s) referenced by the object, look at the current solution and set bounds to match the solution.
virtual CbcBranchingObject *	createBranch (OsiSolverInterface *, const OsiBranchingInformation *, int)
virtual OsiBranchingObject *	createOsiBranch (OsiSolverInterface *solver, const OsiBranchingInformation *info, int way) const
	Create an Osibranching object and indicate which way to branch first.
virtual OsiSolverBranch *	solverBranch () const
	Create an OsiSolverBranch object.
virtual CbcBranchingObject *	preferredNewFeasible () const
	Given a valid solution (with reduced costs, etc.), return a branching object which would give a new feasible point in a good direction.
virtual CbcBranchingObject *	notPreferredNewFeasible () const
	Given a valid solution (with reduced costs, etc.), return a branching object which would give a new feasible point in a bad direction.
virtual void	resetBounds (const OsiSolverInterface *)
	Reset variable bounds to their original values.
virtual void	floorCeiling (double &floorValue, double &ceilingValue, double value, double tolerance) const
	Returns floor and ceiling i.e.
virtual CbcObjectUpdateData	createUpdateInformation (const OsiSolverInterface *solver, const CbcNode *node, const CbcBranchingObject *branchingObject)
	Pass in information on branch just done and create CbcObjectUpdateData instance.
virtual void	updateInformation (const CbcObjectUpdateData &)
	Update object by CbcObjectUpdateData.
int	id () const
	Identifier (normally column number in matrix)
void	setId (int value)
	Set identifier (normally column number in matrix) but 1000000000 to 1100000000 means optional branching object i.e.
bool	optionalObject () const
	Return true if optional branching object i.e.
int	position () const
	Get position in object_ list.
void	setPosition (int position)
	Set position in object_ list.
void	setModel (CbcModel *model)
	update model
CbcModel *	model () const
	Return model.
int	preferredWay () const
	If -1 down always chosen first, +1 up always, 0 normal.
void	setPreferredWay (int value)
	Set -1 down always chosen first, +1 up always, 0 normal.

Additional Inherited Members
Protected Attributes inherited from CbcObject
CbcModel *	model_
	data
int	id_
	Identifier (normally column number in matrix)
int	position_
	Position in object list.
int	preferredWay_
	If -1 down always chosen first, +1 up always, 0 normal.

---

Detailed Description

Define a catch all class.

This will create a list of subproblems

Definition at line 11 of file CbcGeneral.hpp.

---

Constructor & Destructor Documentation

CbcGeneral::CbcGeneral

(

)

CbcGeneral::CbcGeneral

(

CbcModel *

model

)

Useful constructor Just needs to point to model.

CbcGeneral::CbcGeneral

(

const CbcGeneral &

)

CbcGeneral::~CbcGeneral

(

)

CbcGeneral::CbcGeneral

(

)

CbcGeneral::CbcGeneral

(

CbcModel *

model

)

Useful constructor Just needs to point to model.

CbcGeneral::CbcGeneral

(

const CbcGeneral &

)

CbcGeneral::~CbcGeneral

(

)

---

Member Function Documentation

virtual CbcObject* CbcGeneral::clone ( ) const

pure virtual

Clone.

Implements CbcObject.

CbcGeneral& CbcGeneral::operator=

(

const CbcGeneral &

rhs

)

virtual double CbcGeneral::infeasibility ( const OsiBranchingInformation *  info, int &  preferredWay  ) const

virtual

Infeasibility - large is 0.5.

Reimplemented from CbcObject.

virtual void CbcGeneral::feasibleRegion ( )

pure virtual

This looks at solution and sets bounds to contain solution.

Implements CbcObject.

virtual CbcBranchingObject* CbcGeneral::createCbcBranch ( OsiSolverInterface *  solver, const OsiBranchingInformation *  info, int  way  )

virtual

Creates a branching object.

Reimplemented from CbcObject.

virtual void CbcGeneral::redoSequenceEtc ( CbcModel *  model, int  numberColumns, const int *  originalColumns  )

pure virtual

Redoes data when sequence numbers change.

Reimplemented from CbcObject.

virtual CbcObject* CbcGeneral::clone ( ) const

pure virtual

Clone.

Implements CbcObject.

CbcGeneral& CbcGeneral::operator=

(

const CbcGeneral &

rhs

)

virtual double CbcGeneral::infeasibility ( const OsiBranchingInformation *  info, int &  preferredWay  ) const

virtual

Infeasibility - large is 0.5.

Reimplemented from CbcObject.

virtual void CbcGeneral::feasibleRegion ( )

pure virtual

This looks at solution and sets bounds to contain solution.

Implements CbcObject.

virtual CbcBranchingObject* CbcGeneral::createCbcBranch ( OsiSolverInterface *  solver, const OsiBranchingInformation *  info, int  way  )

virtual

Creates a branching object.

Reimplemented from CbcObject.

virtual void CbcGeneral::redoSequenceEtc ( CbcModel *  model, int  numberColumns, const int *  originalColumns  )

pure virtual

Redoes data when sequence numbers change.

Reimplemented from CbcObject.

---

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

• /tmp/buildd/coinor-cbc-2.5.0/Cbc/src/CbcGeneral.hpp
• /tmp/buildd/coinor-cbc-2.5.0/debian/tmp/usr/include/coin/CbcGeneral.hpp