#include <BcpsObject.h>

Inheritance diagram for BcpsVariable:

Collaboration diagram for BcpsVariable:

Public Member Functions
	BcpsVariable ()
	Default constructor.

	BcpsVariable (double lbh, double ubh, double lbs, double ubs)
	Useful constructor.

virtual	~BcpsVariable ()
	Destructor.

	BcpsVariable (const BcpsVariable &rhs)
	Copy constructor.

virtual BcpsObject_t	getObjType () const

Public Member Functions inherited from BcpsObject
	BcpsObject ()

	BcpsObject (double lbh, double ubh, double lbs, double ubs)

virtual	~BcpsObject ()

	BcpsObject (const BcpsObject &rhs)
	Copy constructor.

BcpsObject &	operator= (const BcpsObject &rhs)
	Assignment operator.

virtual BcpsObject *	clone () const
	Clone an enity.

virtual double	infeasibility (BcpsModel *m, int &preferredWay) const
	Infeasibility of the object This is some measure of the infeasibility of the object.

virtual void	feasibleRegion (BcpsModel *m)
	Look at the current solution and set bounds to match the solution.

virtual BcpsBranchObject *	createBranchObject (BcpsModel *m, int way) const
	Create a branching object and indicate which way to branch first.

virtual BcpsBranchObject *	preferredNewFeasible (BcpsModel *m) 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 BcpsBranchObject *	notPreferredNewFeasible (BcpsModel *m) 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 (BcpsModel *m)
	Reset variable bounds to their original values.

virtual bool	boundBranch (BcpsModel *m) const
	Return true if branches created by object will modify variable bounds.

virtual void	floorCeiling (double &floorValue, double &ceilingValue, double value, double tolerance) const
	Returns floor and ceiling i.e.

virtual double	upEstimate () const
	Return "up" estimate.

virtual double	downEstimate () const
	Return "down" estimate.

virtual void	printDesc ()

virtual AlpsReturnStatus	encode (AlpsEncoded *encoded)
	Pack into a encode object.

virtual AlpsKnowledge *	decode (AlpsEncoded &encoded) const
	Decode a constraint from an encoded object.

int	getObjectIndex () const
	Return the value of the appropriate field.

BcpsObjRep_t	getRepType () const

BcpsIntegral_t	getIntType () const

BcpsValidRegion	getValidRegion () const

int	getStatus () const

double	getLbHard () const

double	getUbHard () const

double	getLbSoft () const

double	getUbSoft () const

int	getNumInactive () const

double	getEffectiveness () const

void	setObjectIndex (int ind)
	Set the appropriate property.

void	setRepType (BcpsObjRep_t rt)

void	setIntType (BcpsIntegral_t it)

void	setValidRegion (BcpsValidRegion val)

void	setStatus (int st)

void	setLbHard (double lb)

void	setUbHard (double ub)

void	setLbSoft (double lb)

void	setUbSoft (double ub)

void	setNumInactive (int num)

void	setEffectiveness (double eff)

virtual void	hashing (BcpsModel *model=NULL)
	Hashing.

double	hashValue () const

Additional Inherited Members
Protected Member Functions inherited from BcpsObject
AlpsReturnStatus	encodeBcpsObject (AlpsEncoded *encoded) const
	Pack Bcps part to a encode object.

AlpsReturnStatus	decodeBcpsObject (AlpsEncoded &encoded)
	Unpack Bcps part from a encode object.

Protected Attributes inherited from BcpsObject
int	objectIndex_
	Global index of this object.

BcpsObjRep_t	repType_
	Core, indexed, or algorithmic.

BcpsIntegral_t	intType_
	The integrality type of the object, i.e., what values it can take up between the specified bounds.

BcpsValidRegion	validRegion_
	Valid in the whole tree or only the subtree rooted at the node that generate this object.

int	status_
	The status of the object.

double	lbHard_
	The lower bound of the object when it was first created.

double	ubHard_
	The upper bound of the object when it was first created.

double	lbSoft_
	The current lower bound of the object.

double	ubSoft_
	The current upper bound of the object.

double	hashValue_
	The hash value of this object.

int	numInactive_
	Number of inactive when in formulation.

double	effectiveness_
	Effectiveness: nonnegative value.

Detailed Description

Definition at line 384 of file BcpsObject.h.

Constructor & Destructor Documentation

◆ BcpsVariable() [1/3]

BcpsVariable::BcpsVariable ( )

inline

Default constructor.

Definition at line 387 of file BcpsObject.h.

◆ BcpsVariable() [2/3]

BcpsVariable::BcpsVariable	(	double	lbh,
		double	ubh,
		double	lbs,
		double	ubs )

inline

Useful constructor.

Definition at line 390 of file BcpsObject.h.

◆ ~BcpsVariable()

virtual BcpsVariable::~BcpsVariable ( )

inlinevirtual

Destructor.

Definition at line 396 of file BcpsObject.h.

◆ BcpsVariable() [3/3]

BcpsVariable::BcpsVariable ( const BcpsVariable & rhs )

inline

Copy constructor.

Definition at line 399 of file BcpsObject.h.

Member Function Documentation

◆ getObjType()

virtual BcpsObject_t BcpsVariable::getObjType ( ) const

inlinevirtual

Definition at line 404 of file BcpsObject.h.

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

src/BcpsObject.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BcpsVariable() [1/3]

◆ BcpsVariable() [2/3]

◆ ~BcpsVariable()

◆ BcpsVariable() [3/3]

Member Function Documentation

◆ getObjType()