From 841e0fc9b66ea9931f995c277c857e3d50e994f2 Mon Sep 17 00:00:00 2001 From: boufaras Date: Wed, 1 Jun 2011 08:29:37 +0000 Subject: [PATCH] update comment git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@2276 331e1502-861f-0410-8da2-ba01fb791d7f --- .../src/neighborhood/moIndexNeighbor.h | 173 ++++++++++-------- 1 file changed, 92 insertions(+), 81 deletions(-) diff --git a/trunk/paradiseo-mo/src/neighborhood/moIndexNeighbor.h b/trunk/paradiseo-mo/src/neighborhood/moIndexNeighbor.h index e4e7448bb..afc085d7e 100644 --- a/trunk/paradiseo-mo/src/neighborhood/moIndexNeighbor.h +++ b/trunk/paradiseo-mo/src/neighborhood/moIndexNeighbor.h @@ -1,36 +1,36 @@ /* - - Copyright (C) DOLPHIN Project-Team, INRIA Lille - Nord Europe, 2006-2010 + + Copyright (C) DOLPHIN Project-Team, INRIA Lille - Nord Europe, 2006-2010 - Sébastien Verel, Arnaud Liefooghe, Jérémie Humeau + Sébastien Verel, Arnaud Liefooghe, Jérémie Humeau - 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". + 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. + 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. + 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 -*/ + ParadisEO WebSite : http://paradiseo.gforge.inria.fr + Contact: paradiseo-help@lists.gforge.inria.fr + */ #ifndef _IndexNeighbor_h #define _IndexNeighbor_h @@ -40,72 +40,83 @@ /** * Index Neighbor */ -template< class EOT, class Fitness=typename EOT::Fitness > -class moIndexNeighbor : virtual public moNeighbor -{ +template +class moIndexNeighbor: virtual public moNeighbor { public: - using moNeighbor::fitness; + using moNeighbor::fitness; - /** - * Default Constructor - */ - moIndexNeighbor() : moNeighbor(), key(0) {} + /** + * Default Constructor + */ + moIndexNeighbor() : + moNeighbor (), key(0) { + } - /** - * Copy Constructor - * @param _n the neighbor to copy - */ - moIndexNeighbor(const moIndexNeighbor& _n) : moNeighbor(_n) { - this->key = _n.key ; - } + /** + * Copy Constructor + * @param _n the neighbor to copy + */ + moIndexNeighbor(const moIndexNeighbor& _n) : + moNeighbor (_n) { + this->key = _n.key; + } - /** - * Assignment operator - * @param _source the source neighbor - */ + /** + * Assignment operator + * @param _source the source neighbor + */ - moIndexNeighbor & operator=(const moIndexNeighbor & _source) { - moNeighbor::operator=(_source); - this->key = _source.key ; - return *this ; - } + moIndexNeighbor & operator=(const moIndexNeighbor & _source) { + moNeighbor::operator=(_source); + this->key = _source.key; + return *this; + } - /** - * Return the class Name - * @return the class name as a std::string - */ - virtual std::string className() const { - return "moIndexNeighbor"; - } + /** + * Move a solution + * @param _solution the related solution + */ + virtual void move(EOT & _solution) { - /** - * Getter - * @return index of the IndexNeighbor - */ - unsigned int index() { - return key; - } + } - /** - * Setter - * @param _key index of the IndexNeighbor - */ - void index(unsigned int _key) { - key=_key; - } + /** + * Return the class Name + * @return the class name as a std::string + */ + virtual std::string className() const { + return "moIndexNeighbor"; + } - /** - * @param _neighbor a neighbor - * @return if _neighbor and this one are equals - */ - virtual bool equals(moIndexNeighbor& _neighbor) { - return (key==_neighbor.index()); - } + /** + * Getter + * @return index of the IndexNeighbor + */ + unsigned int index() { + return key; + } + + /** + * Setter + * @param _key index of the IndexNeighbor + */ + void index(unsigned int _key) { + key = _key; + } + + /** + * @param _neighbor a neighbor + * @return if _neighbor and this one are equals + */ + virtual bool equals(moIndexNeighbor& _neighbor) { + return (key == _neighbor.index()); + } protected: - // key allowing to describe the neighbor - unsigned int key; + // key allowing to describe the neighbor + unsigned int key; };