Public Member Functions | Protected Member Functions | Private Attributes | List of all members
BlisVariable Class Reference

#include <BlisVariable.h>

Inheritance diagram for BlisVariable:
Inheritance graph
[legend]
Collaboration diagram for BlisVariable:
Collaboration graph
[legend]

Public Member Functions

 BlisVariable ()
 
 BlisVariable (double obj, int s, const int *ind, const double *val)
 
 BlisVariable (double lbh, double ubh, double lbs, double ubs)
 
 BlisVariable (double lbh, double ubh, double lbs, double ubs, double obj, int s, const int *ind, const double *val)
 
virtual ~BlisVariable ()
 
virtual AlpsReturnStatus encode (AlpsEncoded *encoded)
 Pack to a encode object. More...
 
virtual AlpsKnowledgedecode (AlpsEncoded &encoded) const
 Decode a variable from an encoded object. More...
 
 BlisVariable ()
 
 BlisVariable (double obj, int s, const int *ind, const double *val)
 
 BlisVariable (double lbh, double ubh, double lbs, double ubs)
 
 BlisVariable (double lbh, double ubh, double lbs, double ubs, double obj, int s, const int *ind, const double *val)
 
virtual ~BlisVariable ()
 
virtual AlpsReturnStatus encode (AlpsEncoded *encoded)
 Pack to a encode object. More...
 
virtual AlpsKnowledgedecode (AlpsEncoded &encoded) const
 Decode a variable from an encoded object. More...
 
int getSize () const
 Return data. More...
 
int * getIndices () const
 Return data. More...
 
double * getValues ()
 Return data. More...
 
void setData (int s, const int *ind, const double *val)
 Set data. More...
 
double getObjCoef ()
 Return data. More...
 
int getSize () const
 Return data. More...
 
int * getIndices () const
 Return data. More...
 
double * getValues ()
 Return data. More...
 
void setData (int s, const int *ind, const double *val)
 Set data. More...
 
void setObjCoef (double coef)
 Set data. More...
 
- Public Member Functions inherited from BcpsVariable
 BcpsVariable ()
 Default constructor. More...
 
 BcpsVariable (double lbh, double ubh, double lbs, double ubs)
 Useful constructor. More...
 
virtual ~BcpsVariable ()
 Destructor. More...
 
 BcpsVariable (const BcpsVariable &rhs)
 Copy constructor. More...
 
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. More...
 
BcpsObjectoperator= (const BcpsObject &rhs)
 Assignment operator. More...
 
virtual BcpsObjectclone () const
 Clone an enity. More...
 
virtual double infeasibility (BcpsModel *m, int &preferredWay) const
 Infeasibility of the object This is some measure of the infeasibility of the object. More...
 
virtual void feasibleRegion (BcpsModel *m)
 Look at the current solution and set bounds to match the solution. More...
 
virtual BcpsBranchObjectcreateBranchObject (BcpsModel *m, int way) const
 Create a branching object and indicate which way to branch first. More...
 
virtual BcpsBranchObjectpreferredNewFeasible (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. More...
 
virtual BcpsBranchObjectnotPreferredNewFeasible (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. More...
 
virtual void resetBounds (BcpsModel *m)
 Reset variable bounds to their original values. More...
 
virtual bool boundBranch (BcpsModel *m) const
 Return true if branches created by object will modify variable bounds. More...
 
virtual void floorCeiling (double &floorValue, double &ceilingValue, double value, double tolerance) const
 Returns floor and ceiling i.e. More...
 
virtual double upEstimate () const
 Return "up" estimate. More...
 
virtual double downEstimate () const
 Return "down" estimate. More...
 
virtual void printDesc ()
 
int getObjectIndex () const
 Return the value of the appropriate field. More...
 
BcpsObjRep_t getRepType () const
 Return the value of the appropriate field. More...
 
BcpsIntegral_t getIntType () const
 Return the value of the appropriate field. More...
 
BcpsValidRegion getValidRegion () const
 Return the value of the appropriate field. More...
 
int getStatus () const
 Return the value of the appropriate field. More...
 
double getLbHard () const
 Return the value of the appropriate field. More...
 
double getUbHard () const
 Return the value of the appropriate field. More...
 
double getLbSoft () const
 Return the value of the appropriate field. More...
 
double getUbSoft () const
 Return the value of the appropriate field. More...
 
int getNumInactive () const
 Return the value of the appropriate field. More...
 
double getEffectiveness () const
 Return the value of the appropriate field. More...
 
void setObjectIndex (int ind)
 Set the appropriate property. More...
 
void setRepType (BcpsObjRep_t rt)
 Set the appropriate property. More...
 
void setIntType (BcpsIntegral_t it)
 Set the appropriate property. More...
 
void setValidRegion (BcpsValidRegion val)
 Set the appropriate property. More...
 
void setStatus (int st)
 Set the appropriate property. More...
 
void setLbHard (double lb)
 Set the appropriate property. More...
 
void setUbHard (double ub)
 Set the appropriate property. More...
 
void setLbSoft (double lb)
 Set the appropriate property. More...
 
void setUbSoft (double ub)
 Set the appropriate property. More...
 
void setNumInactive (int num)
 Set the appropriate property. More...
 
void setEffectiveness (double eff)
 Set the appropriate property. More...
 
virtual void hashing (BcpsModel *model=NULL)
 Hashing. More...
 
double hashValue () const
 Hashing. More...
 
- Public Member Functions inherited from AlpsKnowledge
 AlpsKnowledge ()
 
virtual ~AlpsKnowledge ()
 
KnowledgeType getType ()
 
void setType (KnowledgeType t)
 
virtual AlpsEncodedencode () const
 This method should encode the content of the object and return a pointer to the encoded form. More...
 
AlpsEncodedgetEncoded () const
 Get/set encoded. More...
 
void setEncoded (AlpsEncoded *e)
 

Protected Member Functions

AlpsReturnStatus encodeBlis (AlpsEncoded *encoded)
 Pack Blis part into an encoded object. More...
 
AlpsReturnStatus decodeBlis (AlpsEncoded &encoded)
 Unpack Blis part from a encode object. More...
 
AlpsReturnStatus encodeBlis (AlpsEncoded *encoded)
 Pack Blis part into an encoded object. More...
 
AlpsReturnStatus decodeBlis (AlpsEncoded &encoded)
 Unpack Blis part from a encode object. More...
 
- Protected Member Functions inherited from BcpsObject
AlpsReturnStatus encodeBcpsObject (AlpsEncoded *encoded) const
 Pack Bcps part to a encode object. More...
 
AlpsReturnStatus decodeBcpsObject (AlpsEncoded &encoded)
 Unpack Bcps part from a encode object. More...
 

Private Attributes

double objCoef_
 
int size_
 
int * indices_
 
double * values_
 

Additional Inherited Members

- Protected Attributes inherited from BcpsObject
int objectIndex_
 Global index of this object. More...
 
BcpsObjRep_t repType_
 Core, indexed, or algorithmic. More...
 
BcpsIntegral_t intType_
 The integrality type of the object, i.e., what values it can take up between the specified bounds. More...
 
BcpsValidRegion validRegion_
 Valid in the whole tree or only the subtree rooted at the node that generate this object. More...
 
int status_
 The status of the object. More...
 
double lbHard_
 The lower bound of the object when it was first created. More...
 
double ubHard_
 The upper bound of the object when it was first created. More...
 
double lbSoft_
 The current lower bound of the object. More...
 
double ubSoft_
 The current upper bound of the object. More...
 
double hashValue_
 The hash value of this object. More...
 
int numInactive_
 Number of inactive when in formulation. More...
 
double effectiveness_
 Effectiveness: nonnegative value. More...
 
- Protected Attributes inherited from AlpsKnowledge
KnowledgeType type_
 

Detailed Description

Definition at line 31 of file BlisVariable.h.

Constructor & Destructor Documentation

BlisVariable::BlisVariable ( )
inline

Definition at line 42 of file BlisVariable.h.

BlisVariable::BlisVariable ( double  obj,
int  s,
const int *  ind,
const double *  val 
)
inline

Definition at line 44 of file BlisVariable.h.

BlisVariable::BlisVariable ( double  lbh,
double  ubh,
double  lbs,
double  ubs 
)
inline

Definition at line 54 of file BlisVariable.h.

BlisVariable::BlisVariable ( double  lbh,
double  ubh,
double  lbs,
double  ubs,
double  obj,
int  s,
const int *  ind,
const double *  val 
)
inline

Definition at line 61 of file BlisVariable.h.

virtual BlisVariable::~BlisVariable ( )
inlinevirtual

Definition at line 74 of file BlisVariable.h.

BlisVariable::BlisVariable ( )
inline

Definition at line 42 of file BlisVariable.h.

BlisVariable::BlisVariable ( double  obj,
int  s,
const int *  ind,
const double *  val 
)
inline

Definition at line 44 of file BlisVariable.h.

BlisVariable::BlisVariable ( double  lbh,
double  ubh,
double  lbs,
double  ubs 
)
inline

Definition at line 54 of file BlisVariable.h.

BlisVariable::BlisVariable ( double  lbh,
double  ubh,
double  lbs,
double  ubs,
double  obj,
int  s,
const int *  ind,
const double *  val 
)
inline

Definition at line 61 of file BlisVariable.h.

virtual BlisVariable::~BlisVariable ( )
inlinevirtual

Definition at line 74 of file BlisVariable.h.

Member Function Documentation

int BlisVariable::getSize ( ) const
inline

Return data.

Definition at line 83 of file BlisVariable.h.

int* BlisVariable::getIndices ( ) const
inline

Return data.

Definition at line 84 of file BlisVariable.h.

double* BlisVariable::getValues ( )
inline

Return data.

Definition at line 85 of file BlisVariable.h.

void BlisVariable::setData ( int  s,
const int *  ind,
const double *  val 
)
inline

Set data.

Definition at line 90 of file BlisVariable.h.

AlpsReturnStatus BlisVariable::encodeBlis ( AlpsEncoded encoded)
inlineprotected

Pack Blis part into an encoded object.

Definition at line 106 of file BlisVariable.h.

AlpsReturnStatus BlisVariable::decodeBlis ( AlpsEncoded encoded)
inlineprotected

Unpack Blis part from a encode object.

Definition at line 117 of file BlisVariable.h.

virtual AlpsReturnStatus BlisVariable::encode ( AlpsEncoded encoded)
inlinevirtual

Pack to a encode object.

Reimplemented from BcpsObject.

Reimplemented in VrpVariable.

Definition at line 130 of file BlisVariable.h.

virtual AlpsKnowledge* BlisVariable::decode ( AlpsEncoded encoded) const
inlinevirtual

Decode a variable from an encoded object.

Reimplemented from BcpsObject.

Reimplemented in VrpVariable.

Definition at line 140 of file BlisVariable.h.

double BlisVariable::getObjCoef ( )
inline

Return data.

Definition at line 81 of file BlisVariable.h.

int BlisVariable::getSize ( ) const
inline

Return data.

Definition at line 82 of file BlisVariable.h.

int* BlisVariable::getIndices ( ) const
inline

Return data.

Definition at line 83 of file BlisVariable.h.

double* BlisVariable::getValues ( )
inline

Return data.

Definition at line 84 of file BlisVariable.h.

void BlisVariable::setData ( int  s,
const int *  ind,
const double *  val 
)
inline

Set data.

Definition at line 89 of file BlisVariable.h.

void BlisVariable::setObjCoef ( double  coef)
inline

Set data.

Definition at line 100 of file BlisVariable.h.

AlpsReturnStatus BlisVariable::encodeBlis ( AlpsEncoded encoded)
inlineprotected

Pack Blis part into an encoded object.

Definition at line 106 of file BlisVariable.h.

AlpsReturnStatus BlisVariable::decodeBlis ( AlpsEncoded encoded)
inlineprotected

Unpack Blis part from a encode object.

Definition at line 119 of file BlisVariable.h.

virtual AlpsReturnStatus BlisVariable::encode ( AlpsEncoded encoded)
inlinevirtual

Pack to a encode object.

Reimplemented from BcpsObject.

Reimplemented in VrpVariable.

Definition at line 135 of file BlisVariable.h.

virtual AlpsKnowledge* BlisVariable::decode ( AlpsEncoded encoded) const
inlinevirtual

Decode a variable from an encoded object.

Reimplemented from BcpsObject.

Reimplemented in VrpVariable.

Definition at line 145 of file BlisVariable.h.

Member Data Documentation

double BlisVariable::objCoef_
private

Definition at line 35 of file BlisVariable.h.

int BlisVariable::size_
private

Definition at line 36 of file BlisVariable.h.

int * BlisVariable::indices_
private

Definition at line 37 of file BlisVariable.h.

double * BlisVariable::values_
private

Definition at line 38 of file BlisVariable.h.


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