From fc2ea957a4b4c349eafa26ea4562f64570942d25 Mon Sep 17 00:00:00 2001
From: quemy <alexandre.quemy@gmail.com>
Date: Fri, 21 Dec 2012 11:39:46 +0100
Subject: [PATCH] Add function to wrap model in order to create homogeneous
 model easily

---
 smp/src/CMakeLists.txt                        |  4 +-
 smp/src/homogeneousModel.cpp                  | 58 -----------------
 smp/src/island.cpp                            |  1 -
 smp/src/island.h                              |  2 +
 ...omogeneousModel.h => islandModelWrapper.h} | 63 ++++++++++---------
 smp/src/smp.h                                 |  2 +-
 smp/test/CMakeLists.txt                       |  1 +
 7 files changed, 39 insertions(+), 92 deletions(-)
 delete mode 100644 smp/src/homogeneousModel.cpp
 rename smp/src/{homogeneousModel.h => islandModelWrapper.h} (60%)

diff --git a/smp/src/CMakeLists.txt b/smp/src/CMakeLists.txt
index a3c732e8a..b658067c0 100644
--- a/smp/src/CMakeLists.txt
+++ b/smp/src/CMakeLists.txt
@@ -29,6 +29,7 @@ set (SMP_FILE
     topology/hypercubic.cpp
     topology/mesh.cpp
     notifier.cpp
+    islandModelWrapper.h
     )
 
 add_library(smp STATIC ${SMP_FILE})
@@ -39,7 +40,7 @@ install(TARGETS smp ARCHIVE DESTINATION ${LIB} COMPONENT libraries)
 ### 3) Look for headers
 ######################################################################################
 
-file(GLOB HDRS smp *.h)
+file(GLOB HDRS smp *.h *.cpp)
 install(FILES ${HDRS} DESTINATION include${INSTALL_SUB_DIR}/smp COMPONENT headers)
 
 ######################################################################################
@@ -50,4 +51,5 @@ install(DIRECTORY MWAlgo topology
         DESTINATION include${INSTALL_SUB_DIR}/smp
         COMPONENT headers
         FILES_MATCHING PATTERN "*.h"
+        PATTERN "*.cpp"
         )
diff --git a/smp/src/homogeneousModel.cpp b/smp/src/homogeneousModel.cpp
deleted file mode 100644
index e30ea0079..000000000
--- a/smp/src/homogeneousModel.cpp
+++ /dev/null
@@ -1,58 +0,0 @@
-/*
-<homogeneousModel.cpp>
-Copyright (C) DOLPHIN Project-Team, INRIA Lille - Nord Europe, 2006-2012
-
-Alexandre Quemy, Thibault Lasnier - INSA Rouen
-
-This software is governed by the CeCILL license under French law and
-abiding by the rules of distribution of free software.  You can  ue,
-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".
-
-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
-*/
-
-template<template <class> class EOAlgo, class EOT>
-template<class... IslandInit>
-paradiseo::smp::HomogeneousIslandModel<EOAlgo, EOT>::HomogeneousIslandModel(unsigned _islandNumber, AbstractTopology& _topo, unsigned _popSize, eoInit<EOT> &_chromInit, IslandInit... args) :
-    model(_topo)
-{
-    pops.resize(_islandNumber);
-    islands.resize(_islandNumber);
-    for(unsigned i = 0; i < _islandNumber; i++)
-    {
-        pops[i] = eoPop<EOT>(_popSize, _chromInit);
-        islands[i] = new Island<EOAlgo, EOT>(pops[i], args...);
-        model.add(*islands[i]);
-    } 
-    
-    model();
-}
-
-template<template <class> class EOAlgo, class EOT>
-paradiseo::smp::HomogeneousIslandModel<EOAlgo, EOT>::~HomogeneousIslandModel()
-{
-    for(auto& island : islands)
-        delete island;
-}
-
-template<template <class> class EOAlgo, class EOT>
-std::vector<eoPop<EOT>>& paradiseo::smp::HomogeneousIslandModel<EOAlgo, EOT>::getPop()
-{
-    return pops;
-}
diff --git a/smp/src/island.cpp b/smp/src/island.cpp
index 996771f4e..22ab472cf 100644
--- a/smp/src/island.cpp
+++ b/smp/src/island.cpp
@@ -156,4 +156,3 @@ void paradiseo::smp::Island<EOAlgo,EOT,bEOT>::update(eoPop<bEOT> _data)
     std::lock_guard<std::mutex> lock(this->m);
     listImigrants.push(_data);
 }
-
diff --git a/smp/src/island.h b/smp/src/island.h
index 22fb881f7..44b5e83f8 100644
--- a/smp/src/island.h
+++ b/smp/src/island.h
@@ -125,6 +125,8 @@ public:
      */
     virtual void receive(void);
     
+    AIsland<bEOT> clone() const;
+    
 protected:
 
     /**
diff --git a/smp/src/homogeneousModel.h b/smp/src/islandModelWrapper.h
similarity index 60%
rename from smp/src/homogeneousModel.h
rename to smp/src/islandModelWrapper.h
index af6519828..13fe15634 100644
--- a/smp/src/homogeneousModel.h
+++ b/smp/src/islandModelWrapper.h
@@ -1,5 +1,5 @@
 /*
-<homogeneousModel.h>
+<islandModelWrapper.h>
 Copyright (C) DOLPHIN Project-Team, INRIA Lille - Nord Europe, 2006-2012
 
 Alexandre Quemy, Thibault Lasnier - INSA Rouen
@@ -34,6 +34,8 @@ Contact: paradiseo-help@lists.gforge.inria.fr
 #include <algorithm>
 #include <utility>
 #include <thread>
+#include <tuple>
+#include <vector>
 
 #include <bimap.h>
 #include <abstractIsland.h>
@@ -45,42 +47,41 @@ namespace paradiseo
 namespace smp
 {
 
-/** HomogeneousIslandModel: Wrapper to create homogeneous model easily
+/** IslandModelWrapper: Wrapper to create homogeneous model easily
+
+IslandModelWrapper is a function that creates an homogeneous model with the number
+of specified islands, built with same parameters.
 
 @see smp::IslandModel
 */
 
-template<template <class> class EOAlgo, class EOT>
-class HomogeneousIslandModel
+template<template <class> class EOAlgo, class EOT, class... IslandInit>
+std::vector<eoPop<EOT>> IslandModelWrapper(unsigned _islandNumber, AbstractTopology& _topo, unsigned _popSize, eoInit<EOT> &_chromInit, IslandInit... args)
 {
-public:
-     /**
-     * Constructor
-     * @param _islandNumber number of islands to create
-     * @param _topo Topology
-     * @param args... list of parameters according to the constructor of the island
-     */
-    template<class... IslandInit>
-    HomogeneousIslandModel(unsigned _islandNumber, AbstractTopology& _topo, unsigned _popSize, eoInit<EOT> &_chromInit, IslandInit... args);
+    // Model creation
+    IslandModel<EOT> model(_topo);
     
-    /**
-     * Destructor
-     */
-    ~HomogeneousIslandModel();
-
-    /**
-     * Get populations
-     * @return Populations
-     */
-    std::vector<eoPop<EOT>>& getPop();
-
-protected:
-    IslandModel<EOT> model;
-    std::vector<Island<EOAlgo,EOT>*> islands;
-    std::vector<eoPop<EOT>> pops;
-};
-
-#include <homogeneousModel.cpp>
+    // Island and pop containers
+    std::vector<Island<EOAlgo,EOT>*> islands(_islandNumber);
+    std::vector<eoPop<EOT>> pops(_islandNumber);
+    
+    // Generate islands and put them in the model
+    for(unsigned i = 0; i < _islandNumber; i++)
+    {
+        pops[i] = eoPop<EOT>(_popSize, _chromInit);
+        islands[i] = new Island<EOAlgo, EOT>(pops[i], args...);
+        model.add(*islands[i]);
+    }
+    
+    // Start the model
+    model();
+    
+    // Delete islands
+    for(auto& island : islands)
+        delete island;
+    
+    return pops;
+}
 
 }
 
diff --git a/smp/src/smp.h b/smp/src/smp.h
index 763c41fff..3840f67d6 100644
--- a/smp/src/smp.h
+++ b/smp/src/smp.h
@@ -33,7 +33,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
 #include <MWModel.h>
 #include <scheduler.h>
 #include <islandModel.h>
-#include <homogeneousModel.h>
+#include <islandModelWrapper.h>
 #include <island.h>
 #include <abstractIsland.h>
 #include <migPolicy.h>
diff --git a/smp/test/CMakeLists.txt b/smp/test/CMakeLists.txt
index b8a5e1a3b..d56ab97c1 100644
--- a/smp/test/CMakeLists.txt
+++ b/smp/test/CMakeLists.txt
@@ -19,6 +19,7 @@ set (TEST_LIST
         t-smpTopo
         t-smpMI_Homogeneous
         t-smpMI_Heterogeneous
+        t-smpMI_Wrapper
 		)
 
 ######################################################################################