nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Avancement de la doc

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@1654 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
jhumeau 2010-01-19 15:26:51 +00:00
commit 6a72d70f23
20 changed files with 487 additions and 1530 deletions
Download patch file Download diff file Expand all files Collapse all files

60
branches/newMo/src/neighborhood/moNeighbor.h
View file

@ -1,3 +1,39 @@
/*
<moNeighbor.h>
Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2008
(C) OPAC Team, LIFL, 2002-2008
Sébastien Cahon, Jean-Charles Boisson (Jean-Charles.Boisson@lifl.fr)
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
*/
#ifndef _moNeighbor_h
#define _moNeighbor_h
@ -8,7 +44,7 @@
#include <comparator/moNeighborComparator.h>
/*
/**
* Container of the neighbor informations
*/
template< class EOT , class Fitness >
@ -16,12 +52,12 @@ class moNeighbor : public eoObject, public eoPersistent
{
public:
/*
/**
* Default Constructor
*/
moNeighbor(){}
/*
/**
* Copy Constructor
* @param _neighbor to copy
*/
@ -29,9 +65,9 @@ public:
repFitness = _neighbor.fitness();
}
/*
/**
* Assignment operator
* @param the _neighbor to assign
* @param _neighbor the neighbor to assign
* @return a neighbor equal to the other
*/
virtual moNeighbor<EOT, Fitness>& operator=(const moNeighbor<EOT, Fitness>& _neighbor) {
@ -39,13 +75,13 @@ public:
return (*this);
}
/*
/**
* Move a solution
* @param _solution the related solution
*/
virtual void move(EOT & _solution) = 0 ;
/*
/**
* Get the fitness of the neighbor
* @return fitness of the neighbor
*/
@ -54,7 +90,7 @@ public:
}
/*
/**
* Get fitness as reference, useful when fitness is set in a multi-stage way, e.g., MOFitness gets performance information, is subsequently ranked
* @return fitness as reference of the neighbor
*/
@ -62,7 +98,7 @@ public:
return repFitness;
}
/*
/**
* Set fitness. At the same time, validates it.
* @param _fitness new fitness value.
*/
@ -70,13 +106,13 @@ public:
repFitness = _fitness;
}
/*
/**
* Return the class id.
* @return the class name as a std::string
*/
virtual std::string className() const { return "moNeighbor"; }
/*
/**
* Read object.
* Calls base class, just in case that one had something to do.
* The read and print methods should be compatible and have the same format.
@ -87,7 +123,7 @@ public:
_is >> repFitness;
}
/*
/**
* Write object. Called printOn since it prints the object _on_ a stream.
* @param _os A std::ostream.
*/