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

Avoid generating documentation on undocumented sources.

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@1474 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
fatene 2009-03-05 10:33:51 +00:00
commit 8f499ab64e
5 changed files with 77 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

2
trunk/paradiseo-peo/src/core/peo_debug.cpp
View file

@ -102,7 +102,7 @@ void printDebugMessage (const char * __mess)
sprintf (buff, "[%s][%s: ", host, localTime ); sprintf (buff, "[%s][%s: ", host, localTime );
for (unsigned i = 0; i < files.size (); i ++) for (unsigned i = 0; i < files.size (); i ++)
fprintf (files [i], buff); fprintf (files [i],"%s" ,buff);
/* Message */ /* Message */
sprintf (buff, "%s", __mess); sprintf (buff, "%s", __mess);

65
trunk/paradiseo-peo/src/peoData.h
View file

@ -43,48 +43,55 @@
/**************************************************************************************/ /**************************************************************************************/
/************************** DEFINE A CONTINUATOR ***********************************/ /************************** DEFINE A CONTINUATOR ***********************************/
/**************************************************************************************/ /**************************************************************************************/
/*
//! @class continuator //! @class continuator
//! @brief Abstract class for a continuator within the exchange of data by migration //! @brief Abstract class for a continuator within the exchange of data by migration
//! @version 1.0 //! @version 1.0
//! @date january 2008 //! @date january 2008
*/
class continuator class continuator
{ {
public: public:
/*
//! @brief Virtual function of check //! @brief Virtual function of check
//! @return true if the algorithm must continue //! @return true if the algorithm must continue
*/
virtual bool check()=0; virtual bool check()=0;
//! @brief Virtual destructor // //! @brief Virtual destructor
virtual ~continuator(){} virtual ~continuator(){}
}; };
/*
//! @class eoContinuator //! @class eoContinuator
//! @brief Specific class for a continuator within the exchange of migration of a population //! @brief Specific class for a continuator within the exchange of migration of a population
//! @see continuator //! @see continuator
//! @version 1.0 //! @version 1.0
//! @date january 2008 //! @date january 2008
*/
template < class EOT> class eoContinuator : public continuator template < class EOT> class eoContinuator : public continuator
{ {
public: public:
/*
//! @brief Constructor //! @brief Constructor
//! @param eoContinue<EOT> & //! @param eoContinue<EOT> &
//! @param eoPop<EOT> & //! @param eoPop<EOT> &
*/
eoContinuator(eoContinue<EOT> & _cont, const eoPop<EOT> & _pop): cont (_cont), pop(_pop) eoContinuator(eoContinue<EOT> & _cont, const eoPop<EOT> & _pop): cont (_cont), pop(_pop)
{} {}
/*
//! @brief Virtual function of check //! @brief Virtual function of check
//! @return false if the algorithm must continue //! @return false if the algorithm must continue
*/
virtual bool check() virtual bool check()
{ {
return cont(pop); return cont(pop);
} }
protected: protected:
/*
//! @param eoContinue<EOT> & //! @param eoContinue<EOT> &
//! @param eoPop<EOT> & //! @param eoPop<EOT> &
*/
eoContinue<EOT> & cont ; eoContinue<EOT> & cont ;
const eoPop<EOT> & pop; const eoPop<EOT> & pop;
}; };
@ -93,41 +100,46 @@ template < class EOT> class eoContinuator : public continuator
/**************************************************************************************/ /**************************************************************************************/
/************************** DEFINE A SELECTOR **************************************/ /************************** DEFINE A SELECTOR **************************************/
/**************************************************************************************/ /**************************************************************************************/
/*
//! @class selector //! @class selector
//! @brief Abstract class for a selector within the exchange of data by migration //! @brief Abstract class for a selector within the exchange of data by migration
//! @version 1.0 //! @version 1.0
//! @date january 2008 //! @date january 2008
*/
template < class TYPE> class selector template < class TYPE> class selector
{ {
public: public:
/*
//! @brief Virtual operator on the template type //! @brief Virtual operator on the template type
//! @param TYPE & //! @param TYPE &
*/
virtual void operator()(TYPE &)=0; virtual void operator()(TYPE &)=0;
//! @brief Virtual destructor // //! @brief Virtual destructor
virtual ~selector(){} virtual ~selector(){}
}; };
/*
//! @class eoSelector //! @class eoSelector
//! @brief Specific class for a selector within the exchange of migration of a population //! @brief Specific class for a selector within the exchange of migration of a population
//! @see selector //! @see selector
//! @version 1.0 //! @version 1.0
//! @date january 2008 //! @date january 2008
*/
template < class EOT, class TYPE> class eoSelector : public selector< TYPE > template < class EOT, class TYPE> class eoSelector : public selector< TYPE >
{ {
public: public:
/*
//! @brief Constructor //! @brief Constructor
//! @param eoSelectOne<EOT> & //! @param eoSelectOne<EOT> &
//! @param unsigned _nb_select //! @param unsigned _nb_select
//! @param TYPE & _source (with TYPE which is the template type) //! @param TYPE & _source (with TYPE which is the template type)
*/
eoSelector(eoSelectOne<EOT> & _select, unsigned _nb_select, const TYPE & _source): selector (_select), nb_select(_nb_select), source(_source) eoSelector(eoSelectOne<EOT> & _select, unsigned _nb_select, const TYPE & _source): selector (_select), nb_select(_nb_select), source(_source)
{} {}
/*
//! @brief Virtual operator on the template type //! @brief Virtual operator on the template type
//! @param TYPE & _dest //! @param TYPE & _dest
*/
virtual void operator()(TYPE & _dest) virtual void operator()(TYPE & _dest)
{ {
size_t target = static_cast<size_t>(nb_select); size_t target = static_cast<size_t>(nb_select);
@ -137,9 +149,11 @@ template < class EOT, class TYPE> class eoSelector : public selector< TYPE >
} }
protected: protected:
/*
//! @param eoSelectOne<EOT> & //! @param eoSelectOne<EOT> &
//! @param unsigned nb_select //! @param unsigned nb_select
//! @param TYPE & source //! @param TYPE & source
*/
eoSelectOne<EOT> & selector ; eoSelectOne<EOT> & selector ;
unsigned nb_select; unsigned nb_select;
const TYPE & source; const TYPE & source;
@ -149,46 +163,55 @@ template < class EOT, class TYPE> class eoSelector : public selector< TYPE >
/**************************************************************************************/ /**************************************************************************************/
/************************** DEFINE A REPLACEMENT ***********************************/ /************************** DEFINE A REPLACEMENT ***********************************/
/**************************************************************************************/ /**************************************************************************************/
/*
//! @class replacement //! @class replacement
//! @brief Abstract class for a replacement within the exchange of data by migration //! @brief Abstract class for a replacement within the exchange of data by migration
//! @version 1.0 //! @version 1.0
//! @date january 2008 //! @date january 2008
*/
template < class TYPE> class replacement template < class TYPE> class replacement
{ {
public: public:
/*
//! @brief Virtual operator on the template type //! @brief Virtual operator on the template type
//! @param TYPE & //! @param TYPE &
*/
virtual void operator()(TYPE &)=0; virtual void operator()(TYPE &)=0;
//! @brief Virtual destructor // //! @brief Virtual destructor
virtual ~replacement(){} virtual ~replacement(){}
}; };
/*
//! @class eoReplace //! @class eoReplace
//! @brief Specific class for a replacement within the exchange of migration of a population //! @brief Specific class for a replacement within the exchange of migration of a population
//! @see replacement //! @see replacement
//! @version 1.0 //! @version 1.0
//! @date january 2008 //! @date january 2008
*/
template < class EOT, class TYPE> class eoReplace : public replacement< TYPE > template < class EOT, class TYPE> class eoReplace : public replacement< TYPE >
{ {
public: public:
/*
//! @brief Constructor //! @brief Constructor
//! @param eoReplacement<EOT> & //! @param eoReplacement<EOT> &
//! @param TYPE & _destination (with TYPE which is the template type) //! @param TYPE & _destination (with TYPE which is the template type)
*/
eoReplace(eoReplacement<EOT> & _replace, TYPE & _destination): replace(_replace), destination(_destination) eoReplace(eoReplacement<EOT> & _replace, TYPE & _destination): replace(_replace), destination(_destination)
{} {}
/*
//! @brief Virtual operator on the template type //! @brief Virtual operator on the template type
//! @param TYPE & _source //! @param TYPE & _source
*/
virtual void operator()(TYPE & _source) virtual void operator()(TYPE & _source)
{ {
replace(destination, _source); replace(destination, _source);
} }
protected: protected:
/*
//! @param eoReplacement<EOT> & //! @param eoReplacement<EOT> &
//! @param TYPE & destination //! @param TYPE & destination
*/
eoReplacement<EOT> & replace; eoReplacement<EOT> & replace;
TYPE & destination; TYPE & destination;
}; };
@ -197,24 +220,28 @@ template < class EOT, class TYPE> class eoReplace : public replacement< TYPE >
/**************************************************************************************/ /**************************************************************************************/
/************************ Continuator for synchrone migartion ************************/ /************************ Continuator for synchrone migartion ************************/
/**************************************************************************************/ /**************************************************************************************/
/*
//! @class eoSyncContinue //! @class eoSyncContinue
//! @brief Class for a continuator within the exchange of data by synchrone migration //! @brief Class for a continuator within the exchange of data by synchrone migration
//! @see continuator //! @see continuator
//! @version 1.0 //! @version 1.0
//! @date january 2008 //! @date january 2008
*/
class eoSyncContinue: public continuator class eoSyncContinue: public continuator
{ {
public: public:
/*
//! @brief Constructor //! @brief Constructor
//! @param unsigned __period //! @param unsigned __period
//! @param unsigned __init_counter //! @param unsigned __init_counter
*/
eoSyncContinue (unsigned __period, unsigned __init_counter = 0): period (__period),counter (__init_counter) eoSyncContinue (unsigned __period, unsigned __init_counter = 0): period (__period),counter (__init_counter)
{} {}
/*
//! @brief Virtual function of check //! @brief Virtual function of check
//! @return true if the algorithm must continue //! @return true if the algorithm must continue
*/
virtual bool check() virtual bool check()
{ {
return ((++ counter) % period) != 0 ; return ((++ counter) % period) != 0 ;
@ -222,8 +249,10 @@ class eoSyncContinue: public continuator
private: private:
/*
//! @param unsigned period //! @param unsigned period
//! @param unsigned counter //! @param unsigned counter
*/
unsigned period; unsigned period;
unsigned counter; unsigned counter;
}; };

11
trunk/paradiseo-peo/src/peoEvalFunc.h
View file

@ -36,12 +36,13 @@
#ifndef PEOEVALFUNC_H #ifndef PEOEVALFUNC_H
#define PEOEVALFUNC_H #define PEOEVALFUNC_H
/*
//! @class peoEvalFunc //! @class peoEvalFunc
//! @brief Specific class for evaluation //! @brief Specific class for evaluation
//! @see eoEvalFunc //! @see eoEvalFunc
//! @version 1.0 //! @version 1.0
//! @date november 2007 //! @date november 2007
*/
#ifdef _MSC_VER #ifdef _MSC_VER
template< class EOT, class FitT = EOT::Fitness, class FunctionArg = const EOT& > template< class EOT, class FitT = EOT::Fitness, class FunctionArg = const EOT& >
#else #else
@ -49,22 +50,24 @@ template< class EOT, class FitT = typename EOT::Fitness, class FunctionArg = con
#endif #endif
struct peoEvalFunc: public eoEvalFunc<EOT> struct peoEvalFunc: public eoEvalFunc<EOT>
{ {
/*
//! @brief Constructor //! @brief Constructor
//! @param FitT (* _eval)( FunctionArg ) //! @param FitT (* _eval)( FunctionArg )
*/
peoEvalFunc( FitT (* _eval)( FunctionArg ) ) peoEvalFunc( FitT (* _eval)( FunctionArg ) )
: eoEvalFunc<EOT>(), evalFunc( _eval ) : eoEvalFunc<EOT>(), evalFunc( _eval )
{}; {};
/*
//! @brief Virtual operator //! @brief Virtual operator
//! @param EOT & _peo //! @param EOT & _peo
*/
virtual void operator() ( EOT & _peo ) virtual void operator() ( EOT & _peo )
{ {
_peo.fitness((*evalFunc)( _peo )); _peo.fitness((*evalFunc)( _peo ));
}; };
private: private:
//! @param FitT (* evalFunc )( FunctionArg ) // //! @param FitT (* evalFunc )( FunctionArg )
FitT (* evalFunc )( FunctionArg ); FitT (* evalFunc )( FunctionArg );
}; };

34
trunk/paradiseo-peo/src/peoPSO.h
View file

@ -45,27 +45,30 @@
#include <utils/eoHowMany.h> #include <utils/eoHowMany.h>
#include <eoSelectOne.h> #include <eoSelectOne.h>
/*
//! @class peoPSOSelect //! @class peoPSOSelect
//! @brief Specific class for a selection of a population of a PSO //! @brief Specific class for a selection of a population of a PSO
//! @see eoSelectOne //! @see eoSelectOne
//! @version 1.1 //! @version 1.1
//! @date october 2007 //! @date october 2007
*/
template <class POT> class peoPSOSelect: public eoSelectOne<POT> template <class POT> class peoPSOSelect: public eoSelectOne<POT>
{ {
public: public:
/*
//! @brief Constructor //! @brief Constructor
//! @param eoTopology < POT > & _topology //! @param eoTopology < POT > & _topology
*/
peoPSOSelect(eoTopology < POT > & _topology):topology(_topology) peoPSOSelect(eoTopology < POT > & _topology):topology(_topology)
{} {}
//! @brief typedef : creation of Fitness // //! @brief typedef : creation of Fitness
typedef typename PO < POT >::Fitness Fitness; typedef typename PO < POT >::Fitness Fitness;
/*
//! @brief Virtual operator //! @brief Virtual operator
//! @param eoPop<POT>& _pop //! @param eoPop<POT>& _pop
//! @return POT& //! @return POT&
*/
virtual const POT& operator()(const eoPop<POT>& _pop) virtual const POT& operator()(const eoPop<POT>& _pop)
{ {
//return topology.globalBest(_pop); //return topology.globalBest(_pop);
@ -73,32 +76,35 @@ template <class POT> class peoPSOSelect: public eoSelectOne<POT>
} }
private: private:
//! @param eoTopology < POT > & topology // //! @param eoTopology < POT > & topology
eoTopology < POT > & topology; eoTopology < POT > & topology;
}; };
/*
//! @class peoGlobalBestVelocity //! @class peoGlobalBestVelocity
//! @brief Specific class for a replacement thanks to the velocity migration of a population of a PSO //! @brief Specific class for a replacement thanks to the velocity migration of a population of a PSO
//! @see eoReplacement //! @see eoReplacement
//! @version 1.1 //! @version 1.1
//! @date october 2007 //! @date october 2007
*/
template <class POT> template <class POT>
class peoGlobalBestVelocity : public eoReplacement<POT> class peoGlobalBestVelocity : public eoReplacement<POT>
{ {
public: public:
//! @brief typedef : creation of VelocityType // //! @brief typedef : creation of VelocityType
typedef typename POT::ParticleVelocityType VelocityType; typedef typename POT::ParticleVelocityType VelocityType;
/*
//! @brief Constructor //! @brief Constructor
//! @param double & _c3 //! @param double & _c3
//! @param eoVelocity < POT > &_velocity //! @param eoVelocity < POT > &_velocity
*/
peoGlobalBestVelocity( const double & _c3, eoVelocity < POT > &_velocity): c3 (_c3),velocity (_velocity) peoGlobalBestVelocity( const double & _c3, eoVelocity < POT > &_velocity): c3 (_c3),velocity (_velocity)
{} {}
/*
//! @brief Virtual operator //! @brief Virtual operator
//! @param eoPop<POT>& _dest //! @param eoPop<POT>& _dest
//! @param eoPop<POT>& _source //! @param eoPop<POT>& _source
*/
void operator()(eoPop<POT>& _dest, eoPop<POT>& _source) void operator()(eoPop<POT>& _dest, eoPop<POT>& _source)
{ {
@ -114,27 +120,31 @@ class peoGlobalBestVelocity : public eoReplacement<POT>
} }
protected: protected:
/*
//! @param double & c3 //! @param double & c3
//! @param eoVelocity < POT > & velocity //! @param eoVelocity < POT > & velocity
*/
const double & c3; const double & c3;
eoVelocity < POT > & velocity; eoVelocity < POT > & velocity;
}; };
/*
//! @class peoWorstPositionReplacement //! @class peoWorstPositionReplacement
//! @brief Specific class for a replacement of a population of a PSO //! @brief Specific class for a replacement of a population of a PSO
//! @see eoReplacement //! @see eoReplacement
//! @version 1.1 //! @version 1.1
//! @date october 2007 //! @date october 2007
*/
template <class POT> class peoWorstPositionReplacement : public eoReplacement<POT> template <class POT> class peoWorstPositionReplacement : public eoReplacement<POT>
{ {
public: public:
//! @brief constructor // //! @brief constructor
peoWorstPositionReplacement() peoWorstPositionReplacement()
{} {}
/*
//! @brief operator //! @brief operator
//! @param eoPop<POT>& _dest //! @param eoPop<POT>& _dest
//! @param eoPop<POT>& _source //! @param eoPop<POT>& _source
*/
void operator()(eoPop<POT>& _dest, eoPop<POT>& _source) void operator()(eoPop<POT>& _dest, eoPop<POT>& _source)
{ {
unsigned ind=0; unsigned ind=0;

18
trunk/paradiseo-peo/src/peoPopEval.h
View file

@ -246,12 +246,6 @@ template< class EOT > void peoPopEval< EOT > :: unpackResult()
{ {
long int __fit; unpack( __fit );fit = __fit; long int __fit; unpack( __fit );fit = __fit;
} }
/*
if ( type[position] == types[3])
{
long long int __fit; unpack( __fit );fit = __fit;
}
* */
if ( type[position] == types[4]) if ( type[position] == types[4])
{ {
unsigned int __fit; unpack( __fit );fit = __fit; unsigned int __fit; unpack( __fit );fit = __fit;
@ -264,12 +258,6 @@ template< class EOT > void peoPopEval< EOT > :: unpackResult()
{ {
unsigned long __fit; unpack( __fit );fit = __fit; unsigned long __fit; unpack( __fit );fit = __fit;
} }
/*
if ( type[position] == types[7])
{
unsigned long long __fit; unpack( __fit );fit = __fit;
}
*/
if ( type[position] == types[8]) if ( type[position] == types[8])
{ {
float __fit; unpack( __fit );fit = __fit; float __fit; unpack( __fit );fit = __fit;
@ -278,12 +266,6 @@ template< class EOT > void peoPopEval< EOT > :: unpackResult()
{ {
double __fit; unpack( __fit );fit = __fit; double __fit; unpack( __fit );fit = __fit;
} }
/*
if ( type[position] == types[10])
{
long double __fit; unpack( __fit );fit = __fit;
}
*/
} }