Bcp 1.4.4
Loading...
Searching...
No Matches
List of all members
BCP_tm_user Class Reference

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>

+ Inheritance diagram for BCP_tm_user:
+ Collaboration diagram for BCP_tm_user:

Public Member Functions

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.
 
BCP_tm_probgetTmProblemPointer () const
 Get the pointer.
 
Informational methods for the user.
double upper_bound () const
 Return what is the best known upper bound (might be BCP_DBL_MAX)
 
double lower_bound () const
 Return a global lower bound.
 
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_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)
 
Constructor, Destructor
 BCP_tm_user ()
 
virtual ~BCP_tm_user ()
 Being virtual, the destructor invokes the destructor for the real type of the object being deleted.
 
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.
 
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.
 
virtual bool replace_solution (const BCP_solution *old_sol, const BCP_solution *new_sol)
 Decide whether to replace old_sol with new_sol.
 
int process_id () const
 What is the process id of the current process.
 
void send_message (const int target, const BCP_buffer &buf)
 Send a message to a particular process.
 
void broadcast_message (const BCP_process_t proc_type, const BCP_buffer &buf)
 Broadcast the message to all processes of the given type.
 
virtual void process_message (BCP_buffer &buf)
 Process a message that has been sent by another process' user part to this process' user part.
 
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.
 
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.
 
virtual void display_feasible_solution (const BCP_solution *sol)
 Display a feasible solution.
 
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.
 
virtual void display_node_information (BCP_tree &search_tree, const BCP_tm_node &node, bool after_processing_node)
 Display user information.
 
virtual void display_final_information (const BCP_lp_statistics &lp_stat)
 Display information after BCP finished processing the search tree.
 
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.
 
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 new_solution is true.

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 ()
 

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.

Definition at line 58 of file BCP_tm_user.hpp.

Constructor & Destructor Documentation

◆ BCP_tm_user()

BCP_tm_user::BCP_tm_user ( )
inline

Definition at line 110 of file BCP_tm_user.hpp.

◆ ~BCP_tm_user()

virtual BCP_tm_user::~BCP_tm_user ( )
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

◆ setTmProblemPointer()

void BCP_tm_user::setTmProblemPointer ( BCP_tm_prob * ptr)
inline

Set the pointer.

Definition at line 69 of file BCP_tm_user.hpp.

◆ getTmProblemPointer()

BCP_tm_prob * BCP_tm_user::getTmProblemPointer ( ) const
inline

Get the pointer.

Definition at line 71 of file BCP_tm_user.hpp.

◆ upper_bound()

double BCP_tm_user::upper_bound ( ) const

Return what is the best known upper bound (might be BCP_DBL_MAX)

◆ lower_bound()

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

◆ get_param() [1/4]

char BCP_tm_user::get_param ( const BCP_tm_par::chr_params key) const

◆ get_param() [2/4]

int BCP_tm_user::get_param ( const BCP_tm_par::int_params key) const

◆ get_param() [3/4]

double BCP_tm_user::get_param ( const BCP_tm_par::dbl_params key) const

◆ get_param() [4/4]

const BCP_string & BCP_tm_user::get_param ( const BCP_tm_par::str_params key) const

◆ set_param() [1/5]

void BCP_tm_user::set_param ( const BCP_tm_par::chr_params key,
const bool val )

◆ set_param() [2/5]

void BCP_tm_user::set_param ( const BCP_tm_par::chr_params key,
const char val )

◆ set_param() [3/5]

void BCP_tm_user::set_param ( const BCP_tm_par::int_params key,
const int val )

◆ set_param() [4/5]

void BCP_tm_user::set_param ( const BCP_tm_par::dbl_params key,
const double val )

◆ set_param() [5/5]

void BCP_tm_user::set_param ( const BCP_tm_par::str_params key,
const char * val )

◆ pack_module_data()

virtual void BCP_tm_user::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.

◆ unpack_feasible_solution()

virtual BCP_solution * BCP_tm_user::unpack_feasible_solution ( BCP_buffer & buf)
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().

◆ replace_solution()

virtual bool BCP_tm_user::replace_solution ( const BCP_solution * old_sol,
const BCP_solution * new_sol )
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.

◆ process_id()

int BCP_tm_user::process_id ( ) const

What is the process id of the current process.

◆ send_message()

void BCP_tm_user::send_message ( const int target,
const BCP_buffer & buf )

Send a message to a particular process.

◆ broadcast_message()

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.

◆ process_message()

virtual void BCP_tm_user::process_message ( BCP_buffer & buf)
virtual

Process a message that has been sent by another process' user part to this process' user part.

◆ initialize_core()

virtual void BCP_tm_user::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.

◆ create_root()

virtual void BCP_tm_user::create_root ( BCP_vec< BCP_var * > & added_vars,
BCP_vec< BCP_cut * > & added_cuts,
BCP_user_data *& user_data )
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.

◆ display_feasible_solution()

virtual void BCP_tm_user::display_feasible_solution ( const BCP_solution * sol)
virtual

Display a feasible solution.

◆ display_node_information() [1/2]

virtual void BCP_tm_user::display_node_information ( BCP_tree & search_tree,
const BCP_tm_node & node )
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.

◆ display_node_information() [2/2]

virtual void BCP_tm_user::display_node_information ( BCP_tree & search_tree,
const BCP_tm_node & node,
bool after_processing_node )
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.

◆ display_final_information()

virtual void BCP_tm_user::display_final_information ( const BCP_lp_statistics & lp_stat)
virtual

Display information after BCP finished processing the search tree.

◆ init_new_phase()

virtual void BCP_tm_user::init_new_phase ( int phase,
BCP_column_generation & colgen,
CoinSearchTreeBase *& candidates )
virtual

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

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

◆ change_candidate_heap()

virtual void BCP_tm_user::change_candidate_heap ( CoinSearchTreeManager & candidates,
const bool new_solution )
virtual

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