coin-Bcp
List of all members
BCP_var_core Class Reference

Core variables are the variables that always stay in the LP formulation. More...

#include <BCP_var.hpp>

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

Public Member Functions

Constructors and destructor
 BCP_var_core (const BCP_var_core &x)
 The copy constructor makes a replica of the argument. More...
 
 BCP_var_core (const BCP_var_t var_type, const double obj, const double lb, const double ub)
 This constructor just sets the data members to the given values. More...
 
 ~BCP_var_core ()
 The destructor deletes the object. More...
 
Query methods
BCP_object_t obj_type () const
 Return BCP_CoreObj indicating that the object is a core variable. More...
 
- Public Member Functions inherited from BCP_var
 BCP_var (const BCP_var_t var_type, const double obj, const double lb, const double ub)
 The constructor sets the internal index of the variable to zero and the other data members to the given arguments. More...
 
virtual ~BCP_var ()
 The destructor is virtual so that the appropriate destructor is invoked for every variable. More...
 
BCP_var_t var_type () const
 Return the integrality type of the variable. More...
 
double obj () const
 Return the objective coefficient. More...
 
double lb () const
 Return the lower bound. More...
 
double ub () const
 Return the upper bound. More...
 
int bcpind () const
 Return the internal index of the variable. More...
 
BCP_obj_status status () const
 Return the status of the variable. More...
 
bool dont_send_to_pool () const
 Return whether the variable should be sent to the Variable Pool process. More...
 
bool is_fixed () const
 Return whether the variable is fixed or not. More...
 
bool is_fixed_to_zero () const
 Return whether the variable is fixed to zero or not. More...
 
bool is_non_removable () const
 Return whether the variable is marked NotRemovable. More...
 
bool is_removable () const
 Return whether the variable is removable from the formulation at the time of the query. More...
 
bool is_to_be_removed () const
 Return whether the variable must be removed from the formulation. More...
 
void test_inactive ()
 Test (and set) whether the var is fixed (inactive) More...
 
void set_var_type (const BCP_var_t type)
 Set the integrality type of the variable. More...
 
void set_obj (const double obj)
 Set the objective coefficient. More...
 
void set_lb (const double lb)
 Set the lower bound. More...
 
void set_ub (const double ub)
 Set the upper bound. More...
 
void set_lb_ub (const double lb, const double ub)
 Set both lower and upper bounds. More...
 
void change_lb_ub_st (const BCP_obj_change &change)
 Set the lower/upper bounds and the status of the variable simultaneously to the values given in the data members of the argument. More...
 
void change_bounds (const double lb, const double ub)
 Change the lower and upper bounds to the given values. More...
 
void set_bcpind (const int bcpind)
 Set the internal index of the variable. More...
 
void set_bcpind_flip ()
 Flip the internal index of the variable to its negative. More...
 
void set_status (const BCP_obj_status status)
 Set the status of the variable. More...
 
void dont_send_to_pool (bool flag)
 Set/unset the flag controlling whether the variable could be sent to the Variable Pool process. More...
 
void make_active ()
 Mark the variable as active. More...
 
void make_non_removable ()
 Mark the variable as NotRemovable. More...
 
void make_to_be_removed ()
 Mark the variable as ToBeRemoved. More...
 
void display (const double val) const
 Display the object type, internal index, and the value given in the argument. More...
 
- Public Member Functions inherited from Coin::ReferencedObject
 ReferencedObject ()
 
virtual ~ReferencedObject ()
 
int ReferenceCount () const
 
void AddRef () const
 
void ReleaseRef () const
 

Private Member Functions

Disabled methods
 BCP_var_core ()
 The default constructor is declared but not defined to disable it. More...
 
BCP_var_coreoperator= (const BCP_var_core &)
 The assignment operator is declared but not defined to disable it. More...
 

Additional Inherited Members

- Protected Attributes inherited from BCP_var
BCP_var_t _var_type
 The integrality type of the variable. More...
 
double _obj
 The objective coefficient. More...
 
double _lb
 Lower bound on the value the variable can take. More...
 
double _ub
 Upper bound on the value the variable can take. More...
 

Detailed Description

Core variables are the variables that always stay in the LP formulation.

Therefore the data members in the base class are quite sufficient to describe the variable. The only thing that has to be done here is overriding the pure virtual method obj_type().

Definition at line 230 of file BCP_var.hpp.

Constructor & Destructor Documentation

BCP_var_core::BCP_var_core ( )
private

The default constructor is declared but not defined to disable it.

BCP_var_core::BCP_var_core ( const BCP_var_core x)
inline

The copy constructor makes a replica of the argument.

Definition at line 244 of file BCP_var.hpp.

References BCP_var::bcpind(), BCP_var::set_bcpind(), BCP_var::set_status(), and BCP_var::status().

BCP_var_core::BCP_var_core ( const BCP_var_t  var_type,
const double  obj,
const double  lb,
const double  ub 
)
inline

This constructor just sets the data members to the given values.

See also the constructor BCP_var.

Definition at line 251 of file BCP_var.hpp.

BCP_var_core::~BCP_var_core ( )
inline

The destructor deletes the object.

Definition at line 255 of file BCP_var.hpp.

Member Function Documentation

BCP_var_core& BCP_var_core::operator= ( const BCP_var_core )
private

The assignment operator is declared but not defined to disable it.

BCP_object_t BCP_var_core::obj_type ( ) const
inlinevirtual

Return BCP_CoreObj indicating that the object is a core variable.

Implements BCP_var.

Definition at line 261 of file BCP_var.hpp.

References BCP_CoreObj.


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