source: cpp/frams/genetics/f1/conv_f1.cpp @ 732

Last change on this file since 732 was 732, checked in by Maciej Komosinski, 2 years ago

Added support for "checkpoints" (intermediate phases of development of the Model when converting between genetic encodings). See Model.checkpoint() and conv_f1.cpp for an example.

  • Property svn:eol-style set to native
File size: 17.2 KB
Line 
1// This file is a part of Framsticks SDK.  http://www.framsticks.com/
2// Copyright (C) 1999-2018  Maciej Komosinski and Szymon Ulatowski.
3// See LICENSE.txt for details.
4
5#include "conv_f1.h"
6#include <common/nonstd_stl.h>
7#include <common/log.h>
8#include <frams/util/multirange.h>
9#include <frams/util/multimap.h>
10#include <ctype.h>
11#include <assert.h>
12
13//#define v1f1COMPATIBLE //as in ancient Framsticks 1.x
14
15F1Props stdprops = { 1, 0, 1, 0.4, 0.25, 0.25, 0.25, 0.25, 0.0, 1.0, 1.0, 1,
160.2, 0.5, 0.5, 0.5 };
17
18class Builder
19{
20public:
21        Builder(const char*g, int mapping = 0) :invalid(0), genbegin(g), usemapping(mapping), first_part_mapping(NULL), own_first_part_mapping(true), model_energy(0), model_energy_count(0) {}
22        ~Builder() { if (own_first_part_mapping) SAFEDELETE(first_part_mapping); }
23        char tmp[222];
24        bool invalid;
25        Model model;
26        const char *genbegin;
27        SList neuro_f1_to_f0; // neuro_f1_to_f0(f1_refno) = actual neuro pointer
28        Neuro *last_f1_neuro;
29        SyntParam *neuro_cls_param;
30
31        struct Connection
32        {
33                int n1, n2; double w;
34                Connection(int _n1, int _n2, double _w) :n1(_n1), n2(_n2), w(_w) {}
35        };
36
37        SListTempl<Connection> connections;
38        int usemapping;
39        MultiRange range;
40        MultiRange *first_part_mapping;
41        bool own_first_part_mapping;
42        double lastjoint_muscle_power;
43        double model_energy;
44        int model_energy_count;
45        void grow(int part1, const char*g, Pt3D k, F1Props c, int branching_part);
46        void setPartMapping(int p, const char* g);
47        int growJoint(int part1, int part2, Pt3D &angle, F1Props &c, const char *g);
48        int growPart(F1Props &c, const char *g);
49        const char *skipNeuro(const char *z);
50        const char* growNeuro(const char* t, F1Props &c, int&);
51        void growConnection(const char* begin, const char* colon, const char* end, F1Props& props);
52        int countBranches(const char*g, SList &out);
53        SyntParam* lastNeuroClassParam();
54        void addClassParam(const char* name, double value);
55        void addClassParam(const char* name, const char* value);
56
57        const MultiRange* makeRange(const char*g) { return makeRange(g, g); }
58        const MultiRange* makeRange(const char*g, const char*g2);
59        Part *getLastPart() { return getLastJoint()->part2; }
60        Neuro *getLastNeuro() { return model.getNeuro(model.getNeuroCount() - 1); }
61        Joint *getLastJoint() { return model.getJoint(model.getJointCount() - 1); }
62        void addOrRememberInput(int n1, int n2, double w)
63        {
64                //if (!addInput(n1,n2,w,false))
65                connections += Connection(n1, n2, w);
66        }
67        bool addInput(int n1, int n2, double w, bool final)
68        {
69                if ((n1 < 0) || (n2 < 0) || (n1 >= neuro_f1_to_f0.size()) || (n2 >= neuro_f1_to_f0.size()))
70                {
71                        if (final) logPrintf("GenoConvF1", "addInput", LOG_WARN,
72                                "illegal neuron connection %d <- %d (ignored)", n1, n2);
73                        return 0;
74                }
75                Neuro *neuro = (Neuro*)neuro_f1_to_f0(n1);
76                Neuro *input = (Neuro*)neuro_f1_to_f0(n2);
77                neuro->addInput(input, w);
78                return 1;
79        }
80        void addPendingInputs()
81        {
82                for (int i = 0; i < connections.size(); i++)
83                {
84                        Connection *c = &connections(i);
85                        addInput(c->n1, c->n2, c->w, true);
86                }
87        }
88};
89
90const MultiRange* Builder::makeRange(const char*g, const char*g2)
91{
92        if (!usemapping) return 0;
93        range.clear();
94        range.add(g - genbegin, g2 - genbegin);
95        return &range;
96}
97
98void F1Props::normalizeBiol4()
99{
100        double sum = muscle_power + assimilation + stamina + ingestion;
101        muscle_power /= sum;
102        assimilation /= sum;
103        stamina /= sum;
104        ingestion /= sum;
105}
106
107/** main conversion function - with conversion map support */
108SString GenoConv_f1::convert(SString &i, MultiMap *map, bool using_checkpoints)
109{
110        const char* g = i.c_str();
111        Builder builder(g, map ? 1 : 0);
112        builder.model.open(using_checkpoints);
113        builder.grow(-1, g, Pt3D_0, stdprops, -1); // uses Model::addFromString() to create model elements
114        if (builder.invalid) return SString();
115        builder.addPendingInputs();
116        builder.model.startenergy = (builder.model_energy_count > 0) ? (builder.model_energy / builder.model_energy_count) : 1.0;
117        builder.model.close(); // model is ready to use now
118        if (map) builder.model.getCurrentToF0Map(*map); // generate f1-to-f0 conversion map
119        return builder.model.getF0Geno().getGenes();
120}
121
122void Builder::setPartMapping(int p, const char* g)
123{
124        if (!usemapping) return;
125        const MultiRange *r = makeRange(g);
126        if (p < 0)
127        { //special case: mapping the part which is not yet created
128                if (first_part_mapping) first_part_mapping->add(*r);
129                else { first_part_mapping = new MultiRange(*r); own_first_part_mapping = true; }
130        }
131        else
132                model.getPart(p)->addMapping(*r);
133}
134
135void Builder::grow(int part1, const char*g, Pt3D k, F1Props c, int branching_part)
136{
137        int hasmuscles = 0;
138        k += Pt3D(c.twist, 0, c.curvedness);
139        while (1)
140        {
141                switch (*g)
142                {
143                case 0: return;
144                case ',': case ')': setPartMapping(branching_part, g); return;
145                case 'R': k.x += 0.7853; setPartMapping(part1, g); break;
146                case 'r': k.x -= 0.7853;        setPartMapping(part1, g); break;
147                case 'Q': c.twist += (1.58 - c.twist)*0.3; setPartMapping(part1, g); break;
148                case 'q': c.twist += (-1.58 - c.twist)*0.3; setPartMapping(part1, g); break;
149#ifdef v1f1COMPATIBLE
150                case 'L': c.length += (3.0 - c.length)*0.3; setPartMapping(part1, g); break;
151#else
152                case 'L': c.length += (2.0 - c.length)*0.3; setPartMapping(part1, g); break;
153#endif                                       
154                case 'l': c.length += (0.33 - c.length)*0.3; setPartMapping(part1, g); break;
155                case 'A': c.assimilation += (1 - c.assimilation)*0.8;   c.normalizeBiol4(); setPartMapping(part1, g);  break;
156                case 'a': c.assimilation -= c.assimilation*0.4; c.normalizeBiol4(); setPartMapping(part1, g); break;
157                case 'I': c.ingestion += (1 - c.ingestion)*0.8; c.normalizeBiol4(); setPartMapping(part1, g); break;
158                case 'i': c.ingestion -= c.ingestion*0.4;       c.normalizeBiol4(); setPartMapping(part1, g); break;
159                case 'S': c.stamina += (1 - c.stamina)*0.8; c.normalizeBiol4(); setPartMapping(part1, g); break;
160                case 's': c.stamina -= c.stamina*0.4; c.normalizeBiol4(); setPartMapping(part1, g); break;
161                case 'M': c.muscle_power += (1 - c.muscle_power)*0.8;   c.normalizeBiol4(); setPartMapping(part1, g); break;
162                case 'm': c.muscle_power -= c.muscle_power*0.4; c.normalizeBiol4(); setPartMapping(part1, g); break;
163                case 'C': c.curvedness += (2.0 - c.curvedness)*0.25;    setPartMapping(part1, g); break;
164                case 'c': c.curvedness += (-2.0 - c.curvedness)*0.25; setPartMapping(part1, g); break;
165                case 'F': c.friction += (4 - c.friction)*0.2; setPartMapping(part1, g); break;
166                case 'f': c.friction -= c.friction*0.2; setPartMapping(part1, g); break;
167                case 'W': c.weight += (2.0 - c.weight)*0.3; setPartMapping(part1, g); break;
168                case 'w': c.weight += (0.5 - c.weight)*0.3; setPartMapping(part1, g); break;
169                case 'E': c.energy += (10.0 - c.energy)*0.1; setPartMapping(part1, g); break;
170                case 'e': c.energy -= c.energy*0.1;     setPartMapping(part1, g); break;
171
172                case 'D': c.cred += (1.0 - c.cred)*0.25; setPartMapping(part1, g); break;
173                case 'd': c.cred += (0.0 - c.cred)*0.25; setPartMapping(part1, g); break;
174                case 'G': c.cgreen += (1.0 - c.cgreen)*0.25; setPartMapping(part1, g); break;
175                case 'g': c.cgreen += (0.0 - c.cgreen)*0.25; setPartMapping(part1, g); break;
176                case 'B': c.cblue += (1.0 - c.cblue)*0.25; setPartMapping(part1, g); break;
177                case 'b': c.cblue += (0.0 - c.cblue)*0.25; setPartMapping(part1, g); break;
178                case 'H': c.visual_size += (0.7 - c.visual_size)*0.25; setPartMapping(part1, g); break;
179                case 'h': c.visual_size += (0.05 - c.visual_size)*0.25; setPartMapping(part1, g); break;
180
181                case '[': //neuron
182                        //              setdebug(g-(char*)geny,DEBUGNEURO | !l_neu);
183                        if (model.getJointCount())
184                                g = growNeuro(g + 1, c, hasmuscles);
185                        else
186                        {
187                                logMessage("GenoConv_F1", "grow", 1, "Illegal neuron position (ignored)");
188                                g = skipNeuro(g + 1);
189                        }
190                        break;
191                case 'X':
192                {
193                        int freshpart = 0;
194                        //setdebug(g-(char*)geny,DEBUGEST | !l_est);
195                        if (part1 < 0) //initial grow
196                        {
197                                if (model.getPartCount() > 0)
198                                        part1 = 0;
199                                else
200                                {
201                                        part1 = growPart(c, g);
202                                        freshpart = 1;
203                                        if (first_part_mapping)
204                                        {
205                                                //mapping was defined before creating this initial Part -> put it into the Part
206                                                assert(own_first_part_mapping);
207                                                model.getPart(part1)->setMapping(*first_part_mapping);
208                                                delete first_part_mapping;
209                                                //first_part_mapping can be still used later but from now on it references the internal Part mapping
210                                                first_part_mapping = model.getPart(part1)->getMapping();
211                                                own_first_part_mapping = false;
212                                        }
213                                }
214                        }
215                        if (!freshpart)
216                        {
217                                Part *part = model.getPart(part1);
218                                part->density = ((part->mass*part->density) + 1.0 / c.weight) / (part->mass + 1.0); // v=m*d
219                                //                      part->volume+=1.0/c.weight;
220                                part->mass += 1.0;
221                        }
222                        model_energy += 0.9*c.energy + 0.1;
223                        model_energy_count++;
224
225                        int part2 = growPart(c, g);
226                        growJoint(part1, part2, k, c, g);
227                        //              est* e = new est(*s,*s2,k,c,zz,this);
228
229                        // attenuate properties as they are propagated along the structure
230                        c.length = 0.5*c.length + 0.5*stdprops.length;
231                        c.visual_size = 0.5*c.visual_size + 0.5*stdprops.visual_size;
232                        c.curvedness = 0.66*c.curvedness;
233                        c.twist = 0.66*c.twist;
234                        c.friction = 0.8*c.friction + 0.2*stdprops.friction;
235
236                        c.assimilation = 0.8*c.assimilation + 0.2*stdprops.assimilation;
237                        c.stamina = 0.8*c.stamina + 0.2*stdprops.stamina;
238                        c.muscle_power = 0.8*c.muscle_power + 0.2*stdprops.muscle_power;
239                        c.ingestion = 0.8*c.ingestion + 0.2*stdprops.ingestion;
240                        c.weight += (stdprops.weight - c.weight)*0.5;
241                        c.normalizeBiol4();
242
243                        if (c.muscle_reset_range) c.muscle_bend_range = 1.0; else c.muscle_reset_range = true;
244                        model.checkpoint();
245                        grow(part2, g + 1, Pt3D_0, c, branching_part);
246                        return;
247                }
248                case '(':
249                {
250                        setPartMapping(part1, g);
251                        SList ga;
252                        int i, count;
253                        count = countBranches(g + 1, ga);
254                        c.muscle_reset_range = false;
255                        c.muscle_bend_range = 1.0 / count;
256                        for (i = 0; i < count; i++)
257                                grow(part1, (char*)ga(i), k + Pt3D(0, 0, -M_PI + (i + 1)*(2 * M_PI / (count + 1))), c, part1);
258                        return;
259                }
260                case ' ': case '\t': case '\n': case '\r': break;
261                default: invalid = 1; return;
262                }
263                g++;
264        }
265}
266
267SyntParam* Builder::lastNeuroClassParam()
268{
269        if (!neuro_cls_param)
270        {
271                NeuroClass *cls = last_f1_neuro->getClass();
272                if (cls)
273                {
274                        neuro_cls_param = new SyntParam(last_f1_neuro->classProperties());
275                        // this is equivalent to:
276                        //              SyntParam tmp=last_f1_neuro->classProperties();
277                        //              neuro_cls_param=new SyntParam(tmp);
278                        // interestingly, some compilers eliminate the call to new SyntParam,
279                        // realizing that a copy constructor is redundant when the original object is
280                        // temporary. there are no side effect of such optimization, as long as the
281                        // copy-constructed object is exact equivalent of the original.
282                }
283        }
284        return neuro_cls_param;
285}
286
287void Builder::addClassParam(const char* name, double value)
288{
289        lastNeuroClassParam();
290        if (neuro_cls_param)
291                neuro_cls_param->setDoubleById(name, value);
292}
293
294void Builder::addClassParam(const char* name, const char* value)
295{
296        lastNeuroClassParam();
297        if (neuro_cls_param)
298        {
299                ExtValue e(value);
300                const ExtValue &re(e);
301                neuro_cls_param->setById(name, re);
302        }
303}
304
305int Builder::countBranches(const char*g, SList &out)
306{
307        int gl = 0;
308        out += (void*)g;
309        while (gl >= 0)
310        {
311                switch (*g)
312                {
313                case 0: gl = -1; break;
314                case '(': case '[': ++gl; break;
315                case ')': case ']': --gl; break;
316                case ',': if (!gl) out += (void*)(g + 1);
317                }
318                g++;
319        }
320        return out.size();
321}
322
323int Builder::growJoint(int part1, int part2, Pt3D &angle, F1Props &c, const char *g)
324{
325        double len = min(2.0, c.length);
326        sprintf(tmp, "p1=%ld,p2=%ld,dx=%lg,rx=%lg,ry=%lg,rz=%lg,stam=%lg,vr=%g,vg=%g,vb=%g",
327                part1, part2, len, angle.x, angle.y, angle.z, c.stamina, c.cred, c.cgreen, c.cblue);
328        lastjoint_muscle_power = c.muscle_power;
329        return model.addFromString(Model::JointType, tmp, makeRange(g));
330}
331
332int Builder::growPart(F1Props &c, const char *g)
333{
334        sprintf(tmp, "dn=%lg,fr=%lg,ing=%lg,as=%lg,vs=%g,vr=%g,vg=%g,vb=%g",
335                1.0 / c.weight, c.friction, c.ingestion, c.assimilation, c.visual_size, c.cred, c.cgreen, c.cblue);
336        return model.addFromString(Model::PartType, tmp, makeRange(g));
337}
338
339const char *Builder::skipNeuro(const char *z)
340{
341        for (; *z; z++) if ((*z == ']') || (*z == ')')) break;
342        return z - 1;
343}
344
345const char* Builder::growNeuro(const char* t, F1Props& props, int &hasmuscles)
346{
347        const char*neuroend = skipNeuro(t);
348        last_f1_neuro = model.addNewNeuro();
349        neuro_cls_param = NULL;
350        last_f1_neuro->attachToPart(getLastPart());
351        const MultiRange *mr = makeRange(t - 1, neuroend + 1);
352        if (mr) last_f1_neuro->addMapping(*mr);
353        neuro_f1_to_f0 += last_f1_neuro;
354
355        SString clsname;
356        bool haveclass = 0;
357        while (*t && *t <= ' ') t++;
358        const char* next = (*t) ? (t + 1) : t;
359        while (*next && *next <= ' ') next++;
360        if (*t && *next != ',' && *next != ']') // old style muscles [|rest] or [@rest]
361                switch (*t)
362        {
363                case '@': if (t[1] == ':') break;
364                        haveclass = 1;
365                        //              if (!(hasmuscles&1))
366                        {
367                                hasmuscles |= 1;
368                                Neuro *muscle = model.addNewNeuro();
369                                sprintf(tmp, "@:p=%lg", lastjoint_muscle_power);
370                                muscle->addInput(last_f1_neuro);
371                                muscle->setDetails(tmp);
372                                muscle->attachToJoint(getLastJoint());
373                                if (usemapping) muscle->addMapping(*makeRange(t));
374                        }
375                        t++;
376                        break;
377                case '|': if (t[1] == ':') break;
378                        haveclass = 1;
379                        //              if (!(hasmuscles&2))
380                        {
381                                hasmuscles |= 2;
382                                Neuro *muscle = model.addNewNeuro();
383                                sprintf(tmp, "|:p=%lg,r=%lg", lastjoint_muscle_power, props.muscle_bend_range);
384                                muscle->addInput(last_f1_neuro);
385                                muscle->setDetails(tmp);
386                                muscle->attachToJoint(getLastJoint());
387                                if (usemapping) muscle->addMapping(*makeRange(t));
388                        }
389                        t++;
390                        break;
391        }
392        while (*t && *t <= ' ') t++;
393        bool finished = 0;
394        const char *begin = t;
395        const char* colon = 0;
396        SString classparams;
397        while (!finished)
398        {
399                switch (*t)
400                {
401                case ':': colon = t; break;
402                case 0: case ']': case ')': finished = 1;
403                        // NO break!
404                case ',':
405                        if (!haveclass && !colon && t > begin)
406                        {
407                                haveclass = 1;
408                                SString clsname(begin, t - begin);
409                                clsname = trim(clsname);
410                                last_f1_neuro->setClassName(clsname);
411                                NeuroClass *cls = last_f1_neuro->getClass();
412                                if (cls)
413                                {
414                                        if (cls->getPreferredLocation() == 2)
415                                                last_f1_neuro->attachToJoint(getLastJoint());
416                                        else if (cls->getPreferredLocation() == 1)
417                                                last_f1_neuro->attachToPart(getLastPart());
418
419                                        lastNeuroClassParam();
420                                        //special handling: muscle properties (can be overwritten by subsequent property assignments)
421                                        if (!strcmp(cls->getName().c_str(), "|"))
422                                        {
423                                                neuro_cls_param->setDoubleById("p", lastjoint_muscle_power);
424                                                neuro_cls_param->setDoubleById("r", props.muscle_bend_range);
425                                        }
426                                        else if (!strcmp(cls->getName().c_str(), "@"))
427                                        {
428                                                neuro_cls_param->setDoubleById("p", lastjoint_muscle_power);
429                                        }
430                                }
431                        }
432                        else if (colon && (colon > begin) && (t > colon))
433                                growConnection(begin, colon, t, props);
434                        if (t[0] != ',') t--;
435                        begin = t + 1; colon = 0;
436                        break;
437                }
438                t++;
439        }
440        SAFEDELETE(neuro_cls_param);
441        return t;
442}
443void Builder::growConnection(const char* begin, const char* colon, const char* end, F1Props& props)
444{
445        while (*begin && *begin <= ' ') begin++;
446        int i;
447        if (isdigit(begin[0]) || (begin[0] == '-'))
448        {
449                double conn_weight = ExtValue::getDouble(trim(SString(colon + 1, end - (colon + 1))).c_str());
450                paInt relative = ExtValue::getInt(trim(SString(begin, colon - begin)).c_str(), false);
451                int this_refno = neuro_f1_to_f0.size() - 1;
452                addOrRememberInput(this_refno, this_refno + relative, conn_weight);
453        }
454        else if ((i = last_f1_neuro->extraProperties().findIdn(begin, colon - begin)) >= 0)
455        {
456                last_f1_neuro->extraProperties().set(i, colon + 1);
457        }
458        else if (isupper(begin[0]) || strchr("*|@", begin[0]))
459        {
460                SString clsname(begin, colon - begin);
461                trim(clsname);
462                Neuro *receptor = model.addNewNeuro();
463                receptor->setClassName(clsname);
464                NeuroClass *cls = receptor->getClass();
465                if (cls)
466                {
467                        if (cls->getPreferredLocation() == 2) receptor->attachToJoint(getLastJoint());
468                        else if (cls->getPreferredLocation() == 1) receptor->attachToPart(getLastPart());
469                }
470                last_f1_neuro->addInput(receptor, ExtValue::getDouble(trim(SString(colon + 1, end - (colon + 1))).c_str()));
471                if (usemapping) receptor->addMapping(*makeRange(begin, end - 1));
472        }
473        else if ((begin[0] == '>') && (begin[1]))
474        {
475                Neuro *out = model.addNewNeuro();
476                out->addInput(last_f1_neuro, ExtValue::getDouble(trim(SString(colon + 1, end - (colon + 1))).c_str()));
477                out->setClassName(SString(begin + 1, end - colon - 1));
478                if (begin[1] == '@')
479                {
480                        sprintf(tmp, "p=%lg", lastjoint_muscle_power);
481                        out->setClassParams(tmp);
482                }
483                else if (begin[1] == '|')
484                {
485                        sprintf(tmp, "p=%lg,r=%lg", lastjoint_muscle_power, props.muscle_bend_range);
486                        out->setClassParams(tmp);
487                }
488                NeuroClass *cls = out->getClass();
489                if (cls)
490                {
491                        if (cls->getPreferredLocation() == 2) out->attachToJoint(getLastJoint());
492                        else if (cls->getPreferredLocation() == 1) out->attachToPart(getLastPart());
493                }
494                if (usemapping) out->addMapping(*makeRange(begin, end - 1));
495        }
496        else if (*begin == '!') addClassParam("fo", ExtValue::getDouble(trim(SString(colon + 1, end - (colon + 1))).c_str()));
497        else if (*begin == '=') addClassParam("in", ExtValue::getDouble(trim(SString(colon + 1, end - (colon + 1))).c_str()));
498        else if (*begin == '/') addClassParam("si", ExtValue::getDouble(trim(SString(colon + 1, end - (colon + 1))).c_str()));
499        else if (islower(begin[0]))
500        {
501                SString name(begin, colon - begin);
502                SString value(colon + 1, end - (colon + 1));
503                addClassParam(name.c_str(), value.c_str());
504        }
505}
Note: See TracBrowser for help on using the repository browser.