The BCP_cg_user class is the base class from which the user can derive a problem specific class to be used in the Cut Generator process. More...

#include <BCP_cg_user.hpp>

Inheritance diagram for BCP_cg_user:

[legend]

Collaboration diagram for BCP_cg_user:

[legend]

Public Member Functions
void	send_cut (const BCP_cut &cut)
	Pack the argument into the message buffer and send it to the sender of the LP solution. More...

virtual void	unpack_module_data (BCP_buffer &buf)
	Unpack the initial information sent to the Cut Generator process by the Tree Manager. More...

virtual void	unpack_primal_solution (BCP_buffer &buf)
	Unpack the LP solution arriving from the LP process. More...

virtual void	generate_cuts (BCP_vec< BCP_var * > &vars, BCP_vec< double > &x)
	Perform the actual cut generation. More...

Methods to set and get the pointer to the BCP_cg_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	setCgProblemPointer (BCP_cg_prob *ptr)
	Set the pointer. More...

BCP_cg_prob *	getCgProblemPointer ()
	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...

int	current_phase () const
	Return the phase the algorithm is in. More...

int	current_level () const
	Return the level of the search tree node for which cuts are being generated. More...

int	current_index () const
	Return the internal index of the search tree node for which cuts are being generated. More...

int	current_iteration () const
	Return the iteration count within the search tree node for which cuts are being generated. More...

Methods to get/set BCP parameters on the fly
char	get_param (const BCP_cg_par::chr_params key) const

int	get_param (const BCP_cg_par::int_params key) const

double	get_param (const BCP_cg_par::dbl_params key) const

const BCP_string &	get_param (const BCP_cg_par::str_params key) const

void	set_param (const BCP_cg_par::chr_params key, const bool val)

void	set_param (const BCP_cg_par::chr_params key, const char val)

void	set_param (const BCP_cg_par::int_params key, const int val)

void	set_param (const BCP_cg_par::dbl_params key, const double val)

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

Constructor, Destructor
	BCP_cg_user ()
	Being virtual, the destructor invokes the destructor for the real type of the object being deleted. More...

virtual	~BCP_cg_user ()
	Being virtual, the destructor invokes the destructor for the real type of the object being deleted. More...

Public Member Functions inherited from BCP_user_class
virtual	~BCP_user_class ()

Private Attributes
BCP_cg_prob *	p

Detailed Description

The BCP_cg_user class is the base class from which the user can derive a problem specific class to be used in the Cut Generator 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::cg_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., unpack_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 CG.)
A default is given. Frequently there are multiple defaults and parameters govern which one is selected (e.g., unpack_primal_solution()).

Definition at line 50 of file BCP_cg_user.hpp.

Constructor & Destructor Documentation

BCP_cg_user::BCP_cg_user ( )

inline

Being virtual, the destructor invokes the destructor for the real type of the object being deleted.

Definition at line 115 of file BCP_cg_user.hpp.

virtual BCP_cg_user::~BCP_cg_user ( )

inlinevirtual

Being virtual, the destructor invokes the destructor for the real type of the object being deleted.

Definition at line 118 of file BCP_cg_user.hpp.

Member Function Documentation

void BCP_cg_user::setCgProblemPointer ( BCP_cg_prob * ptr )

inline

Set the pointer.

Definition at line 61 of file BCP_cg_user.hpp.

BCP_cg_prob* BCP_cg_user::getCgProblemPointer ( )

inline

Get the pointer.

Definition at line 63 of file BCP_cg_user.hpp.

References p.

double BCP_cg_user::upper_bound ( ) const

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

int BCP_cg_user::current_phase ( ) const

Return the phase the algorithm is in.

int BCP_cg_user::current_level ( ) const

Return the level of the search tree node for which cuts are being generated.

int BCP_cg_user::current_index ( ) const

Return the internal index of the search tree node for which cuts are being generated.

int BCP_cg_user::current_iteration ( ) const

Return the iteration count within the search tree node for which cuts are being generated.

char BCP_cg_user::get_param ( const BCP_cg_par::chr_params key ) const

int BCP_cg_user::get_param ( const BCP_cg_par::int_params key ) const

double BCP_cg_user::get_param ( const BCP_cg_par::dbl_params key ) const

const BCP_string& BCP_cg_user::get_param ( const BCP_cg_par::str_params key ) const

void BCP_cg_user::set_param	(	const BCP_cg_par::chr_params	key,
		const bool	val
	)

void BCP_cg_user::set_param	(	const BCP_cg_par::chr_params	key,
		const char	val
	)

void BCP_cg_user::set_param	(	const BCP_cg_par::int_params	key,
		const int	val
	)

void BCP_cg_user::set_param	(	const BCP_cg_par::dbl_params	key,
		const double	val
	)

void BCP_cg_user::set_param	(	const BCP_cg_par::str_params	key,
		const char *	val
	)

void BCP_cg_user::send_cut ( const BCP_cut & cut )

Pack the argument into the message buffer and send it to the sender of the LP solution.

Whenever the user generates a cut in the generate_cuts() method she should invoke this method to immediately send off the cut to the LP process.

virtual void BCP_cg_user::unpack_module_data ( BCP_buffer & buf )

virtual

Unpack the initial information sent to the Cut Generator process by the Tree Manager.

This information was packed by the method BCP_tm_user::pack_module_data() invoked with BCP_ProcessType_CG as the third (target process type) argument.
Default: empty method.

virtual void BCP_cg_user::unpack_primal_solution ( BCP_buffer & buf )

virtual

Unpack the LP solution arriving from the LP process.

This method is invoked only if the user packs the info necessary for cut generation by herself, i.e., she overrides the BCP_lp_user::pack_primal_solution(). If that's the case the user has to unpack the same info she has packed in the LP process.

virtual void BCP_cg_user::generate_cuts	(	BCP_vec< BCP_var * > &	vars,
		BCP_vec< double > &	x
	)

virtual

Perform the actual cut generation.

Whenever a cut is generated, the user should invoke the send_cut() method to send the generated cut back to the LP process.

Member Data Documentation

BCP_cg_prob* BCP_cg_user::p

private

Definition at line 52 of file BCP_cg_user.hpp.

Referenced by getCgProblemPointer().

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

/tmp/Bcp-1.4.4/Bcp/src/include/BCP_cg_user.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation