Modified the comments so they appear in doxygen doc (and updated them also)

This commit is contained in:
evomarc 2002-04-09 08:48:44 +00:00
commit 9492ebd58e

View file

@ -37,12 +37,22 @@
//----------------------------------------------------------------------------- //-----------------------------------------------------------------------------
/** /**
eoReplacement: High level strategy for creating a new generation eoReplacement: the base class for all replacement functors.
from parents and offspring.
NOTE: 2 eoPop as arguments
the resulting population should be in the first argument (replace
parents by offspring)! The second argument can contain any rubbish
---
The eoMergeReduce, combination of eoMerge and eoReduce, can be found The eoMergeReduce, combination of eoMerge and eoReduce, can be found
in file eoMergeReduce.h in file eoMergeReduce.h
The eoReduceMergeReduce that reduces the parents and the offspring,
merges the 2 reduced populations, and eventually reduces that final
population, can be found in eoReduceMergeReduce.h
LOG
---
Removed the const before first argument: though it makes too many classes Removed the const before first argument: though it makes too many classes
with the same interface, it allows to minimize the number of actual copies with the same interface, it allows to minimize the number of actual copies
by choosing the right destination by choosing the right destination
@ -51,18 +61,12 @@ replacement gets a class of its own that only does the swap (instead of the
eoNoReplacement that did nothing, relying on the algo to swap popualtions). eoNoReplacement that did nothing, relying on the algo to swap popualtions).
MS 12/12/2000 MS 12/12/2000
NOTE: the resulting population should always be in the first argument
(replace parents by offspring)! The second argument can contain any rubbish
@see eoMerge, eoReduce, eoMergeReduce, eoReduceMerge @see eoMerge, eoReduce, eoMergeReduce, eoReduceMerge
@classes eoReplacement, base (pure abstract) class @classes eoReplacement, base (pure abstract) class
eoGenerationalReplacement, as it says ... eoGenerationalReplacement, as it says ...
eoWeakElitistReplacement a wrapper to add elitism eoWeakElitistReplacement a wrapper to add elitism
*/
/**
eoReplacement: the base class for all replacementp functors
*/ */
template<class EOT> template<class EOT>
class eoReplacement : public eoBF<eoPop<EOT>&, eoPop<EOT>&, void> class eoReplacement : public eoBF<eoPop<EOT>&, eoPop<EOT>&, void>