Changeset 1259 for cpp/frams/genetics/f4/f4_general.h

Timestamp:

06/22/23 03:52:39 (17 months ago)

Author:

Maciej Komosinski

Message:

f4: three #define's -> enum, minor refactorizations, added comments

File:

• cpp/frams/genetics/f4/f4_general.h (modified) (4 diffs)

cpp/frams/genetics/f4/f4_general.h

@@ -33 +33 @@
 class f4_Cells;  // later
 
-
-/** @name Types of f4_Cell's */
-//@{
-#define CELL_UNDIFF 40 ///<undifferentiated cell
-#define CELL_STICK  41 ///<differentiated to stick, cannot divide
-#define CELL_NEURON 42 ///<differentiated to neuron, can divide
-//@}
-
+enum class f4_Cell_type {
+        CELL_UNDIFF, ///<undifferentiated cell
+        CELL_STICK,  ///<differentiated to stick, cannot divide
+        CELL_NEURON  ///<differentiated to neuron, can divide
+};
 
 class f4_CellConn;
@@ -154 +151 @@
          * at least once. If one cell requires another one to develop, oneStep
          * should be deployed again on this cell.
-         * 
+         *
          * This method, unlike genotype tree creation, checks semantics. This means that
          * this function will fail (set error code) if:
@@ -184 +181 @@
 
         int        nr;                 ///<number of cell (seems to be used only in the approximate f1 converter for neuron connections)
-        int        type;               ///<type
+        f4_Cell_type type;             ///<type
         f4_Cell *dadlink;              ///<pointer to cell parent
         f4_Cells  *org;                ///<uplink to organism
@@ -462 +459 @@
  * @return a pointer to the f4_Node object representing the f4 tree root
  */
-//f4_Node* f4_processTree(const char *geno);
-
-/**
- * Scans a genotype string starting from a given position. This recursive method creates
- * a tree of f4_Node objects. This method extracts each potentially functional element
- * of a genotype string to a separate f4_Nodes. When the branching character '<' occurs,
- * f4_processRecur is deployed for the latest f4_Node element. This method does not
- * analyse the genotype semantically, it only checks if the syntax is proper. The only
- * semantic aspect is neuron class name extraction, where the GenoOperators
- * class is used to parse the potential neuron class name.
- * This is an internal function; for regular cases, use f4_process().
- * @param genot the string with the entire genotype
- * @param genot_len length of genot (precomputed for efficiency)
- * @param pos_inout the current position of processing in string (advanced by the function)
- * @param parent current parent of the analysed branch of the genotype
- * @return 0 if processing was successful, otherwise returns the position of an error in the genotype
- */
+ //f4_Node* f4_processTree(const char *geno);
+
+ /**
+  * Scans a genotype string starting from a given position. This recursive method creates
+  * a tree of f4_Node objects. This method extracts each potentially functional element
+  * of a genotype string to a separate f4_Nodes. When the branching character '<' occurs,
+  * f4_processRecur is deployed for the latest f4_Node element. This method does not
+  * analyse the genotype semantically, it only checks if the syntax is proper. The only
+  * semantic aspect is neuron class name extraction, where the GenoOperators
+  * class is used to parse the potential neuron class name.
+  * This is an internal function; for regular cases, use f4_process().
+  * @param genot the string with the entire genotype
+  * @param genot_len length of genot (precomputed for efficiency)
+  * @param pos_inout the current position of processing in string (advanced by the function)
+  * @param parent current parent of the analysed branch of the genotype
+  * @return 0 if processing was successful, otherwise returns the position of an error in the genotype
+  */
 int f4_processRecur(const char *genot, const int genot_len, int &pos_inout, f4_Node *parent);