BCP_vg_prob Class Reference
This class is the central class of the Variable Generator process. More...
#include <BCP_vg.hpp>
Public Member Functions | |
| BCP_cut * | unpack_cut () |
| Unpack a cut. | |
| virtual BCP_buffer & | get_message_buffer () |
| virtual void | process_message () |
Constructor and destructor | |
| BCP_vg_prob (BCP_proc_id *my_id, BCP_proc_id *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. | |
Public Attributes | |
Data members | |
| BCP_vg_user * | user |
| The user object holding the user's data. | |
| BCP_message_environment * | msg_env |
| The message passing environment. | |
| BCP_buffer | msg_buf |
| The message buffer of the Variable Generator process. | |
| BCP_parameter_set< BCP_vg_par > | par |
| The parameters controlling the Variable Generator process. | |
| BCP_problem_core * | core |
| 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. | |
| BCP_proc_id * | 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. | |
Private Member Functions | |
Disabled members | |
| BCP_vg_prob (const BCP_vg_prob &) | |
| The copy constructor is declared but not defined to disable it. | |
| BCP_vg_prob & | operator= (const BCP_vg_prob &) |
| The assignment operator is declared but not defined to disable it. | |
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 | ( | const BCP_vg_prob & | ) | [private] |
The copy constructor is declared but not defined to disable it.
| BCP_vg_prob::BCP_vg_prob | ( | BCP_proc_id * | my_id, | |
| BCP_proc_id * | parent | |||
| ) |
The default constructor.
Initializes every data member to a natural state.
| virtual BCP_vg_prob::~BCP_vg_prob | ( | ) | [virtual] |
The destructor deletes everything.
Member Function Documentation
| BCP_vg_prob& BCP_vg_prob::operator= | ( | const BCP_vg_prob & | ) | [private] |
The assignment operator is declared but not defined to disable it.
Reimplemented from BCP_process.
| bool BCP_vg_prob::has_ub | ( | ) | const [inline] |
Return true/false indicating whether any upper bound has been found.
Definition at line 109 of file BCP_vg.hpp.
| 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 112 of file BCP_vg.hpp.
| void BCP_vg_prob::ub | ( | const double | bd | ) | [inline] |
Set the upper bound equal to the argument.
Definition at line 118 of file BCP_vg.hpp.
| bool BCP_vg_prob::probe_messages | ( | ) |
Test if there is a message in the message queue waiting to be processed.
| BCP_cut* BCP_vg_prob::unpack_cut | ( | ) |
Unpack a cut.
Invoked from the built-in BCP_vg_user::unpack_dual_solution().
| virtual BCP_buffer& BCP_vg_prob::get_message_buffer | ( | ) | [inline, virtual] |
Implements BCP_process.
Definition at line 129 of file BCP_vg.hpp.
| virtual void BCP_vg_prob::process_message | ( | ) | [virtual] |
Implements BCP_process.
Member Data Documentation
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 49 of file BCP_vg.hpp.
The message passing environment.
This object is created by a call to the appropriate member of [USER_initialize]{USER_initialize.html}.
Definition at line 53 of file BCP_vg.hpp.
The message buffer of the Variable Generator process.
Definition at line 56 of file BCP_vg.hpp.
The parameters controlling the Variable Generator process.
Definition at line 59 of file BCP_vg.hpp.
The description of the core of the problem.
Definition at line 62 of file BCP_vg.hpp.
| double BCP_vg_prob::upper_bound |
The proc id of the Tree Manager.
The best currently known upper bound.
Definition at line 68 of file BCP_vg.hpp.
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 78 of file BCP_vg.hpp.
| BCP_vec<double> BCP_vg_prob::pi |
The dual values corresponding to the cuts above.
Definition at line 80 of file BCP_vg.hpp.
The process id of the LP process that sent the solution.
Definition at line 82 of file BCP_vg.hpp.
The phase the algorithm is in.
Definition at line 85 of file BCP_vg.hpp.
The level of search tree node where the solution was generated.
Definition at line 87 of file BCP_vg.hpp.
The index of search tree node where the solution was generated.
Definition at line 89 of file BCP_vg.hpp.
The iteration within the search tree node where the solution was generated.
Definition at line 92 of file BCP_vg.hpp.
The documentation for this class was generated from the following file:
- /home/coin/svn-release/OptimizationSuite-1.1.0/Bcp/src/include/BCP_vg.hpp
