Bcp 1.4.4
Loading...
Searching...
No Matches
BCP_vg_prob Class Reference

This class is the central class of the Variable Generator process. More...

#include <BCP_vg.hpp>

+ Inheritance diagram for BCP_vg_prob:
+ Collaboration diagram for BCP_vg_prob:

Public Member Functions

Constructor and destructor
 BCP_vg_prob (int my_id, int parent)
 The default constructor.
 
virtual ~BCP_vg_prob ()
 The destructor deletes everything.
 
Query methods
bool has_ub () const
 Return true/false indicating whether any upper bound has been found.
 
double ub () const
 Return the current upper bound (BCP_DBL_MAX/10 if there's no upper bound found yet.)
 
Modifying methods
void ub (const double bd)
 Set the upper bound equal to the argument.
 
bool probe_messages ()
 Test if there is a message in the message queue waiting to be processed.
 
BCP_cutunpack_cut ()
 Unpack a cut.
 
virtual BCP_bufferget_message_buffer ()
 
virtual void process_message ()
 
- Public Member Functions inherited from BCP_process
 BCP_process (int self, int my_parent)
 
virtual ~BCP_process ()
 
int get_process_id () const
 
int get_parent () const
 

Public Attributes

Data members
BCP_vg_useruser
 The user object holding the user's data.
 
BCP_user_packpacker
 A class that holds the methods about how to pack things.
 
BCP_message_environmentmsg_env
 The message passing environment.
 
BCP_buffer msg_buf
 The message buffer of the Variable Generator process.
 
BCP_parameter_set< BCP_vg_parpar
 The parameters controlling the Variable Generator process.
 
BCP_problem_corecore
 The description of the core of the problem.
 
double upper_bound
 The proc id of the Tree Manager.
 
BCP_vec< BCP_cut * > cuts
 Variables are to be generated for the LP solution given by these cuts and their values (next member).
 
BCP_vec< double > pi
 The dual values corresponding to the cuts above.
 
int sender
 The process id of the LP process that sent the solution.
 
int phase
 The phase the algorithm is in.
 
int node_level
 The level of search tree node where the solution was generated.
 
int node_index
 The index of search tree node where the solution was generated.
 
int node_iteration
 The iteration within the search tree node where the solution was generated.
 

Detailed Description

This class is the central class of the Variable Generator process.

Only one object of this type is created and that holds all the data in the VG process. A reference to that object is passed to (almost) every function (or member method) that's invoked within the VG process.

Definition at line 32 of file BCP_vg.hpp.

Constructor & Destructor Documentation

◆ BCP_vg_prob()

BCP_vg_prob::BCP_vg_prob ( int my_id,
int parent )

The default constructor.

Initializes every data member to a natural state.

◆ ~BCP_vg_prob()

virtual BCP_vg_prob::~BCP_vg_prob ( )
virtual

The destructor deletes everything.

Member Function Documentation

◆ has_ub()

bool BCP_vg_prob::has_ub ( ) const
inline

Return true/false indicating whether any upper bound has been found.

Definition at line 113 of file BCP_vg.hpp.

◆ ub() [1/2]

double BCP_vg_prob::ub ( ) const
inline

Return the current upper bound (BCP_DBL_MAX/10 if there's no upper bound found yet.)

Definition at line 116 of file BCP_vg.hpp.

◆ ub() [2/2]

void BCP_vg_prob::ub ( const double bd)
inline

Set the upper bound equal to the argument.

Definition at line 122 of file BCP_vg.hpp.

◆ probe_messages()

bool BCP_vg_prob::probe_messages ( )

Test if there is a message in the message queue waiting to be processed.

◆ unpack_cut()

BCP_cut * BCP_vg_prob::unpack_cut ( )

Unpack a cut.

Invoked from the built-in BCP_vg_user::unpack_dual_solution().

◆ get_message_buffer()

virtual BCP_buffer & BCP_vg_prob::get_message_buffer ( )
inlinevirtual

Implements BCP_process.

Definition at line 133 of file BCP_vg.hpp.

◆ process_message()

virtual void BCP_vg_prob::process_message ( )
virtual

Implements BCP_process.

Member Data Documentation

◆ user

BCP_vg_user* BCP_vg_prob::user

The user object holding the user's data.

This object is created by a call to the appropriate member of \URL[USER_initialize]{USER_initialize.html}.

Definition at line 49 of file BCP_vg.hpp.

◆ packer

BCP_user_pack* BCP_vg_prob::packer

A class that holds the methods about how to pack things.

Definition at line 52 of file BCP_vg.hpp.

◆ msg_env

BCP_message_environment* BCP_vg_prob::msg_env

The message passing environment.

This object is created by a call to the appropriate member of \URL[USER_initialize]{USER_initialize.html}.

Definition at line 57 of file BCP_vg.hpp.

◆ msg_buf

BCP_buffer BCP_vg_prob::msg_buf

The message buffer of the Variable Generator process.

Definition at line 60 of file BCP_vg.hpp.

◆ par

BCP_parameter_set<BCP_vg_par> BCP_vg_prob::par

The parameters controlling the Variable Generator process.

Definition at line 63 of file BCP_vg.hpp.

◆ core

BCP_problem_core* BCP_vg_prob::core

The description of the core of the problem.

Definition at line 66 of file BCP_vg.hpp.

◆ upper_bound

double BCP_vg_prob::upper_bound

The proc id of the Tree Manager.

The best currently known upper bound.

Definition at line 72 of file BCP_vg.hpp.

◆ cuts

BCP_vec<BCP_cut*> BCP_vg_prob::cuts

Variables are to be generated for the LP solution given by these cuts and their values (next member).

Not all cuts need to be listed (e.g., list only those that have nonzero dual values in the current solution).

See also
BCP_lp_user::pack_dual_solution()

Definition at line 82 of file BCP_vg.hpp.

◆ pi

BCP_vec<double> BCP_vg_prob::pi

The dual values corresponding to the cuts above.

Definition at line 84 of file BCP_vg.hpp.

◆ sender

int BCP_vg_prob::sender

The process id of the LP process that sent the solution.

Definition at line 86 of file BCP_vg.hpp.

◆ phase

int BCP_vg_prob::phase

The phase the algorithm is in.

Definition at line 89 of file BCP_vg.hpp.

◆ node_level

int BCP_vg_prob::node_level

The level of search tree node where the solution was generated.

Definition at line 91 of file BCP_vg.hpp.

◆ node_index

int BCP_vg_prob::node_index

The index of search tree node where the solution was generated.

Definition at line 93 of file BCP_vg.hpp.

◆ node_iteration

int BCP_vg_prob::node_iteration

The iteration within the search tree node where the solution was generated.

Definition at line 96 of file BCP_vg.hpp.


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