Changeset 670 for cpp/frams/genetics/oper_fx.h

Timestamp:

08/12/17 01:55:25 (8 years ago)

Author:

Maciej Komosinski

Message:

Improved variable names and docs

File:

• cpp/frams/genetics/oper_fx.h (modified) (1 diff)

cpp/frams/genetics/oper_fx.h

@@ -192 +192 @@
    static void linearMix(ParamInterface &p1, int i1, ParamInterface &p2, int i2, double proportion); ///<mixes i1'th and i2'th properties of p1 and p2; proportion should be within [0,1]; 0.5 causes both properties to become their average. For integer properties applies random "dithering" when necessary.
    static NeuroClass* getRandomNeuroClass(); ///<returns random neuroclass or NULL when no active classes.
-   static NeuroClass* parseNeuroClass(char *&s); ///<returns neuroclass or NULL if the string does not begin with a valid name. Advance \e s pointer.
+   static NeuroClass* parseNeuroClass(char *&s); ///<returns longest matching neuroclass or NULL if the string does not begin with a valid neuroclass name. Advances \e s pointer.
    static Neuro* findNeuro(const Model *m,const NeuroClass *nc); ///<returns pointer to first Neuro of class \e nc, or NULL if there is no such Neuro.
    static int neuroClassProp(char *&s,NeuroClass *nc,bool also_v1_N_props=false); ///<returns 0-based property number for \e neuroclass, 100-based extraproperty number for Neuro, or -1 if the string does not begin with a valid property name. Advance \e s pointer if success.