From f5ded71db701549467a7ae2c0ac2c6de62b4d3ed Mon Sep 17 00:00:00 2001 From: jboisson Date: Tue, 15 Jan 2008 15:52:09 +0000 Subject: [PATCH] Lesson update: commentaries and variable names git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@878 331e1502-861f-0410-8da2-ba01fb791d7f --- .../tutorial/Lesson1/hill_climbing.cpp | 114 +++++++++--------- .../tutorial/Lesson2/tabu_search.cpp | 107 ++++++++-------- .../tutorial/Lesson3/simulated_annealing.cpp | 112 ++++++++--------- .../Lesson4/iterated_local_search.cpp | 78 +++++++----- 4 files changed, 218 insertions(+), 193 deletions(-) diff --git a/trunk/paradiseo-mo/tutorial/Lesson1/hill_climbing.cpp b/trunk/paradiseo-mo/tutorial/Lesson1/hill_climbing.cpp index bee5249f3..2b3833b7b 100644 --- a/trunk/paradiseo-mo/tutorial/Lesson1/hill_climbing.cpp +++ b/trunk/paradiseo-mo/tutorial/Lesson1/hill_climbing.cpp @@ -1,84 +1,84 @@ /* -* -* Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2007 -* (C) OPAC Team, LIFL, 2002-2007 -* -* Sébastien Cahon, Jean-Charles Boisson -* -* This software is governed by the CeCILL license under French law and -* abiding by the rules of distribution of free software. You can use, -* modify and/ or redistribute the software under the terms of the CeCILL -* license as circulated by CEA, CNRS and INRIA at the following URL -* "http://www.cecill.info". -* -* As a counterpart to the access to the source code and rights to copy, -* modify and redistribute granted by the license, users are provided only -* with a limited warranty and the software's author, the holder of the -* economic rights, and the successive licensors have only limited liability. -* -* In this respect, the user's attention is drawn to the risks associated -* with loading, using, modifying and/or developing or reproducing the -* software by the user in light of its specific status of free software, -* that may mean that it is complicated to manipulate, and that also -* therefore means that it is reserved for developers and experienced -* professionals having in-depth computer knowledge. Users are therefore -* encouraged to load and test the software's suitability as regards their -* requirements in conditions enabling the security of their systems and/or -* data to be ensured and, more generally, to use and operate it in the -* same conditions as regards security. -* The fact that you are presently reading this means that you have had -* knowledge of the CeCILL license and that you accept its terms. -* -* ParadisEO WebSite : http://paradiseo.gforge.inria.fr -* Contact: paradiseo-help@lists.gforge.inria.fr -* + + Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2008 + (C) OPAC Team, LIFL, 2002-2008 + + Sébastien Cahon, Jean-Charles Boisson + + This software is governed by the CeCILL license under French law and + abiding by the rules of distribution of free software. You can use, + modify and/ or redistribute the software under the terms of the CeCILL + license as circulated by CEA, CNRS and INRIA at the following URL + "http://www.cecill.info". + + As a counterpart to the access to the source code and rights to copy, + modify and redistribute granted by the license, users are provided only + with a limited warranty and the software's author, the holder of the + economic rights, and the successive licensors have only limited liability. + + In this respect, the user's attention is drawn to the risks associated + with loading, using, modifying and/or developing or reproducing the + software by the user in light of its specific status of free software, + that may mean that it is complicated to manipulate, and that also + therefore means that it is reserved for developers and experienced + professionals having in-depth computer knowledge. Users are therefore + encouraged to load and test the software's suitability as regards their + requirements in conditions enabling the security of their systems and/or + data to be ensured and, more generally, to use and operate it in the + same conditions as regards security. + The fact that you are presently reading this means that you have had + knowledge of the CeCILL license and that you accept its terms. + + ParadisEO WebSite : http://paradiseo.gforge.inria.fr + Contact: paradiseo-help@lists.gforge.inria.fr */ #include #include int -main (int __argc, char * __argv []) +main (int _argc, char* _argv []) { - if (__argc != 2) + if (_argc != 2) { - std :: cerr << "Usage : ./hill_climbing [instance]" << std :: endl ; - return 1 ; + std :: cerr << "Usage : ./hill_climbing [instance]" << std :: endl; + return EXIT_FAILURE; } - srand (1000) ; + srand (1000); - Graph :: load (__argv [1]) ; // Instance + Graph::load(_argv [1]); - Route route ; // Solution + Route solution; - RouteInit init ; // Sol. Random Init. - init (route) ; + RouteInit initializer; + initializer (solution); - RouteEval full_eval ; // Full. Eval. - full_eval (route) ; + RouteEval full_evaluation; + full_evaluation (solution); - std :: cout << "[From] " << route << std :: endl ; + std :: cout << "[From] " << solution << std :: endl; /* Tools for an efficient (? :-)) local search ! */ - TwoOptInit two_opt_init ; // Init. + TwoOptInit two_opt_initializer; - TwoOptNext two_opt_next ; // Explorer. + TwoOptNext two_opt_next_move_generator; - TwoOptIncrEval two_opt_incr_eval ; // Eff. eval. + TwoOptIncrEval two_opt_incremental_evaluation; - //moFirstImprSelect two_opt_select ; - moBestImprSelect two_opt_select ; - //moRandImprSelect two_opt_select ; + //moFirstImprSelect two_opt_selection; + moBestImprSelect two_opt_selection; + //moRandImprSelect two_opt_selection; - moHC hill_climbing (two_opt_init, two_opt_next, two_opt_incr_eval, two_opt_select, full_eval) ; - hill_climbing (route) ; - - std :: cout << "[To] " << route << std :: endl ; - - return 0 ; + moHC hill_climbing (two_opt_initializer, two_opt_next_move_generator, two_opt_incremental_evaluation, + two_opt_selection, full_evaluation); + hill_climbing (solution) ; + + std :: cout << "[To] " << solution << std :: endl; + + return EXIT_SUCCESS; } diff --git a/trunk/paradiseo-mo/tutorial/Lesson2/tabu_search.cpp b/trunk/paradiseo-mo/tutorial/Lesson2/tabu_search.cpp index 613868301..6cc7e1a5c 100644 --- a/trunk/paradiseo-mo/tutorial/Lesson2/tabu_search.cpp +++ b/trunk/paradiseo-mo/tutorial/Lesson2/tabu_search.cpp @@ -1,85 +1,86 @@ /* -* -* Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2007 -* (C) OPAC Team, LIFL, 2002-2007 -* -* Sébastien Cahon, Jean-Charles Boisson -* -* This software is governed by the CeCILL license under French law and -* abiding by the rules of distribution of free software. You can use, -* modify and/ or redistribute the software under the terms of the CeCILL -* license as circulated by CEA, CNRS and INRIA at the following URL -* "http://www.cecill.info". -* -* As a counterpart to the access to the source code and rights to copy, -* modify and redistribute granted by the license, users are provided only -* with a limited warranty and the software's author, the holder of the -* economic rights, and the successive licensors have only limited liability. -* -* In this respect, the user's attention is drawn to the risks associated -* with loading, using, modifying and/or developing or reproducing the -* software by the user in light of its specific status of free software, -* that may mean that it is complicated to manipulate, and that also -* therefore means that it is reserved for developers and experienced -* professionals having in-depth computer knowledge. Users are therefore -* encouraged to load and test the software's suitability as regards their -* requirements in conditions enabling the security of their systems and/or -* data to be ensured and, more generally, to use and operate it in the -* same conditions as regards security. -* The fact that you are presently reading this means that you have had -* knowledge of the CeCILL license and that you accept its terms. -* -* ParadisEO WebSite : http://paradiseo.gforge.inria.fr -* Contact: paradiseo-help@lists.gforge.inria.fr -* + + Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2008 + (C) OPAC Team, LIFL, 2002-2008 + + Sébastien Cahon, Jean-Charles Boisson + + This software is governed by the CeCILL license under French law and + abiding by the rules of distribution of free software. You can use, + modify and/ or redistribute the software under the terms of the CeCILL + license as circulated by CEA, CNRS and INRIA at the following URL + "http://www.cecill.info". + + As a counterpart to the access to the source code and rights to copy, + modify and redistribute granted by the license, users are provided only + with a limited warranty and the software's author, the holder of the + economic rights, and the successive licensors have only limited liability. + + In this respect, the user's attention is drawn to the risks associated + with loading, using, modifying and/or developing or reproducing the + software by the user in light of its specific status of free software, + that may mean that it is complicated to manipulate, and that also + therefore means that it is reserved for developers and experienced + professionals having in-depth computer knowledge. Users are therefore + encouraged to load and test the software's suitability as regards their + requirements in conditions enabling the security of their systems and/or + data to be ensured and, more generally, to use and operate it in the + same conditions as regards security. + The fact that you are presently reading this means that you have had + knowledge of the CeCILL license and that you accept its terms. + + ParadisEO WebSite : http://paradiseo.gforge.inria.fr + Contact: paradiseo-help@lists.gforge.inria.fr + */ #include #include int -main (int __argc, char * __argv []) +main (int _argc, char* _argv []) { - if (__argc != 2) + if (_argc != 2) { std :: cerr << "Usage : ./tabu_search [instance]" << std :: endl ; return 1 ; } - Graph :: load (__argv [1]) ; // Instance + Graph::load (_argv [1]); - Route route ; // Solution + Route solution; - RouteInit init ; // Sol. Random Init. - init (route) ; + RouteInit initializer; + initializer(solution); - RouteEval full_eval ; // Full. Eval. - full_eval (route) ; + RouteEval full_evaluation; + full_evaluation(solution); - std :: cout << "[From] " << route << std :: endl ; + std :: cout << "[From] " << solution << std :: endl; /* Tools for an efficient (? :-)) local search ! */ - TwoOptInit two_opt_init ; // Init. + TwoOptInit two_opt_initializer; - TwoOptNext two_opt_next ; // Explorer. + TwoOptNext two_opt_next_move_generator; - TwoOptIncrEval two_opt_incr_eval ; // Eff. eval. + TwoOptIncrEval two_opt_incremental_evaluation; - TwoOptTabuList tabu_list ; // Tabu List + TwoOptTabuList tabu_list; //moSimpleMoveTabuList tabu_list(10); //moSimpleSolutionTabuList tabu_list(10); - moNoAspirCrit aspir_crit ; // Aspiration Criterion + moNoAspirCrit aspiration_criterion; - moGenSolContinue cont (10000) ; // Continuator + moGenSolContinue continu (10000); + + moTS tabu_search (two_opt_initializer, two_opt_next_move_generator, + two_opt_incremental_evaluation, tabu_list, aspiration_criterion, continu, full_evaluation); + tabu_search(solution); - moTS tabu_search (two_opt_init, two_opt_next, two_opt_incr_eval, tabu_list, aspir_crit, cont, full_eval) ; - tabu_search (route) ; + std :: cout << "[To] " << solution << std :: endl; - std :: cout << "[To] " << route << std :: endl ; - - return 0 ; + return EXIT_SUCCESS; } diff --git a/trunk/paradiseo-mo/tutorial/Lesson3/simulated_annealing.cpp b/trunk/paradiseo-mo/tutorial/Lesson3/simulated_annealing.cpp index cad9b331d..3a32ff509 100644 --- a/trunk/paradiseo-mo/tutorial/Lesson3/simulated_annealing.cpp +++ b/trunk/paradiseo-mo/tutorial/Lesson3/simulated_annealing.cpp @@ -1,84 +1,84 @@ /* -* -* Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2007 -* (C) OPAC Team, LIFL, 2002-2007 -* -* Sébastien Cahon, Jean-Charles Boisson -* -* This software is governed by the CeCILL license under French law and -* abiding by the rules of distribution of free software. You can use, -* modify and/ or redistribute the software under the terms of the CeCILL -* license as circulated by CEA, CNRS and INRIA at the following URL -* "http://www.cecill.info". -* -* As a counterpart to the access to the source code and rights to copy, -* modify and redistribute granted by the license, users are provided only -* with a limited warranty and the software's author, the holder of the -* economic rights, and the successive licensors have only limited liability. -* -* In this respect, the user's attention is drawn to the risks associated -* with loading, using, modifying and/or developing or reproducing the -* software by the user in light of its specific status of free software, -* that may mean that it is complicated to manipulate, and that also -* therefore means that it is reserved for developers and experienced -* professionals having in-depth computer knowledge. Users are therefore -* encouraged to load and test the software's suitability as regards their -* requirements in conditions enabling the security of their systems and/or -* data to be ensured and, more generally, to use and operate it in the -* same conditions as regards security. -* The fact that you are presently reading this means that you have had -* knowledge of the CeCILL license and that you accept its terms. -* -* ParadisEO WebSite : http://paradiseo.gforge.inria.fr -* Contact: paradiseo-help@lists.gforge.inria.fr -* + + Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2008 + (C) OPAC Team, LIFL, 2002-2008 + + Sébastien Cahon, Jean-Charles Boisson + + This software is governed by the CeCILL license under French law and + abiding by the rules of distribution of free software. You can use, + modify and/ or redistribute the software under the terms of the CeCILL + license as circulated by CEA, CNRS and INRIA at the following URL + "http://www.cecill.info". + + As a counterpart to the access to the source code and rights to copy, + modify and redistribute granted by the license, users are provided only + with a limited warranty and the software's author, the holder of the + economic rights, and the successive licensors have only limited liability. + + In this respect, the user's attention is drawn to the risks associated + with loading, using, modifying and/or developing or reproducing the + software by the user in light of its specific status of free software, + that may mean that it is complicated to manipulate, and that also + therefore means that it is reserved for developers and experienced + professionals having in-depth computer knowledge. Users are therefore + encouraged to load and test the software's suitability as regards their + requirements in conditions enabling the security of their systems and/or + data to be ensured and, more generally, to use and operate it in the + same conditions as regards security. + The fact that you are presently reading this means that you have had + knowledge of the CeCILL license and that you accept its terms. + + ParadisEO WebSite : http://paradiseo.gforge.inria.fr + Contact: paradiseo-help@lists.gforge.inria.fr */ #include #include int -main (int __argc, char * __argv []) +main (int _argc, char* _argv []) { - if (__argc != 2) + if (_argc != 2) { - std :: cerr << "Usage : ./simulated_annealing [instance]" << std :: endl ; - return 1 ; + std :: cerr << "Usage : ./simulated_annealing [instance]" << std :: endl; + return EXIT_FAILURE; } - Graph :: load (__argv [1]) ; // Instance + Graph::load (_argv [1]); - Route route ; // Solution + Route solution; - RouteInit init ; // Sol. Random Init. - init (route) ; + RouteInit initializer; + initializer (solution); - RouteEval full_eval ; // Full. Eval. - full_eval (route) ; + RouteEval full_evaluation; + full_evaluation (solution); - std :: cout << "[From] " << route << std :: endl ; + std :: cout << "[From] " << solution << std :: endl; /* Tools for an efficient (? :-)) local search ! */ - TwoOptRand two_opt_rand ; // Route Random. Gen. + TwoOptRand two_opt_random_move_generator; - TwoOptIncrEval two_opt_incr_eval ; // Eff. eval. + TwoOptIncrEval two_opt_incremental_evaluation; - TwoOpt move ; + TwoOpt move; - moExponentialCoolingSchedule cool_sched (0.1, 0.98) ; // Exponential Cooling Schedule - //moLinearCoolingSchedule cool_sched (0.1, 0.5) ; // Linear Cooling Schedule + moExponentialCoolingSchedule cooling_schedule (0.1, 0.98); + //moLinearCoolingSchedule cooling_schedule (0.1, 0.5); - moGenSolContinue cont (1000) ; /* Temperature Descreasing - will occur each 1000 - iterations */ + moGenSolContinue continu (1000); /* Temperature Descreasing + will occur each 1000 + iterations */ - moSA simulated_annealing (two_opt_rand, two_opt_incr_eval, cont, 1000, cool_sched, full_eval) ; - simulated_annealing (route) ; + moSA simulated_annealing (two_opt_random_move_generator, two_opt_incremental_evaluation, + continu, 1000, cooling_schedule, full_evaluation); + simulated_annealing (solution); - std :: cout << "[To] " << route << std :: endl ; + std :: cout << "[To] " << solution << std :: endl; - return 0 ; + return EXIT_SUCCESS ; } diff --git a/trunk/paradiseo-mo/tutorial/Lesson4/iterated_local_search.cpp b/trunk/paradiseo-mo/tutorial/Lesson4/iterated_local_search.cpp index 0ed3d3a09..0ff328049 100644 --- a/trunk/paradiseo-mo/tutorial/Lesson4/iterated_local_search.cpp +++ b/trunk/paradiseo-mo/tutorial/Lesson4/iterated_local_search.cpp @@ -1,58 +1,82 @@ -// -*- mode: c++; c-indent-level: 4; c++-member-init-indent: 8; comment-column: 35; -*- +/* + + Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2008 + (C) OPAC Team, LIFL, 2002-2008 -// "iterated_local_search.cpp" + Sébastien Cahon, Jean-Charles Boisson -// (c) OPAC Team, LIFL, 2003-2007 + This software is governed by the CeCILL license under French law and + abiding by the rules of distribution of free software. You can use, + modify and/ or redistribute the software under the terms of the CeCILL + license as circulated by CEA, CNRS and INRIA at the following URL + "http://www.cecill.info". -/* LICENCE TEXT + As a counterpart to the access to the source code and rights to copy, + modify and redistribute granted by the license, users are provided only + with a limited warranty and the software's author, the holder of the + economic rights, and the successive licensors have only limited liability. - Contact: paradiseo-help@lists.gforge.inria.fr + In this respect, the user's attention is drawn to the risks associated + with loading, using, modifying and/or developing or reproducing the + software by the user in light of its specific status of free software, + that may mean that it is complicated to manipulate, and that also + therefore means that it is reserved for developers and experienced + professionals having in-depth computer knowledge. Users are therefore + encouraged to load and test the software's suitability as regards their + requirements in conditions enabling the security of their systems and/or + data to be ensured and, more generally, to use and operate it in the + same conditions as regards security. + The fact that you are presently reading this means that you have had + knowledge of the CeCILL license and that you accept its terms. + + ParadisEO WebSite : http://paradiseo.gforge.inria.fr + Contact: paradiseo-help@lists.gforge.inria.fr */ #include #include int -main (int __argc, char * __argv []) +main (int _argc, char* _argv []) { - if (__argc != 2) + if (_argc != 2) { std :: cerr << "Usage : ./iterated_local_search [instance]" << std :: endl ; - return 1 ; + return EXIT_FAILURE; } - Graph :: load (__argv [1]) ; // Instance + Graph::load (_argv [1]); - Route route ; // Solution + Route solution; - RouteInit init ; // Sol. Random Init. - init (route) ; + RouteInit initializer; + initializer (solution); - RouteEval full_eval ; // Full. Eval. - full_eval (route) ; + RouteEval full_evaluation; + full_evaluation (solution); - std :: cout << "[From] " << route << std :: endl ; + std :: cout << "[From] " << solution << std :: endl; - TwoOptInit two_opt_init ; // Init. + TwoOptInit two_opt_initializer; - TwoOptNext two_opt_next ; // Explorer. + TwoOptNext two_opt_next_move_generator; - TwoOptIncrEval two_opt_incr_eval ; // Eff. eval. + TwoOptIncrEval two_opt_incremental_evaluation; - moBestImprSelect two_opt_select ; //Move selection + moBestImprSelect two_opt_selection; - moGenSolContinue cont (1000) ; //Stopping criterion + moGenSolContinue continu(1000); - moFitComparator comparator; // Route comparator + moFitComparator comparator; - CitySwap perturbation; // Route perturbation + CitySwap perturbation; - moILS iterated_local_search (two_opt_init, two_opt_next, two_opt_incr_eval, two_opt_select, - cont, comparator, perturbation, full_eval) ; - iterated_local_search(route) ; + moILS iterated_local_search (two_opt_initializer, two_opt_next_move_generator, two_opt_incremental_evaluation, + two_opt_selection, continu, comparator, perturbation, full_evaluation) ; + iterated_local_search(solution); - std :: cout << "[To] " << route << std :: endl ; + std :: cout << "[To] " << solution << std :: endl; - return 0 ; + return EXIT_SUCCESS; }