Refactor examples

Author: fontanf

CMakeLists.txt

@@ -2,6 +2,9 @@ cmake_minimum_required(VERSION 3.15.0)
 
 project(LocalSearchSolver LANGUAGES CXX)
 
+# Options.
+option(LOCALSEARCHSOLVER_BUILD_EXAMPLES "Build examples" ON)
+
 # Avoid FetchContent warning.
 cmake_policy(SET CMP0135 NEW)
 
@@ -15,3 +18,6 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 add_subdirectory(extern)
 add_subdirectory(src)
 add_subdirectory(test)
+if(LOCALSEARCHSOLVER_BUILD_EXAMPLES)
+    add_subdirectory(examples)
+endif()

README.md

@@ -82,64 +82,64 @@ In case the `GlobalCost global_cost_concatenate(SequenceData&, const SequenceDat
 
 #### Single sequence
 
-[Sequential ordering problem](include/localsearchsolver/examples/sequential_ordering.hpp)
+[Sequential ordering problem](examples/sequencing/sequential_ordering_main.cpp)
 
-[Single machine scheduling problem with sequence-dependent setup times, total weighted tardiness](include/localsearchsolver/examples/scheduling_with_sdst_twt.hpp)
+[Single machine scheduling problem with sequence-dependent setup times, total weighted tardiness](examples/sequencing/scheduling_with_sdst_twt_main.cpp)
 
-[Permutation flow shop scheduling problem, total completion time](include/localsearchsolver/examples/permutation_flowshop_scheduling_tct.hpp)
+[Permutation flow shop scheduling problem, total completion time](examples/sequencing/permutation_flowshop_scheduling_tct_main.cpp)
 
-[Permutation flow shop scheduling problem, total tardiness](include/localsearchsolver/examples/permutation_flowshop_scheduling_tt.hpp)
+[Permutation flow shop scheduling problem, total tardiness](examples/sequencing/permutation_flowshop_scheduling_tt_main.cpp)
 
 #### Single sub-sequence
 
-[Single machine order acceptance and scheduling problem with time windows and sequence-dependent setup times, total weighted tardiness](include/localsearchsolver/examples/order_acceptance_and_scheduling.hpp)
+[Single machine order acceptance and scheduling problem with time windows and sequence-dependent setup times, total weighted tardiness](examples/sequencing/order_acceptance_and_scheduling_main.cpp)
 
-[Time-dependent orienteering problem](include/localsearchsolver/examples/time_dependent_orienteering.hpp)
+[Time-dependent orienteering problem](examples/sequencing/time_dependent_orienteering_main.cpp)
 
 #### Multiple sequences
 
-[Distributed permutation flow shop scheduling problem, total completion time](include/localsearchsolver/examples/distributed_pfss_tct.hpp)
+[Distributed permutation flow shop scheduling problem, total completion time](examples/sequencing/distributed_pfss_tct_main.cpp)
 
 #### Single sequence, modes
 
-[Traveling salesman problem with release dates](include/localsearchsolver/examples/traveling_salesman_with_release_dates.hpp)
+[Traveling salesman problem with release dates](examples/sequencing/traveling_salesman_with_release_dates_main.cpp)
 
-[Single machine batch scheduling problem, total weighted tardiness](include/localsearchsolver/examples/batch_scheduling_total_weighted_tardiness.hpp)
+[Single machine batch scheduling problem, total weighted tardiness](examples/sequencing/batch_scheduling_total_weighted_tardiness_main.cpp)
 
 #### Single sequence, `sequence_data_init/concatenate`
 
-[Traveling repairman problem](include/localsearchsolver/examples/traveling_repairman.hpp)
+[Traveling repairman problem](examples/sequencing/traveling_repairman_main.cpp)
 
 #### Multiple sequences, `sequence_data_init/concatenate`
 
-[Capacitated vehicle routing problem](include/localsearchsolver/examples/capacitated_vehicle_routing.hpp)
+[Capacitated vehicle routing problem](examples/sequencing/capacitated_vehicle_routing_main.cpp)
 
-[Vehicle routing problem with time windows](include/localsearchsolver/examples/vehicle_routing_with_time_windows.hpp)
+[Vehicle routing problem with time windows](examples/sequencing/vehicle_routing_with_time_windows_main.cpp)
 
 #### Multiple sub-sequences, `sequence_data_init/concatenate`
 
-[Team orienteering problem](include/localsearchsolver/examples/team_orienteering.hpp)
+[Team orienteering problem](examples/sequencing/team_orienteering_main.cpp)
 
 
 ## Other examples
 
 Data can be downloaded from [fontanf/orproblems](https://github.com/fontanf/orproblems)
 
-[Multidimensional multiple-choice knapsack problem](include/localsearchsolver/examples/multidimensional_multiple_choice_knapsack.hpp)
+[Multidimensional multiple-choice knapsack problem](examples/multidimensional_multiple_choice_knapsack_main.cpp)
 * Straightforward example for a genetic local search: single neighborhood, basic operators
 * Algorithm:
   * Local search neighborhoods:
     * Add item `j` in the knapsack
   * Crossover algorithm
 
-[Quadratic assignment problem](include/localsearchsolver/examples/quadratic_assignment.hpp)
+[Quadratic assignment problem](examples/quadratic_assignment_main.cpp)
 * Example which implements a problem specific acceleration strategy to compute the move costs
 * Algorithm:
   * Local search neighborhood: swap two assignments
   * Perturbation: ejection chain
   * Crossover algorithm: UX crossover
 
-[Knapsack problem with conflicts](include/localsearchsolver/examples/knapsack_with_conflicts.hpp)
+[Knapsack problem with conflicts](examples/knapsack_with_conflicts_main.cpp)
 * Example with multiple neigborhoods
 * Algorithm:
   * Local search neighborhoods:
@@ -155,13 +155,13 @@ Data can be downloaded from [fontanf/orproblems](https://github.com/fontanf/orpr
   * Local search neighborhoods: shift item `j` to agent `i`
   * Perturbation: shift 8 random jobs
 
-[Permutation flow shop scheduling problem, makespan](include/localsearchsolver/examples/permutation_flowshop_scheduling_makespan.hpp)
+[Permutation flow shop scheduling problem, makespan](examples/permutation_flowshop_scheduling_makespan_main.cpp)
 * This one is not considered as a sequencing problem since the dedicated acceleration strategy makes it possible to explore the neighborhoods more efficiently
 * Algorithm:
   * Local search neighborhood: move a block of `k` consecutive jobs, `k = 1..4`
   * Perturbation: swap two blocks (double-bridge)
 
-[Maximum-weight independent set problem](https://github.com/fontanf/stablesolver/blob/master/stablesolver/stable/algorithms/local_search.cpp) and [maximum-weight clique problem](https://github.com/fontanf/stablesolver/blob/master/stablesolver/clique/algorithms/local_search.cpp) from [fontanf/stablesolver](https://github.com/fontanf/stablesolver)
+[Maximum-weight independent set problem](https://github.com/fontanf/stablesolver/blob/master/src/stable/algorithms/local_search.cpp) and [maximum-weight clique problem](https://github.com/fontanf/stablesolver/blob/master/src/clique/algorithms/local_search.cpp) from [fontanf/stablesolver](https://github.com/fontanf/stablesolver)
 * Algorithm:
   * Local search neighborhoods:
     * Move vertex `v` in/out of the solution (and remove conflicting vertices)

examples/CMakeLists.txt

@@ -0,0 +1,49 @@
+add_subdirectory(sequencing)
+
+add_executable(LocalSearchSolver_example_knapsack_with_conflicts_main)
+target_sources(LocalSearchSolver_example_knapsack_with_conflicts_main PRIVATE
+    knapsack_with_conflicts_main.cpp)
+target_include_directories(LocalSearchSolver_example_knapsack_with_conflicts_main INTERFACE
+    ${PROJECT_SOURCE_DIR}/include)
+target_link_libraries(LocalSearchSolver_example_knapsack_with_conflicts_main PUBLIC
+    LocalSearchSolver_localsearchsolver
+    ORProblems::knapsack_with_conflicts
+    Boost::program_options)
+set_target_properties(LocalSearchSolver_example_knapsack_with_conflicts_main PROPERTIES OUTPUT_NAME "localsearchsolver_knapsack_with_conflicts")
+install(TARGETS LocalSearchSolver_example_knapsack_with_conflicts_main)
+
+add_executable(LocalSearchSolver_example_multidimensional_multiple_choice_knapsack_main)
+target_sources(LocalSearchSolver_example_multidimensional_multiple_choice_knapsack_main PRIVATE
+    multidimensional_multiple_choice_knapsack_main.cpp)
+target_include_directories(LocalSearchSolver_example_multidimensional_multiple_choice_knapsack_main INTERFACE
+    ${PROJECT_SOURCE_DIR}/include)
+target_link_libraries(LocalSearchSolver_example_multidimensional_multiple_choice_knapsack_main PUBLIC
+    LocalSearchSolver_localsearchsolver
+    ORProblems::multidimensional_multiple_choice_knapsack
+    Boost::program_options)
+set_target_properties(LocalSearchSolver_example_multidimensional_multiple_choice_knapsack_main PROPERTIES OUTPUT_NAME "localsearchsolver_multidimensional_multiple_choice_knapsack")
+install(TARGETS LocalSearchSolver_example_multidimensional_multiple_choice_knapsack_main)
+
+add_executable(LocalSearchSolver_example_permutation_flowshop_scheduling_makespan_main)
+target_sources(LocalSearchSolver_example_permutation_flowshop_scheduling_makespan_main PRIVATE
+    permutation_flowshop_scheduling_makespan_main.cpp)
+target_include_directories(LocalSearchSolver_example_permutation_flowshop_scheduling_makespan_main INTERFACE
+    ${PROJECT_SOURCE_DIR}/include)
+target_link_libraries(LocalSearchSolver_example_permutation_flowshop_scheduling_makespan_main PUBLIC
+    LocalSearchSolver_localsearchsolver
+    ORProblems::permutation_flowshop_scheduling_makespan
+    Boost::program_options)
+set_target_properties(LocalSearchSolver_example_permutation_flowshop_scheduling_makespan_main PROPERTIES OUTPUT_NAME "localsearchsolver_permutation_flowshop_scheduling_makespan")
+install(TARGETS LocalSearchSolver_example_permutation_flowshop_scheduling_makespan_main)
+
+add_executable(LocalSearchSolver_example_quadratic_assignment_main)
+target_sources(LocalSearchSolver_example_quadratic_assignment_main PRIVATE
+    quadratic_assignment_main.cpp)
+target_include_directories(LocalSearchSolver_example_quadratic_assignment_main INTERFACE
+    ${PROJECT_SOURCE_DIR}/include)
+target_link_libraries(LocalSearchSolver_example_quadratic_assignment_main PUBLIC
+    LocalSearchSolver_localsearchsolver
+    ORProblems::quadratic_assignment
+    Boost::program_options)
+set_target_properties(LocalSearchSolver_example_quadratic_assignment_main PROPERTIES OUTPUT_NAME "localsearchsolver_quadratic_assignment")
+install(TARGETS LocalSearchSolver_example_quadratic_assignment_main)

…ver/examples/knapsack_with_conflicts.hpp examples/knapsack_with_conflicts_main.cppinclude/localsearchsolver/examples/knapsack_with_conflicts.hpp renamed to examples/knapsack_with_conflicts_main.cpp include/localsearchsolver/examples/knapsack_with_conflicts.hpp renamed to examples/knapsack_with_conflicts_main.cpp

@@ -26,19 +26,15 @@
  *
  */
 
-#pragma once
+#include "read_args.hpp"
 
 #include "localsearchsolver/common.hpp"
 
 #include "orproblems/packing/knapsack_with_conflicts.hpp"
 
 #include "optimizationtools//utils//utils.hpp"
 
-namespace localsearchsolver
-{
-namespace knapsack_with_conflicts
-{
-
+using namespace localsearchsolver;
 using namespace orproblems::knapsack_with_conflicts;
 
 class LocalScheme
@@ -780,6 +776,58 @@ class LocalScheme
 
 };
 
-}
-}
+int main(int argc, char *argv[])
+{
+    // Create command line options.
+    boost::program_options::options_description desc = setup_args();
+    boost::program_options::variables_map vm;
+    boost::program_options::store(boost::program_options::parse_command_line(argc, argv, desc), vm);
+    if (vm.count("help")) {
+        std::cout << desc << std::endl;;
+        throw "";
+    }
+    try {
+        boost::program_options::notify(vm);
+    } catch (const boost::program_options::required_option& e) {
+        std::cout << desc << std::endl;;
+        throw "";
+    }
 
+    // Create instance.
+    InstanceBuilder instance_builder;
+    instance_builder.read(
+            vm["input"].as<std::string>(),
+            vm["format"].as<std::string>());
+    const Instance instance = instance_builder.build();
+
+    // Create local scheme.
+    LocalScheme::Parameters parameters;
+    LocalScheme local_scheme(instance, parameters);
+
+    // Run algorithm.
+    std::string algorithm = "best-first-local-search";
+    if (vm.count("algorithm"))
+        algorithm = vm["algorithm"].as<std::string>();
+    auto output =
+        (algorithm == "multi-start-local-search")?
+        run_multi_start_local_search(local_scheme, vm):
+        (algorithm == "iterated-local-search")?
+        run_iterated_local_search(local_scheme, vm):
+        (algorithm == "best-first-local-search")?
+        run_best_first_local_search(local_scheme, vm):
+        run_genetic_local_search(local_scheme, vm);
+
+    // Run checker.
+    if (vm["print-checker"].as<int>() > 0
+            && vm["certificate"].as<std::string>() != "") {
+        std::cout << std::endl
+            << "Checker" << std::endl
+            << "-------" << std::endl;
+        instance.check(
+                vm["certificate"].as<std::string>(),
+                std::cout,
+                vm["print-checker"].as<int>());
+    }
+
+    return 0;
+}

…dimensional_multiple_choice_knapsack.hpp …sional_multiple_choice_knapsack_main.cppinclude/localsearchsolver/examples/multidimensional_multiple_choice_knapsack.hpp renamed to examples/multidimensional_multiple_choice_knapsack_main.cpp include/localsearchsolver/examples/multidimensional_multiple_choice_knapsack.hpp renamed to examples/multidimensional_multiple_choice_knapsack_main.cpp

@@ -5,17 +5,13 @@
  * See https://github.com/fontanf/orproblems/blob/main/orproblems/multidimensional_multiple_choice_knapsack.hpp
  */
 
-#pragma once
+#include "read_args.hpp"
 
 #include "localsearchsolver/common.hpp"
 
 #include "orproblems/packing/multidimensional_multiple_choice_knapsack.hpp"
 
-namespace localsearchsolver
-{
-namespace multidimensional_multiple_choice_knapsack
-{
-
+using namespace localsearchsolver;
 using namespace orproblems::multidimensional_multiple_choice_knapsack;
 
 class LocalScheme
@@ -299,5 +295,55 @@ class LocalScheme
 
 };
 
-}
+int main(int argc, char *argv[])
+{
+    // Create command line options.
+    boost::program_options::options_description desc = setup_args();
+    boost::program_options::variables_map vm;
+    boost::program_options::store(boost::program_options::parse_command_line(argc, argv, desc), vm);
+    if (vm.count("help")) {
+        std::cout << desc << std::endl;;
+        throw "";
+    }
+    try {
+        boost::program_options::notify(vm);
+    } catch (const boost::program_options::required_option& e) {
+        std::cout << desc << std::endl;;
+        throw "";
+    }
+
+    // Create instance.
+    InstanceBuilder instance_builder;
+    instance_builder.read(
+            vm["input"].as<std::string>(),
+            vm["format"].as<std::string>());
+    const Instance instance = instance_builder.build();
+
+    // Create local scheme.
+    LocalScheme local_scheme(instance);
+
+    // Run algorithm.
+    std::string algorithm = vm["algorithm"].as<std::string>();
+    auto output =
+        (algorithm == "multi-start-local-search")?
+        run_multi_start_local_search(local_scheme, vm):
+        //(algorithm == "iterated-local-search")?
+        //run_iterated_local_search(local_scheme, vm):
+        //(algorithm == "best-first-local-search")?
+        //run_best_first_local_search(local_scheme, vm):
+        run_genetic_local_search(local_scheme, vm);
+
+    // Run checker.
+    if (vm["print-checker"].as<int>() > 0
+            && vm["certificate"].as<std::string>() != "") {
+        std::cout << std::endl
+            << "Checker" << std::endl
+            << "-------" << std::endl;
+        instance.check(
+                vm["certificate"].as<std::string>(),
+                std::cout,
+                vm["print-checker"].as<int>());
+    }
+
+    return 0;
 }