The BCP_tm_user class is the base class from which the user can derive a problem specific class to be used in the TM process. More...
#include <BCP_tm_user.hpp>
Public Member Functions | |
| int | process_id () const |
| What is the process id of the current process. More... | |
| void | send_message (const int target, const BCP_buffer &buf) |
| Send a message to a particular process. More... | |
| void | broadcast_message (const BCP_process_t proc_type, const BCP_buffer &buf) |
| Broadcast the message to all processes of the given type. More... | |
| virtual void | process_message (BCP_buffer &buf) |
| Process a message that has been sent by another process' user part to this process' user part. More... | |
| virtual void | display_feasible_solution (const BCP_solution *sol) |
| Display a feasible solution. More... | |
| virtual void | display_node_information (BCP_tree &search_tree, const BCP_tm_node &node) |
| Display user information just before a new node is sent to the LP or diving into a node is acknowledged. More... | |
| virtual void | display_node_information (BCP_tree &search_tree, const BCP_tm_node &node, bool after_processing_node) |
| Display user information. More... | |
| virtual void | display_final_information (const BCP_lp_statistics &lp_stat) |
| Display information after BCP finished processing the search tree. More... | |
Methods to set and get the pointer to the BCP_tm_prob | |
object. It is unlikely that the users would want to muck around with these (especially with the set method!) but they are here to provide total control. | |
| void | setTmProblemPointer (BCP_tm_prob *ptr) |
| Set the pointer. More... | |
| BCP_tm_prob * | getTmProblemPointer () const |
| Get the pointer. More... | |
Informational methods for the user. | |
| double | upper_bound () const |
| Return what is the best known upper bound (might be BCP_DBL_MAX) More... | |
| double | lower_bound () const |
| Return a global lower bound. More... | |
Methods to get/set BCP parameters on the fly | |
| char | get_param (const BCP_tm_par::chr_params key) const |
| int | get_param (const BCP_tm_par::int_params key) const |
| double | get_param (const BCP_tm_par::dbl_params key) const |
| const BCP_string & | get_param (const BCP_tm_par::str_params key) const |
| void | set_param (const BCP_tm_par::chr_params key, const bool val) |
| void | set_param (const BCP_tm_par::chr_params key, const char val) |
| void | set_param (const BCP_tm_par::int_params key, const int val) |
| void | set_param (const BCP_tm_par::dbl_params key, const double val) |
| void | set_param (const BCP_tm_par::str_params key, const char *val) |
Constructor, Destructor | |
| BCP_tm_user () | |
| Being virtual, the destructor invokes the destructor for the real type of the object being deleted. More... | |
| virtual | ~BCP_tm_user () |
| Being virtual, the destructor invokes the destructor for the real type of the object being deleted. More... | |
Packing and unpacking methods | |
| virtual void | pack_module_data (BCP_buffer &buf, BCP_process_t ptype) |
| Pack the initial information (info that the user wants to send over) for the process specified by the last argument. More... | |
| virtual BCP_solution * | unpack_feasible_solution (BCP_buffer &buf) |
| Unpack a MIP feasible solution that was packed by the BCP_lp_user::pack_feasible_solution() method. More... | |
| virtual bool | replace_solution (const BCP_solution *old_sol, const BCP_solution *new_sol) |
| Decide whether to replace old_sol with new_sol. More... | |
Initial setup (creating core and root) | |
| virtual void | initialize_core (BCP_vec< BCP_var_core * > &vars, BCP_vec< BCP_cut_core * > &cuts, BCP_lp_relax *&matrix) |
| Create the core of the problem by filling out the last three arguments. More... | |
| virtual void | create_root (BCP_vec< BCP_var * > &added_vars, BCP_vec< BCP_cut * > &added_cuts, BCP_user_data *&user_data) |
| Create the set of extra variables and cuts that should be added to the formulation in the root node. More... | |
Initialize new phase | |
| virtual void | init_new_phase (int phase, BCP_column_generation &colgen, CoinSearchTreeBase *&candidates) |
Do whatever initialization is necessary before the phase-th phase. More... | |
If desired, change the tree (the candidate list) in the search | |
tree manager using the setTree() method. This method is invoked after every insertion into the candidate list and also whenever a new solution is found. In the latter case The default invokes the newSolution() and the reevaluateSearchStrategy() methods from CoinSearchTreeManager. | |
| virtual void | change_candidate_heap (CoinSearchTreeManager &candidates, const bool new_solution) |
 Public Member Functions inherited from BCP_user_class | |
| virtual | ~BCP_user_class () |
Private Attributes | |
| BCP_tm_prob * | p |
Detailed Description
The BCP_tm_user class is the base class from which the user can derive a problem specific class to be used in the TM process.
In that derived class the user can store data to be used in the methods she overrides. Also that is the object the user must return in the USER_initialize::tm_init() method.
There are two kind of methods in the class. The non-virtual methods are helper functions for the built-in defaults, but the user can use them as well. The virtual methods execute steps in the BCP algorithm where the user might want to override the default behavior.
The default implementations fall into three major categories.
- Empty; doesn't do anything and immediately returns. (E.g., pack_module_data().
- There is no reasonable default, so throw an exception. This happens if the parameter settings drive the flow of in a way that BCP can't perform the necessary function. This behavior is correct since such methods are invoked only if the parameter settings drive the flow of the algorithm that way, in which case the user better implement those methods. (At the momemnt there is no such method in TM.)
- A default is given. Frequently there are multiple defaults and parameters govern which one is selected (e.g., compare_tree_nodes()).
Definition at line 58 of file BCP_tm_user.hpp.
Constructor & Destructor Documentation
|
inline |
Being virtual, the destructor invokes the destructor for the real type of the object being deleted.
Definition at line 110 of file BCP_tm_user.hpp.
|
inlinevirtual |
Being virtual, the destructor invokes the destructor for the real type of the object being deleted.
Definition at line 113 of file BCP_tm_user.hpp.
Member Function Documentation
|
inline |
Set the pointer.
Definition at line 69 of file BCP_tm_user.hpp.
|
inline |
| double BCP_tm_user::upper_bound | ( | ) | const |
Return what is the best known upper bound (might be BCP_DBL_MAX)
| double BCP_tm_user::lower_bound | ( | ) | const |
Return a global lower bound.
This value is the minimum of the true lower bounds in the candidate list and the true lower bounds of the nodes currently processed
| char BCP_tm_user::get_param | ( | const BCP_tm_par::chr_params | key | ) | const |
| int BCP_tm_user::get_param | ( | const BCP_tm_par::int_params | key | ) | const |
| double BCP_tm_user::get_param | ( | const BCP_tm_par::dbl_params | key | ) | const |
| const BCP_string& BCP_tm_user::get_param | ( | const BCP_tm_par::str_params | key | ) | const |
| void BCP_tm_user::set_param | ( | const BCP_tm_par::chr_params | key, |
| const bool | val | ||
| ) |
| void BCP_tm_user::set_param | ( | const BCP_tm_par::chr_params | key, |
| const char | val | ||
| ) |
| void BCP_tm_user::set_param | ( | const BCP_tm_par::int_params | key, |
| const int | val | ||
| ) |
| void BCP_tm_user::set_param | ( | const BCP_tm_par::dbl_params | key, |
| const double | val | ||
| ) |
| void BCP_tm_user::set_param | ( | const BCP_tm_par::str_params | key, |
| const char * | val | ||
| ) |
|
virtual |
Pack the initial information (info that the user wants to send over) for the process specified by the last argument.
The information packed here will be unpacked in the unpack_module_data() method of the user defined class in the appropriate process.
Default: empty method.
Reimplemented in CSP_tm, MCF3_tm, BB_tm, MKC_tm, MCF1_tm, MCF2_tm, MC_tm, and MC_tm.
|
virtual |
Unpack a MIP feasible solution that was packed by the BCP_lp_user::pack_feasible_solution() method.
Default: Unpacks a BCP_solution_generic object. The built-in default should be used if and only if the built-in default was used in BCP_lp_user::pack_feasible_solution().
Reimplemented in CSP_tm, MKC_tm, MC_tm, and MC_tm.
Referenced by CSP_tm::unpack_feasible_solution().
|
virtual |
Decide whether to replace old_sol with new_sol.
When this method is invoked it has already been tested that they have the same objective function value. The purpose of the method is that the user can have a secondary objective function.
| int BCP_tm_user::process_id | ( | ) | const |
What is the process id of the current process.
| void BCP_tm_user::send_message | ( | const int | target, |
| const BCP_buffer & | buf | ||
| ) |
Send a message to a particular process.
| void BCP_tm_user::broadcast_message | ( | const BCP_process_t | proc_type, |
| const BCP_buffer & | buf | ||
| ) |
Broadcast the message to all processes of the given type.
|
virtual |
Process a message that has been sent by another process' user part to this process' user part.
|
virtual |
Create the core of the problem by filling out the last three arguments.
These variables/cuts will always stay in the LP relaxation and the corresponding matrix is described by the specified matrix. If there is no core variable or cut then the returned pointer for to the matrix should be a null pointer.
Default: empty method, meaning that there are no variables/cuts in the core and this the core matrix is empty (0 pointer) as well.
Reimplemented in CSP_tm, MKC_tm, MC_tm, MCF3_tm, BB_tm, MC_tm, MCF1_tm, and MCF2_tm.
|
virtual |
Create the set of extra variables and cuts that should be added to the formulation in the root node.
Also decide how variable pricing shuld be done, that is, if column generation is requested in the init_new_phase() method of this class then column generation should be performed according to pricing_status.
Default: empty method, meaning that no variables/cuts are added, there is no user data and no pricing should be done.
Reimplemented in MCF3_tm, BB_tm, MC_tm, MCF1_tm, and MCF2_tm.
|
virtual |
|
virtual |
Display user information just before a new node is sent to the LP or diving into a node is acknowledged.
This method is deprecated in favor of the one with 3 args.
|
virtual |
Display user information.
This method is called just before a node is sent ot for processing (or diving into the node is acknowledged) and just after a node description has been received.
|
virtual |
Display information after BCP finished processing the search tree.
|
virtual |
|
virtual |
Member Data Documentation
|
mutableprivate |
Definition at line 60 of file BCP_tm_user.hpp.
Referenced by getTmProblemPointer().
The documentation for this class was generated from the following file:
- /tmp/Bcp-1.4.4/Bcp/src/include/BCP_tm_user.hpp
