idol::BranchAndBoundCallbackI< NodeInfoT > Class Template Reference

#include <idol/mixed-integer/optimizers/branch-and-bound/callbacks/BranchAndBoundCallback.h>

Description

template<class NodeInfoT>
class idol::BranchAndBoundCallbackI< NodeInfoT >

Template Parameters

NodeInfoT

the class used to store each branch-and-tree node's information

Definition at line 27 of file BranchAndBoundCallback.h.

Protected Methods
void	add_user_cut (const TempCtr &t_cut)
void	add_lazy_cut (const TempCtr &t_cut)
void	add_local_variable_branching (const idol::Var &t_var, CtrType t_type, double t_rhs)
const Node< NodeInfoT > &	node () const
const Model &	relaxation () const
const Model &	original_model () const
const Timer &	time () const
const SideEffectRegistry &	side_effect_registry () const
void	submit_heuristic_solution (NodeInfoT *t_info)
void	submit_bound (double t_bound)
double	best_bound () const
double	best_obj () const
unsigned int	node_count () const
void	terminate ()
SideEffectRegistry	operator() (Optimizers::BranchAndBound< NodeInfoT > *t_parent, CallbackEvent t_event, const Node< NodeInfoT > &t_current_node, Model *t_relaxation) override
void	add_callback (BranchAndBoundCallback< NodeInfoT > *t_cb) override
void	initialize (Optimizers::BranchAndBound< NodeInfoT > *t_parent) override
void	log_after_termination () override

Friends
class	BranchAndBoundCallback< NodeInfoT >

Methods Documentation

add_callback()

template<class NodeInfoT>

void idol::BranchAndBoundCallbackI< NodeInfoT >::add_callback ( BranchAndBoundCallback< NodeInfoT > * t_cb )

overrideprotectedvirtual

Implements idol::AbstractBranchAndBoundCallbackI< NodeInfoT >.

Definition at line 347 of file BranchAndBoundCallback.h.

add_lazy_cut()

template<class NodeInfoT>

void idol::BranchAndBoundCallbackI< NodeInfoT >::add_lazy_cut ( const TempCtr & t_cut )

protected

Definition at line 407 of file BranchAndBoundCallback.h.

add_local_variable_branching()

template<class NodeInfoT>

void idol::BranchAndBoundCallbackI< NodeInfoT >::add_local_variable_branching ( const idol::Var & t_var, CtrType t_type, double t_rhs )

protected

Definition at line 82 of file BranchAndBoundCallback.h.

add_user_cut()

template<class NodeInfoT>

void idol::BranchAndBoundCallbackI< NodeInfoT >::add_user_cut ( const TempCtr & t_cut )

protected

Definition at line 413 of file BranchAndBoundCallback.h.

best_bound()

template<class NodeInfoT>

double idol::BranchAndBoundCallbackI< NodeInfoT >::best_bound ( ) const

nodiscardprotected

Definition at line 103 of file BranchAndBoundCallback.h.

best_obj()

template<class NodeInfoT>

double idol::BranchAndBoundCallbackI< NodeInfoT >::best_obj ( ) const

nodiscardprotected

Definition at line 93 of file BranchAndBoundCallback.h.

initialize()

template<class NodeInfoT>

void idol::BranchAndBoundCallbackI< NodeInfoT >::initialize ( Optimizers::BranchAndBound< NodeInfoT > * t_parent )

overrideprotectedvirtual

Implements idol::AbstractBranchAndBoundCallbackI< NodeInfoT >.

Definition at line 352 of file BranchAndBoundCallback.h.

log_after_termination()

template<class NodeInfoT>

void idol::BranchAndBoundCallbackI< NodeInfoT >::log_after_termination ( )

overrideprotectedvirtual

Implements idol::AbstractBranchAndBoundCallbackI< NodeInfoT >.

Definition at line 108 of file BranchAndBoundCallback.h.

node()

template<class NodeInfoT>

const idol::Node< NodeInfoT > & idol::BranchAndBoundCallbackI< NodeInfoT >::node ( ) const

nodiscardprotected

Definition at line 399 of file BranchAndBoundCallback.h.

node_count()

template<class NodeInfoT>

unsigned int idol::BranchAndBoundCallbackI< NodeInfoT >::node_count ( ) const

nodiscardprotected

Definition at line 98 of file BranchAndBoundCallback.h.

operator()()

template<class NodeInfoT>

idol::SideEffectRegistry idol::BranchAndBoundCallbackI< NodeInfoT >::operator() ( Optimizers::BranchAndBound< NodeInfoT > * t_parent, CallbackEvent t_event, const Node< NodeInfoT > & t_current_node, Model * t_relaxation )

overrideprotectedvirtual

Implements idol::AbstractBranchAndBoundCallbackI< NodeInfoT >.

Definition at line 321 of file BranchAndBoundCallback.h.

original_model()

template<class NodeInfoT>

const idol::Model & idol::BranchAndBoundCallbackI< NodeInfoT >::original_model ( ) const

nodiscardprotected

Definition at line 383 of file BranchAndBoundCallback.h.

relaxation()

template<class NodeInfoT>

const idol::Model & idol::BranchAndBoundCallbackI< NodeInfoT >::relaxation ( ) const

nodiscardprotected

Definition at line 391 of file BranchAndBoundCallback.h.

side_effect_registry()

template<class NodeInfoT>

const idol::SideEffectRegistry & idol::BranchAndBoundCallbackI< NodeInfoT >::side_effect_registry ( ) const

nodiscardprotected

Definition at line 125 of file BranchAndBoundCallback.h.

submit_bound()

template<class NodeInfoT>

void idol::BranchAndBoundCallbackI< NodeInfoT >::submit_bound ( double t_bound )

protected

Definition at line 367 of file BranchAndBoundCallback.h.

submit_heuristic_solution()

template<class NodeInfoT>

void idol::BranchAndBoundCallbackI< NodeInfoT >::submit_heuristic_solution ( NodeInfoT * t_info )

protected

Definition at line 375 of file BranchAndBoundCallback.h.

terminate()

template<class NodeInfoT>

void idol::BranchAndBoundCallbackI< NodeInfoT >::terminate ( )

protected

Definition at line 88 of file BranchAndBoundCallback.h.

time()

template<class NodeInfoT>

const idol::Timer & idol::BranchAndBoundCallbackI< NodeInfoT >::time ( ) const

nodiscardprotected

Definition at line 133 of file BranchAndBoundCallback.h.

Friends And Related Symbol Documentation

BranchAndBoundCallback< NodeInfoT >

template<class NodeInfoT>

friend class BranchAndBoundCallback< NodeInfoT >

friend

Definition at line 413 of file BranchAndBoundCallback.h.