Public Member Functions

VOL_user_hooks Class Reference

The user hooks should be overridden by the user to provide the problem specific routines for the volume algorithm. More...

#include <VolVolume.h>

Inheritance diagram for VOL_user_hooks:
UFL< vtype, adjlist_t >

Public Member Functions

virtual int compute_rc (const VOL_dvector &u, VOL_dvector &rc)=0
 compute reduced costs
virtual int solve_subproblem (const VOL_dvector &dual, const VOL_dvector &rc, double &lcost, VOL_dvector &x, VOL_dvector &v, double &pcost)=0
 Solve the subproblem for the subgradient step.
virtual int heuristics (const VOL_problem &p, const VOL_dvector &x, double &heur_val, double lb)=0
 Starting from the primal vector x, run a heuristic to produce an integer solution.
virtual void init_u (VOL_dvector &u)=0
 Starting from a initial set of lagrange multipliers in user memory, load them into Vol's data structures.

Detailed Description

The user hooks should be overridden by the user to provide the problem specific routines for the volume algorithm.

The user should derive a class ...

for all hooks: return value of -1 means that volume should quit


Member Function Documentation

virtual int VOL_user_hooks::compute_rc ( const VOL_dvector u,
VOL_dvector rc 
) [pure virtual]

compute reduced costs

Parameters:
u (IN) the dual variables
rc (OUT) the reduced cost with respect to the dual values

Implemented in UFL< vtype, adjlist_t >.

Referenced by VOL_problem::solve().

virtual int VOL_user_hooks::heuristics ( const VOL_problem p,
const VOL_dvector x,
double &  heur_val,
double  lb 
) [pure virtual]

Starting from the primal vector x, run a heuristic to produce an integer solution.

Parameters:
x (IN) the primal vector
heur_val (OUT) the value of the integer solution (return DBL_MAX here if no feas sol was found

Implemented in UFL< vtype, adjlist_t >.

Referenced by VOL_problem::solve().

virtual void VOL_user_hooks::init_u ( VOL_dvector u  )  [pure virtual]

Starting from a initial set of lagrange multipliers in user memory, load them into Vol's data structures.

Parameters:
u (OUT) the initial dual vector

Implemented in UFL< vtype, adjlist_t >.

Referenced by VOL_problem::solve().

virtual int VOL_user_hooks::solve_subproblem ( const VOL_dvector dual,
const VOL_dvector rc,
double &  lcost,
VOL_dvector x,
VOL_dvector v,
double &  pcost 
) [pure virtual]

Solve the subproblem for the subgradient step.

Parameters:
dual (IN) the dual variables
rc (IN) the reduced cost with respect to the dual values
lcost (OUT) the lagrangean cost with respect to the dual values
x (OUT) the primal result of solving the subproblem
v (OUT) b-Ax for the relaxed constraints
pcost (OUT) the primal objective value of x

Implemented in UFL< vtype, adjlist_t >.

Referenced by VOL_problem::solve().


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