This class is the central class of the Cut Generator process. More...
#include <BCP_cg.hpp>
Public Member Functions | |
| BCP_var * | unpack_var () |
| Unpack a variable. More... | |
| virtual BCP_buffer & | get_message_buffer () |
| virtual void | process_message () |
Constructor and destructor | |
| BCP_cg_prob (int my_id, int parent) | |
| The default constructor. More... | |
| virtual | ~BCP_cg_prob () |
| The destructor deletes everything. More... | |
Query methods | |
| bool | has_ub () const |
| Return true/false indicating whether any upper bound has been found. More... | |
| double | ub () const |
Return the current upper bound (BCP_DBL_MAX if there's no upper bound found yet.) More... | |
Modifying methods | |
| void | ub (const double bd) |
| Set the upper bound equal to the argument. More... | |
| bool | probe_messages () |
| Test if there is a message in the message queue waiting to be processed. More... | |
 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_cg_user * | user |
| The user object holding the user's data. More... | |
| BCP_user_pack * | packer |
| A class that holds the methods about how to pack things. More... | |
| BCP_message_environment * | msg_env |
| The message passing environment. More... | |
| BCP_buffer | msg_buf |
| The message buffer of the Cut Generator process. More... | |
| BCP_parameter_set< BCP_cg_par > | par |
| The parameters controlling the Cut Generator process. More... | |
| BCP_problem_core * | core |
| The description of the core of the problem. More... | |
| double | upper_bound |
| The proc id of the tree manager. More... | |
| BCP_vec< BCP_var * > | vars |
| Cuts are to be generated for the LP solution given by these variables and their values (next member). More... | |
| BCP_vec< double > | x |
| The primal values corresponding to the variables above. More... | |
| int | sender |
| The process id of the LP process that sent the solution. More... | |
| int | phase |
| The phase the algorithm is in. More... | |
| int | node_level |
| The level of search tree node where the solution was generated. More... | |
| int | node_index |
| The index of search tree node where the solution was generated. More... | |
| int | node_iteration |
| The iteration within the search tree node where the solution was generated. More... | |
Private Member Functions | |
Disabled members | |
| BCP_cg_prob (const BCP_cg_prob &) | |
| The copy constructor is declared but not defined to disable it. More... | |
| BCP_cg_prob & | operator= (const BCP_cg_prob &) |
| The assignment operator is declared but not defined to disable it. More... | |
Detailed Description
This class is the central class of the Cut Generator process.
Only one object of this type is created and that holds all the data in the CG process. A reference to that object is passed to (almost) every function (or member method) that's invoked within the CG process.
Definition at line 32 of file BCP_cg.hpp.
Constructor & Destructor Documentation
|
private |
The copy constructor is declared but not defined to disable it.
| BCP_cg_prob::BCP_cg_prob | ( | int | my_id, |
| int | parent | ||
| ) |
The default constructor.
Initializes every data member to a natural state.
|
virtual |
The destructor deletes everything.
Member Function Documentation
|
private |
The assignment operator is declared but not defined to disable it.
|
inline |
Return true/false indicating whether any upper bound has been found.
Definition at line 115 of file BCP_cg.hpp.
References BCP_DBL_MAX, and upper_bound.
|
inline |
Return the current upper bound (BCP_DBL_MAX if there's no upper bound found yet.)
Definition at line 118 of file BCP_cg.hpp.
References upper_bound.
|
inline |
Set the upper bound equal to the argument.
Definition at line 124 of file BCP_cg.hpp.
References upper_bound.
| bool BCP_cg_prob::probe_messages | ( | ) |
Test if there is a message in the message queue waiting to be processed.
| BCP_var* BCP_cg_prob::unpack_var | ( | ) |
Unpack a variable.
Invoked from the built-in BCP_cg_user::unpack_primal_solution().
|
inlinevirtual |
|
virtual |
Implements BCP_process.
Member Data Documentation
| BCP_cg_user* BCP_cg_prob::user |
The user object holding the user's data.
This object is created by a call to the appropriate member of [USER_initialize]{USER_initialize.html}.
Definition at line 50 of file BCP_cg.hpp.
| BCP_user_pack* BCP_cg_prob::packer |
A class that holds the methods about how to pack things.
Definition at line 53 of file BCP_cg.hpp.
| BCP_message_environment* BCP_cg_prob::msg_env |
The message passing environment.
This object is created by a call to the appropriate member of [USER_initialize]{USER_initialize.html}.
Definition at line 58 of file BCP_cg.hpp.
| BCP_buffer BCP_cg_prob::msg_buf |
The message buffer of the Cut Generator process.
Definition at line 61 of file BCP_cg.hpp.
Referenced by get_message_buffer().
| BCP_parameter_set<BCP_cg_par> BCP_cg_prob::par |
The parameters controlling the Cut Generator process.
Definition at line 64 of file BCP_cg.hpp.
| BCP_problem_core* BCP_cg_prob::core |
The description of the core of the problem.
Definition at line 67 of file BCP_cg.hpp.
| double BCP_cg_prob::upper_bound |
The proc id of the tree manager.
The best currently known upper bound.
Definition at line 73 of file BCP_cg.hpp.
Cuts are to be generated for the LP solution given by these variables and their values (next member).
Not all variables need to be listed (e.g., list only those that have fractional values in current LP solution).
Definition at line 83 of file BCP_cg.hpp.
| BCP_vec<double> BCP_cg_prob::x |
The primal values corresponding to the variables above.
Definition at line 85 of file BCP_cg.hpp.
| int BCP_cg_prob::sender |
The process id of the LP process that sent the solution.
Definition at line 87 of file BCP_cg.hpp.
| int BCP_cg_prob::phase |
The phase the algorithm is in.
Definition at line 91 of file BCP_cg.hpp.
| int BCP_cg_prob::node_level |
The level of search tree node where the solution was generated.
Definition at line 93 of file BCP_cg.hpp.
| int BCP_cg_prob::node_index |
The index of search tree node where the solution was generated.
Definition at line 95 of file BCP_cg.hpp.
| int BCP_cg_prob::node_iteration |
The iteration within the search tree node where the solution was generated.
Definition at line 98 of file BCP_cg.hpp.
The documentation for this class was generated from the following file:
- /tmp/Bcp-1.4.4/Bcp/src/include/BCP_cg.hpp
