Added many template files, and totally modified the comments in most other.

This was when preparing Evonet Summer School - though it finally was not used there!
This commit is contained in:
evomarc 2001-09-04 08:35:22 +00:00
commit 7bbdd17307
14 changed files with 855 additions and 96 deletions

View file

@ -1,54 +1,70 @@
/** -*- mode: c++; c-indent-level: 4; c++-member-init-indent: 8; comment-column: 35; -*-
The above line is usefulin Emacs-like editors
The above line is useful in Emacs-like editors
*/
/*
Template for simple binary crossover operators
==============================================
Binary crossover operators modify the first parent only,
Binary crossover operators modify the first genotype only,
based on the second
*/
#ifndef eoMyDerivedBinOp_H
#define eoMyDerivedBinOp_H
#ifndef eoMyStructBinCrossover_H
#define eoMyStructBinCrossover_H
#include <eoOp.h>
/**
Always write a comment in this format before class definition
if you want the class to be documented by Doxygen
*/
template<class Indi>
class eoMyDerivedBinOp: public eoBinOp<Indi>
* Always write a comment in this format before class definition
* if you want the class to be documented by Doxygen
*
* THere is NO ASSUMPTION on the class GenoypeT.
* In particular, it does not need to derive from EO
*/
template<class GenotypeT>
class eoMyStructBinCrossover: public eoBinOp<GenotypeT>
{
public:
/**
* (Default) Constructor.
* Ctor - no requirement
*/
eoMyDerivedBinOp(paramType _anyParameter) :
anyParameter(_anyParameter) {}
// START eventually add or modify the anyVariable argument
eoMyStructBinCrossover()
// eoMyStructBinCrossover( varType _anyVariable) : anyVariable(_anyVariable)
// END eventually add or modify the anyVariable argument
{
// START Code of Ctor of an eoMyStructEvalFunc object
// END Code of Ctor of an eoMyStructEvalFunc object
}
/// The class name. Used to display statistics
string className() const { return "eoMyDerivedBinOp"; }
string className() const { return "eoMyStructBinCrossover"; }
/**
* eoBin crossover - modifies first parent only
* @param Indi1 The first parent
* @param Indi2 The second parent - const
* binCrossover - modifies first genotype only
* @param _genotype1 The first genotype
* @param _genotype2 The second genotype - const
*/
bool operator()(Indi& Indi1, const Indi& Indi2)
bool operator()(GenotypeT & _genotype1, const GenotypeT & _genotype2)
{
// do whatever needs to be done
// if Indi1 has been modified
return true;
// otherwise
// return false;
// START code for crossover of _genotype1 and _genotype2 objects
/** Requirement
* if _genotype1 has been modified
* return true;
* otherwise
* return false;
*/
// END code for crossover of _genotype1 and _genotype2 objects
}
private:
paramType anyParameter
// START Private data of an eoMyStructBinCrossover object
// varType anyVariable; // for example ...
// END Private data of an eoMyStructBinCrossover object
};
#endif