Improve comments and documentation.
[genetic.git] / src / fitness / example.h
index 46d89075762e44722153c9c0f8afa1d46182fe90..522b9d30c0675d2b6212d2da3922c1db8bb2085b 100644 (file)
@@ -11,17 +11,23 @@ namespace genetic {
     /**
      * Just an example Fitness function.
      */
-    template < typename _Chromosome >
-    class FitnessExample {
+    template <typename _Chromosome, typename _Value = double>
+    class FitnessExample : public Fitness<_Chromosome, _Value> {
     protected:
-        _Chromosome chromosome;
+        /*
+         * Chromosome is inherited so you don't have to declare usage of one
+         */
+        /* _Chromosome chromosome; */
     public:
+        /**
+         * Example class constructor
+         */
         FitnessExample(_Chromosome& _chromosome)
-            : chromosome(_chromosome.get()) {
+            : Fitness<_Chromosome>(_chromosome) {
         }
 
-        /*
-         * Some calculations here...
+        /**
+         * Some calculations should be passed here...
          */
         double calculate() {
             return 0;