Skip to content

hlefebvr/idol

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

idol - The Mathematical Optimization Framework

License GitHub tag (latest by date) GitHub Workflow Status (branch) GitHub issues Repo status codecov GitHub sponsors

Making Branch-and-Price implementation as easy as Branch-and-Bound + Column-Generation

Idol is a powerful and flexible library meticulously crafted for developing new mathematical optimization algorithms.

It is built to provide researchers with a versatile toolkit to construct, tweak, and experiment with state-of-the-art methods. Whether you're exploring Branch-and-Price, Benders decomposition, Column-and-Constraint generation for adjustable robust problems, or any other cutting-edge method, idol is your trusted companion.

Documentation

Visit our online documentation.

Using idol for Research?

If you are opting for idol in one of your research project and encounter some issues, please contact us at lefebvre(at)uni-trier.de.

Examples

Branch-and-Price

Look at how easy it is to implement a Branch-and-Price algorithm using idol.

const auto [model, decomposition] = create_model(); // Creates the model with an annotation for automatic decomposition

const auto sub_problem_specifications = 
        DantzigWolfe::SubProblem()
          .add_optimizer(Gurobi()); // Each sub-problem will be solved by Gurobi

const auto column_generation = 
        DantzigWolfeDecomposition(decomposition)
          .with_master_optimizer(Gurobi::ContinuousRelaxation()) // The master problem will be solved by Gurobi
          .with_default_sub_problem_spec(sub_problem_specifications);

const auto branch_and_bound =
        BranchAndBound()
          .with_node_selection_rule(BestBound()) // Nodes will be selected by the "best-bound" rule
          .with_branching_rule(MostInfeasible()) // Variables will be selected by the "most-fractional" rule
          .with_log_level(Info, Blue);

const auto branch_and_price = branch_and_bound + column_generation; // Embed the column generation in the Branch-and-Bound algorithm

model.use(branch_and_price);

model.optimize();

Bi-level Problem (using MibS)

Here, idol uses the external solver coin-or/MibS to solve a bi-level optimization problem with integer lower level.

/**
 * min  -x − 7y
 * s.t. −3x + 2y ≤ 12
         x + 2y ≤ 20
         0 ≤ x ≤ 10
         x integer
         y ∈ arg min {z : 2x - z ≤ 7,
                          -2x + 4z ≤ 16,
                          0 ≤ z ≤ 5
                          z integer}
 */

Env env; // Create environment

// Define High Point Relaxation
Model model(env);

auto x = model.add_var(0, 10, Integer, "x");
auto y = model.add_var(0, 5, Integer, "y");

model.set_obj_expr(-x - 7 * y);
auto c1 = model.add_ctr(-3 * x + 2 * y <= 12);
auto c2 = model.add_ctr(x + 2 * y <= 20);
auto c3 = model.add_ctr(y == 0);
auto c4 = model.add_ctr(2 * x - y <= 7);
auto c5 = model.add_ctr(-2 * x + 4 * y <= 16);

// Annotate follower variables
// * If not annotated, the default value is MasterId, i.e., leader variables and constraints
// * Otherwise, it indicates the id of the follower (here, we have only one follower)
Annotation<Var> follower_variables(env, "follower_variable", MasterId);
Annotation<Ctr> follower_constraints(env, "follower_constraints", MasterId);

y.set(follower_variables, 0); // "y" is a lower level variable
c4.set(follower_constraints, 0); // "c4" is a lower level constraint
c5.set(follower_constraints, 0); // "c5" is a lower level constraint

// Use coin-or/MibS as external solver
model.use(BiLevel::MibS(follower_variables,
                        follower_constraints,
                        follower_objective));

// Optimize and print solution
model.optimize();

// Print the solution
std::cout << save_primal(model) << std::endl;

Implemented Features

Branch-and-Bound

  • Node selection rules: Best Bound, Worst Bound, Depth First, Best Estimate, Breadth First.
  • Branching rules (for variable branching): Pseudo Cost, Strong Branching (with phases), Most Infeasible, Least Infeasible, First Found, Uniformly Random.
  • Subtree exploration
  • Heuristics (for variable branching): Simple Rounding, Relaxed Enforced Neighborhood, Local Branching
  • Callbacks: User Cuts, Lazy Cuts

Column Generation and Branch-and-Price

  • Automatic Dantzig-Wolfe reformulation
  • Soft and hard branching available (i.e, branching on master or sub-problem)
  • Stabilization by dual price smoothing: Wentges (1997), Neame (2000)
  • Can solve sub-problems in parallel
  • Supports pricing heuristics
  • Heuristics: Integer Master

External Solvers

Idol can be used as a unified interface to several open-source or commercial solvers like

Benchmark

Performance profile

This is a performance profile computed according to Dolan, E., Moré, J. Benchmarking optimization software with performance profiles. Math. Program. 91, 201–213 (2002) https://doi.org/10.1007/s101070100263.

Miscellaneous

Versionning is compliant with Semantic versionning 2.0.0.