idol
A C++ Framework for Optimization
Loading...
Searching...
No Matches
idol::Callback Class Referenceabstract
Inheritance diagram for idol::Callback:
Inheritance graph
Collaboration diagram for idol::Callback:
Collaboration graph

Protected Member Functions

virtual const Modeloriginal_model () const
 
virtual void submit_heuristic_solution (const PrimalPoint &t_solution)
 
virtual void add_user_cut (const TempCtr &t_cut)
 
virtual void add_lazy_cut (const TempCtr &t_cut)
 
virtual PrimalPoint primal_solution () const
 
const Timertime () const
 
double best_obj () const
 
double best_bound () const
 
void terminate ()
 
virtual void operator() (CallbackEvent t_event)=0
 

Friends

class ::idol::CallbackI
 

Detailed Description

Definition at line 69 of file Callback.h.

Member Function Documentation

◆ add_lazy_cut()

virtual void idol::Callback::add_lazy_cut ( const TempCtr t_cut)
protectedvirtual

Adds a lazy cut to the relaxation

Parameters
t_cutthe cut to be added

◆ add_user_cut()

virtual void idol::Callback::add_user_cut ( const TempCtr t_cut)
protectedvirtual

Adds a user cut to the relaxation

Parameters
t_cutthe cut to be added

◆ best_bound()

double idol::Callback::best_bound ( ) const
protected

Returns the best bound found so far

Returns
the best bound

◆ best_obj()

double idol::Callback::best_obj ( ) const
protected

Returns the best objective value found so far

Returns
the best objective value

◆ operator()()

virtual void idol::Callback::operator() ( CallbackEvent  t_event)
protectedpure virtual

This method is left for the user to write and consists in the main execution block of the callback.

Parameters
t_eventthe event which triggered the call

Implemented in idol::Heuristics::LocalBranching::Strategy, idol::Heuristics::RENS::Strategy, idol::Heuristics::SimpleRounding::Strategy, idol::Plots::OptimalityGap::Strategy, and idol::Optimizers::Robust::Benders::BendersCallback::Strategy.

◆ original_model()

virtual const Model & idol::Callback::original_model ( ) const
protectedvirtual

Accesses the original model given to the solver

◆ primal_solution()

virtual PrimalPoint idol::Callback::primal_solution ( ) const
protectedvirtual

Returns the solution of the node which is currently being explored (when available)

Returns
the solution of the current node

◆ submit_heuristic_solution()

virtual void idol::Callback::submit_heuristic_solution ( const PrimalPoint t_solution)
protectedvirtual

Submits a new heuristic solution

◆ terminate()

void idol::Callback::terminate ( )
protected

Asks the optimizer to terminate the optimization process as soon as possible

◆ time()

const Timer & idol::Callback::time ( ) const
protected

Returns the current time

Returns
the optimizer's time

Friends And Related Symbol Documentation

◆ ::idol::CallbackI

friend class ::idol::CallbackI
friend

Definition at line 70 of file Callback.h.