# ParadisEO-MOMovingObjects: moSimpleSolutionTabuList.h Source File

# moSimpleSolutionTabuList.h

    00001 /*
    00002   <moSimpleSolutionTabuList.h>
    00003   Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2008
    00004   (C) OPAC Team, LIFL, 2002-2008
    00005
    00006   Sébastien Cahon, Jean-Charles Boisson (Jean-Charles.Boisson@lifl.fr)
    00007
    00008   This software is governed by the CeCILL license under French law and
    00009   abiding by the rules of distribution of free software.  You can  use,
    00010   modify and/ or redistribute the software under the terms of the CeCILL
    00011   license as circulated by CEA, CNRS and INRIA at the following URL
    00012   "http://www.cecill.info".
    00013
    00014   As a counterpart to the access to the source code and  rights to copy,
    00015   modify and redistribute granted by the license, users are provided only
    00016   with a limited warranty  and the software's author,  the holder of the
    00017   economic rights,  and the successive licensors  have only  limited liability.
    00018
    00019   In this respect, the user's attention is drawn to the risks associated
    00020   with loading,  using,  modifying and/or developing or reproducing the
    00021   software by the user in light of its specific status of free software,
    00022   that may mean  that it is complicated to manipulate,  and  that  also
    00023   therefore means  that it is reserved for developers  and  experienced
    00024   professionals having in-depth computer knowledge. Users are therefore
    00025   encouraged to load and test the software's suitability as regards their
    00026   requirements in conditions enabling the security of their systems and/or
    00027   data to be ensured and,  more generally, to use and operate it in the
    00028   same conditions as regards security.
    00029   The fact that you are presently reading this means that you have had
    00030   knowledge of the CeCILL license and that you accept its terms.
    00031
    00032   ParadisEO WebSite : http://paradiseo.gforge.inria.fr
    00033   Contact: paradiseo-help@lists.gforge.inria.fr
    00034 */
    00035
    00036 #ifndef _moSimpleSolutionTabuList_h
    00037 #define _moSimpleSolutionTabuList_h
    00038
    00039 #include <list>
    00040 #include <iterator>
    00041
    00042 #include <moTabuList.h>
    00043
    00045 template <class M>
    00046 class moSimpleSolutionTabuList: public moTabuList < M >
    00047 {
    00048  public:
    00049
    00051   typedef typename M::EOType EOT;
    00052
    00054   typedef typename std::list<EOT>::iterator solutionIterator;
    00055
    00057
    00060  moSimpleSolutionTabuList(unsigned int _memory_maximum_size): memory_maximum_size(_memory_maximum_size), memory_size(0)
    00061     {}
    00062
    00064
    00069   bool operator () (const M & _move, const EOT & _solution)
    00070   {
    00071     solutionIterator it;
    00072
    00073     M move=(M)_move;
    00074     EOT solution=(EOT) _solution;
    00075
    00076     move(solution);
    00077
    00078     it=tabuList.begin();
    00079     // The code is !(*it)==_solution instead of (*it)!=_solution because people designing their specific solution representation
    00080     // will write the "==" operator (I hope) but not necessary the "!=" operator.
    00081     while (it!=tabuList.end()&&(!((*it)==solution)))
    00082       {
    00083         it++;
    00084       }
    00085
    00086     return it!=tabuList.end();
    00087   }
    00088
    00089   void add (const M & _move, const EOT & _solution)
    00090   {
    00091     M move=(M)_move;
    00092     EOT solution=(EOT) _solution;
    00093
    00094     _move(_solution);
    00095
    00096     if (memory_size!=0)
    00097       {
    00098         // Useful in the case of a solution has been kept thanks to the moAspirCrit.
    00099         // In this case, the solution can already be in the tabuList.
    00100         removeSolution(_solution);
    00101       }
    00102
    00103     tabuList.push_back(_solution);
    00104
    00105     if (memory_size == memory_maximum_size)
    00106       {
    00107         tabuList.erase(tabuList.begin());
    00108       }
    00109     else
    00110       {
    00111         memory_size++;
    00112       }
    00113   }
    00114
    00115   void update ()
    00116   {
    00117     //nothing to do
    00118   }
    00119
    00120   void init ()
    00121   {
    00122     //nothing to do
    00123   }
    00124
    00125  private:
    00126
    00128
    00131   void removeSolution(const EOT & _solution)
    00132   {
    00133     solutionIterator it;
    00134
    00135     it=tabuList.begin();
    00136     // The code is !(*it)==_solution instead of (*it)!=_solution because people designing their specific solution representation
    00137     // will write the "==" operator (I hope) but not necessary the "!=" operator.
    00138     while ( it!=tabuList.end() && !((*it)==_solution) )
    00139       {
    00140         it++;
    00141       }
    00142
    00143     if (it!=tabuList.end())
    00144       {
    00145         tabuList.erase(it);
    00146       }
    00147   }
    00148
    00150   unsigned int memory_maximum_size;
    00151
    00153   unsigned int memory_size;
    00154
    00156   std::list<EOT> tabuList;
    00157 };
    00158
    00159 #endif