Comments added to remove undocumented classes from Doxygen documentation

This commit is contained in:
evomarc 2001-01-30 04:53:05 +00:00
commit 097d34be39
4 changed files with 16 additions and 26 deletions

View file

@ -102,11 +102,12 @@ public:
virtual string className() const {return "eoBinOp";}; virtual string className() const {return "eoBinOp";};
}; };
// planning the change of name eoQuadraticOp --> eoQuadOp
#define eoQuadraticOp eoQuadOp
/** Quadratic genetic operator: subclasses eoOp, and defines basically the /** Quadratic genetic operator: subclasses eoOp, and defines basically the
operator() with two operands, both can be modified. operator() with two operands, both can be modified.
*/ */
#define eoQuadraticOp eoQuadOp
template<class EOType> template<class EOType>
class eoQuadraticOp: public eoOp<EOType>, public eoBF<EOType&, EOType&, void> { class eoQuadraticOp: public eoOp<EOType>, public eoBF<EOType&, EOType&, void> {
public: public:
@ -116,15 +117,19 @@ public:
virtual string className() const {return "eoQuadOp";}; virtual string className() const {return "eoQuadOp";};
}; };
// Turning an eoBinOp into an eoQuadOp is generic: /** Turning an eoQuadOp into an eoBinOp: simply don't touch the second arg!
*/
template <class EOT> template <class EOT>
class eoQuad2BinOp: public eoBinOp<EOT> class eoQuad2BinOp: public eoBinOp<EOT>
{ {
public: public:
// Ctor, from an eoQuadOp /** Ctor
* @param _quadOp the eoQuadOp to be transformed
*/
eoQuad2BinOp(eoQuadOp<EOT> & _quadOp) : quadOp(_quadOp) {} eoQuad2BinOp(eoQuadOp<EOT> & _quadOp) : quadOp(_quadOp) {}
// Operator() simply calls embedded quadOp operator() with dummy second arg /** Operator() simply calls embedded quadOp operator() with dummy second arg
*/
void operator()(EOT & _eo1, const EOT & _eo2) void operator()(EOT & _eo1, const EOT & _eo2)
{ {
EOT eoTmp = _eo2; // a copy that can be modified EOT eoTmp = _eo2; // a copy that can be modified

View file

@ -37,7 +37,7 @@
#include <utils/eoRNG.h> #include <utils/eoRNG.h>
#include <eoTransform.h> #include <eoTransform.h>
/***************************************************************************** /** ***************************************************************************
* eoSGATransform: transforms a population using genetic operators. * eoSGATransform: transforms a population using genetic operators.
* It does it exactly as class eoSGA, i.e. only accepts * It does it exactly as class eoSGA, i.e. only accepts
* quadratic crossover and unary mutation * quadratic crossover and unary mutation
@ -90,7 +90,7 @@ template<class EOT> class eoSGATransform : public eoTransform<EOT>
double mutationProba; double mutationProba;
}; };
/***************************************************************************** /** ***************************************************************************
* eoDynSGATransform: transforms a population using genetic operators. * eoDynSGATransform: transforms a population using genetic operators.
* It is the Dynamic version of the above eoSGATransform * It is the Dynamic version of the above eoSGATransform
* i.e. the operators probabilities can be passed as an eoValueParam, * i.e. the operators probabilities can be passed as an eoValueParam,

View file

@ -39,7 +39,7 @@ Basically, they exchange genes - we need some matching information to apply
atom crossover atom crossover
*/ */
//* A helper class for choosing which genes to exchange /** A helper class for choosing which genes to exchange */
template <class Atom> template <class Atom>
class eoAtomExchange : public eoBF<unsigned, Atom &, bool> class eoAtomExchange : public eoBF<unsigned, Atom &, bool>
{ {
@ -48,7 +48,7 @@ public:
virtual void randomize(unsigned int, unsigned int){} virtual void randomize(unsigned int, unsigned int){}
}; };
//* Uniform crossover - well, not really for FixedLength /** Uniform crossover - well, not really for FixedLength */
template <class Atom> template <class Atom>
class eoUniformAtomExchange: public eoAtomExchange<Atom> class eoUniformAtomExchange: public eoAtomExchange<Atom>
{ {

View file

@ -47,10 +47,7 @@ MS January 25. 2001
/** eoUniformMutation --> changes all values of the vector /** eoUniformMutation --> changes all values of the vector
by uniform choice with range epsilon by uniform choice with range epsilon
with probability p_change per variable with probability p_change per variable
\class eoUniformMutation eoRealOp.h Tutorial/eoRealOp.h
\ingroup parameteric
*/ */
template<class EOT> class eoGenericUniformMutation: public eoGenericMonOp<EOT> template<class EOT> class eoGenericUniformMutation: public eoGenericMonOp<EOT>
{ {
public: public:
@ -113,8 +110,6 @@ private:
/** eoDetUniformMutation --> changes exactly k values of the vector /** eoDetUniformMutation --> changes exactly k values of the vector
by uniform choice with range epsilon by uniform choice with range epsilon
\class eoDetUniformMutation eoRealOp.h Tutorial/eoRealOp.h
\ingroup parameteric
*/ */
template<class EOT> class eoGenericDetUniformMutation: template<class EOT> class eoGenericDetUniformMutation:
@ -173,14 +168,10 @@ private:
}; };
// two arithmetical crossovers
/** eoSegmentCrossover --> uniform choice in segment /** eoSegmentCrossover --> uniform choice in segment
== arithmetical with same value along all coordinates == arithmetical with same value along all coordinates
\class eoSegmentCrossover eoRealOp.h Tutorial/eoRealOp.h
\ingroup parameteric
*/ */
template<class EOT> class eoGenericSegmentCrossover: public eoGenericQuadOp<EOT> template<class EOT> class eoGenericSegmentCrossover: public eoGenericQuadOp<EOT>
{ {
public: public:
@ -266,11 +257,8 @@ protected:
}; };
/** eoArithmeticCrossover --> uniform choice in hypercube /** eoArithmeticCrossover --> uniform choice in hypercube
== arithmetical with different values for each coordinate == arithmetical with different values for each coordinate
\class eoArithmeticCrossover eoRealOp.h Tutorial/eoRealOp.h
\ingroup parameteric
*/ */
template<class EOT> class eoGenericArithmeticCrossover: template<class EOT> class eoGenericArithmeticCrossover:
public eoGenericQuadOp<EOT> public eoGenericQuadOp<EOT>
{ {
@ -366,10 +354,7 @@ protected:
/** eoRealUxOver --> Uniform crossover, also termed intermediate crossover /** eoRealUxOver --> Uniform crossover, also termed intermediate crossover
\class eoRealUxOver eoRealOp.h Tutorial/eoRealOp.h
\ingroup parameteric
*/ */
template<class EOT> class eoGenericRealUxOver: public eoGenericQuadOp<EOT> template<class EOT> class eoGenericRealUxOver: public eoGenericQuadOp<EOT>
{ {
public: public: