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

Timestamp:

04/11/18 01:16:08 (6 years ago)

Author:

Maciej Komosinski

Message:

Removed unused "state" field (issue number 19), improved docs (issues number 20,21,23), code formatting (issue number 24) [closes #62]

File:

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

cpp/frams/genetics/f4/f4_general.h

@@ -21 +21 @@
  * @param v pointer to the decremented value
  */
-void rolling_dec(double * v);
+void rolling_dec(double *v);
 
 /**
@@ -27 +27 @@
  * @param v pointer to the incremented value
  */
-void rolling_inc(double * v);
+void rolling_inc(double *v);
 
 class f4_node;   // later
@@ -51 +51 @@
  * @return 1 if end of string was reached, or position of found character in sequence
  */
-int scanrec(const char * s, unsigned int slen, char stopchar);
+int scanrec(const char* s, unsigned int slen, char stopchar);
 
 
@@ -221 +221 @@
 
         int          ctrl;             ///<neuron type
-        double       state;            ///<state of neuron
         double       inertia;          ///<inertia of neuron
         double       force;            ///<force of neuron
@@ -253 +252 @@
 
 
-// a collection of cells, like Organism, for developmental encoding
 /**
  * A class representing a collection of cells. It is equivalent to an organism.
@@ -295 +293 @@
          * Performs a single step of organism development. It runs each active cell
          * in the organism.
-         * @return 0 if all cells are developed, 1 otherwise
+         * @return 0 if all cells are developed, or 1 otherwise
          */
         int  onestep();
@@ -336 +334 @@
          * @param parent the parent of a new element
          * @param insert the element to be inserted
-         * @return 0 if repair can be performed, -1 otherwise (the repair flag wasn't set in constructor)
+         * @return 0 if repair can be performed, or -1 otherwise because the repair flag wasn't set in the constructor
          */
         int  setRepairInsert(int nerrpos, f4_node *parent, f4_node *insert);
@@ -432 +430 @@
          * @return pointer to the nth subnode or NULL if not found
          */
-        f4_node * ordNode(int n);
+        f4_node* ordNode(int n);
 
         /**
@@ -438 +436 @@
          * @return random subnode
          */
-        f4_node * randomNode();
+        f4_node* randomNode();
 
         /**
@@ -446 +444 @@
          * @return a random subnode with a given size or NULL
          */
-        f4_node * randomNodeWithSize(int min, int max);
+        f4_node* randomNodeWithSize(int min, int max);
 
         /**
@@ -458 +456 @@
          * @return pointer to a tree copy
          */
-        f4_node * duplicate();
+        f4_node* duplicate();
 
         /**
@@ -468 +466 @@
 };
 
-// convert f4 geno string to tree structure (internal)
-
 /**
  * The main function for converting a string of f4 encoding to a tree structure. Prepares
@@ -476 +472 @@
  * @return a pointer to the f4_node object representing the f4 tree root
  */
-f4_node * f4_processtree(const char *geno);
+f4_node* f4_processtree(const char *geno);
 
 /**
@@ -488 +484 @@
  * @param genot the string holding all the genotype
  * @param pos0 the current position of processing in string
- * @param current parent of the analysed branch of the genotype
+ * @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
  */
@@ -504 +500 @@
  * @return the pointer to the first character in string after connection definition
  */
-const char * parseConnection(const char *fragm, int &relfrom, double &weight);
+const char *parseConnection(const char *fragm, int &relfrom, double &weight);
 
 /**
@@ -518 +514 @@
  * @return the pointer to the first character in string after the connection definition
  */
-const char * parseConnectionWithNeuron(const char *fragm, string &neutype, double &weight);
+const char *parseConnectionWithNeuron(const char *fragm, string &neutype, double &weight);
 
 #endif