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

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

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