updated documentation
This commit is contained in:
parent
df56ae5145
commit
0219de5b61
3 changed files with 10 additions and 4 deletions
|
|
@ -30,7 +30,6 @@
|
||||||
#include <vector>
|
#include <vector>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
\ingroup EvolutionStrategies
|
|
||||||
|
|
||||||
Base class for fixed length chromosomes, just derives from EO and vector and
|
Base class for fixed length chromosomes, just derives from EO and vector and
|
||||||
redirects the smaller than operator to EO (fitness based comparison)
|
redirects the smaller than operator to EO (fitness based comparison)
|
||||||
|
|
|
||||||
|
|
@ -43,6 +43,14 @@ This is the base class for the whole hierarchy; an eoObject defines
|
||||||
basically an interface for the whole hierarchy: each object should
|
basically an interface for the whole hierarchy: each object should
|
||||||
know its name (#className#). Previously, this object defined a print and read
|
know its name (#className#). Previously, this object defined a print and read
|
||||||
interface, but it´s been moved to eoPrintable and eoPersistent.
|
interface, but it´s been moved to eoPrintable and eoPersistent.
|
||||||
|
|
||||||
|
It is recommended that you only derive from eoObject in concrete classes.
|
||||||
|
Some parts of EO do not implement this yet, but that will change in the future.
|
||||||
|
eoObject, together with eoPersistent and eoPrintable provide a simple persistence
|
||||||
|
framework that is only needed when the classes have state that changes at runtime.
|
||||||
|
|
||||||
|
@see eoPersistent eoPrintable
|
||||||
|
|
||||||
*/
|
*/
|
||||||
class eoObject
|
class eoObject
|
||||||
{
|
{
|
||||||
|
|
@ -56,7 +64,8 @@ class eoObject
|
||||||
Maarten: removed the default implementation as this proved to
|
Maarten: removed the default implementation as this proved to
|
||||||
be too error-prone: I found several classes that had a typo in
|
be too error-prone: I found several classes that had a typo in
|
||||||
className (like classname), which would print eoObject instead of
|
className (like classname), which would print eoObject instead of
|
||||||
their own...
|
their own. Having it pure will force the implementor to provide a
|
||||||
|
name.
|
||||||
*/
|
*/
|
||||||
virtual string className() const = 0;
|
virtual string className() const = 0;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -30,8 +30,6 @@
|
||||||
#include <list>
|
#include <list>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
\ingroup EvolutionStrategies
|
|
||||||
|
|
||||||
Base class for variable length chromosomes, just derives from EO and list and
|
Base class for variable length chromosomes, just derives from EO and list and
|
||||||
redirects the smaller than operator to EO (fitness based comparison)
|
redirects the smaller than operator to EO (fitness based comparison)
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
Reference in a new issue