Changeset 760 for cpp/frams/genetics/f4/conv_f4.h

Timestamp:

03/15/18 22:55:05 (6 years ago)

Author:

Maciej Komosinski

Message:

• added support for new API for neuron types and their properties
• added support for checkpoints

File:

• cpp/frams/genetics/f4/conv_f4.h (modified) (3 diffs)

cpp/frams/genetics/f4/conv_f4.h

@@ -5 +5 @@
 // Copyright (C) 1999,2000  Adam Rotaru-Varga (adam_rotaru@yahoo.com), GNU LGPL
 // Copyright (C) since 2001 Maciej Komosinski
+// 2018, Grzegorz Latosinski, added support for new API for neuron types and their properties
 
 #ifndef _CONV_F4_H_
@@ -15 +16 @@
 
 
-// The f4->f0 converter
+/**
+ * Genotype converter from f4 to f0.
+ */
 class GenoConv_f40 : public GenoConverter
 {
 public:
         GenoConv_f40();
+
+        /**
+         * Performs conversion from f4 to f0. Creates f4_Model from f4 genotype
+         * and converts the Model to the f0 genotype string.
+         * @param in f4 genotype
+         * @param map mapping from f4 to Model
+         * @param using_checkpoints determines if checkpoints will be available
+         * @return generated f0 genotype
+         */
         SString convert(SString &in, MultiMap * map, bool using_checkpoints);
 };
 
 
-// a test-only f4->f1 converter, approximates only
+/**
+ * Genotype converter from f4 to f1. This is only experimental conversion and
+ * returns an approximate f1 genotype.
+ */
 class GenoConv_F41_TestOnly : public GenoConverter
 {
 public:
+        /**
+         * Initializes converter.
+         */
         GenoConv_F41_TestOnly();
+
+        /**
+         * Performs conversion from f4 to f1. Creates f4_Model from f4 genotype
+         * and converts the Model to the f1 genotype string. The final f1 genotype is
+         * an approximation.
+         * @param in f4 genotype
+         * @param map mapping from f4 to Model
+         * @param using_checkpoints determines if checkpoints will be available
+         * @return generated approximate f1 genotype
+         */
         SString convert(SString &in, MultiMap * map, bool using_checkpoints);
 };
 
 
-// A Model descendant, which support build from an f4 genotype.
+/**
+ * A Model descendant which supports building from an f4 genotype.
+ */
 class f4_Model : public Model
 {
@@ -39 +69 @@
         f4_Model();
         ~f4_Model();
-        int      buildFromF4(SString &geno);
+
+        /**
+         * Builds a Model from the f4 genotype string.
+         * @param geno genotype string
+         * @return GENOPER_OK if a Model could be created, error code otherwise
+         */
+        int      buildFromF4(SString &geno, bool using_checkpoints);
+        /**
+         * Outputs a Model in f1 format. It is an approximation of the input f4 genotype.
+         * @param out the reference that stores the conversion result
+         */
         void     toF1Geno(SString &out);       // output to f1 format, approximation
 private: