coin-Bcp
Public Member Functions | Public Attributes | List of all members
CSP_tm Class Reference

#include <CSP_tm.hpp>

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

Public Member Functions

 CSP_tm ()
 
 ~CSP_tm ()
 
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_solutionunpack_feasible_solution (BCP_buffer &buf)
 Unpack a MIP feasible solution that was packed by the BCP_lp_user::pack_feasible_solution() method. More...
 
virtual void pack_var_algo (const BCP_var_algo *var, BCP_buffer &buf)
 Pack an algorithmic variable. More...
 
virtual BCP_var_algounpack_var_algo (BCP_buffer &buf)
 Unpack an algorithmic variable. More...
 
virtual void pack_cut_algo (const BCP_cut_algo *cut, BCP_buffer &buf)
 Pack an algorithmic cut. More...
 
virtual BCP_cut_algounpack_cut_algo (BCP_buffer &buf)
 Unpack an algorithmic cut. More...
 
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, BCP_pricing_status &pricing_status)
 Create the set of extra variables and cuts that should be added to the formulation in the root node. More...
 
virtual void display_feasible_solution (const BCP_solution *sol)
 Display a feasible solution. More...
 
virtual void init_new_phase (int phase, BCP_column_generation &colgen)
 Do whatever initialization is necessary before the phase-th phase. More...
 
Compare two search tree nodes. Return true if the first node

should be processed before the second one.

Default: The default behavior is controlled by the TreeSearchStrategy parameter which is set to 0 (BCP_BestFirstSearch) by default.

virtual bool compare_tree_nodes (const BCP_tm_node *node0, const BCP_tm_node *node1)
 
- Public Member Functions inherited from BCP_tm_user
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_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...
 
void setTmProblemPointer (BCP_tm_prob *ptr)
 Set the pointer. More...
 
BCP_tm_probgetTmProblemPointer () const
 Get the pointer. More...
 
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...
 
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_stringget_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)
 
 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...
 
virtual bool replace_solution (const BCP_solution *old_sol, const BCP_solution *new_sol)
 Decide whether to replace old_sol with new_sol. 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...
 
virtual void init_new_phase (int phase, BCP_column_generation &colgen, CoinSearchTreeBase *&candidates)
 Do whatever initialization is necessary before the phase-th phase. More...
 
virtual void change_candidate_heap (CoinSearchTreeManager &candidates, const bool new_solution)
 
- Public Member Functions inherited from BCP_user_class
virtual ~BCP_user_class ()
 

Public Attributes

BCP_parameter_set< CSP_tm_partm_par
 
BCP_parameter_set< CSP_lp_parlp_par
 
CSPROBLEMcsproblem
 

Detailed Description

Definition at line 23 of file CSP_tm.hpp.

Constructor & Destructor Documentation

CSP_tm::CSP_tm ( )
inline

Definition at line 31 of file CSP_tm.hpp.

CSP_tm::~CSP_tm ( )
inline

Definition at line 34 of file CSP_tm.hpp.

References csproblem.

Member Function Documentation

virtual void CSP_tm::pack_module_data ( BCP_buffer buf,
BCP_process_t  ptype 
)
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 from BCP_tm_user.

virtual BCP_solution* CSP_tm::unpack_feasible_solution ( BCP_buffer buf)
inlinevirtual

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 from BCP_tm_user.

Definition at line 62 of file CSP_tm.hpp.

References BCP_tm_user::unpack_feasible_solution().

virtual void CSP_tm::pack_var_algo ( const BCP_var_algo var,
BCP_buffer buf 
)
inlinevirtual

Pack an algorithmic variable.

Definition at line 69 of file CSP_tm.hpp.

References CSP_var_pack().

virtual BCP_var_algo* CSP_tm::unpack_var_algo ( BCP_buffer buf)
inlinevirtual

Unpack an algorithmic variable.

Definition at line 75 of file CSP_tm.hpp.

References CSP_var_unpack().

virtual void CSP_tm::pack_cut_algo ( const BCP_cut_algo cut,
BCP_buffer buf 
)
inlinevirtual

Pack an algorithmic cut.

Definition at line 82 of file CSP_tm.hpp.

virtual BCP_cut_algo* CSP_tm::unpack_cut_algo ( BCP_buffer buf)
inlinevirtual

Unpack an algorithmic cut.

Definition at line 88 of file CSP_tm.hpp.

virtual void CSP_tm::initialize_core ( BCP_vec< BCP_var_core * > &  vars,
BCP_vec< BCP_cut_core * > &  cuts,
BCP_lp_relax *&  matrix 
)
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 from BCP_tm_user.

virtual void CSP_tm::create_root ( BCP_vec< BCP_var * > &  added_vars,
BCP_vec< BCP_cut * > &  added_cuts,
BCP_user_data *&  user_data,
BCP_pricing_status &  pricing_status 
)
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 and no pricing should be done.

virtual void CSP_tm::display_feasible_solution ( const BCP_solution sol)
virtual

Display a feasible solution.

Reimplemented from BCP_tm_user.

virtual void CSP_tm::init_new_phase ( int  phase,
BCP_column_generation colgen 
)
virtual

Do whatever initialization is necessary before the phase-th phase.

(E.g., setting the pricing strategy.)

virtual bool CSP_tm::compare_tree_nodes ( const BCP_tm_node node0,
const BCP_tm_node node1 
)
inlinevirtual

Definition at line 147 of file CSP_tm.hpp.

Member Data Documentation

BCP_parameter_set<CSP_tm_par> CSP_tm::tm_par

Definition at line 25 of file CSP_tm.hpp.

BCP_parameter_set<CSP_lp_par> CSP_tm::lp_par

Definition at line 26 of file CSP_tm.hpp.

CSPROBLEM* CSP_tm::csproblem

Definition at line 27 of file CSP_tm.hpp.

Referenced by ~CSP_tm().


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