Changeset 304 for cpp/frams/model


Ignore:
Timestamp:
01/22/15 00:12:24 (5 years ago)
Author:
Maciej Komosinski
Message:

Improved docs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpp/frams/model/model.h

    r286 r304  
    223223void makeGeno(Geno &,MultiMap *map=0,bool handle_defaults=true);
    224224
    225 /** @return mapping from source genotype (0-based position in text) to model elements reference numbers.
    226     the map can be empty if the mapping hasn't been requested earlier (in constructor)
     225/** @return Mapping from source genotype (0-based position in text) to model elements reference numbers.
     226    Read about how mappings work: http://www.framsticks.com/files/common/GeneticMappingsInArtificialGenomes.pdf
     227    The map can be empty if the mapping hasn't been requested earlier (in constructor)
    227228    or the converters don't support mapping.
    228     if you create or modify the model using singleStepBuild() or direct manipulation
     229    If you create or modify the model using singleStepBuild() or direct manipulation
    229230    the map will be not changed or created automatically - it is your responsibility.
    230231    @see Model(const Geno &src,int buildmaps=0), singleStepBuild(), PartBase::addMapping()
     
    235236MultiMap &getMap();
    236237
    237 /** @return mapping from f0 genotype (0-based position in text) to model elements reference numbers
     238/** Read about how mappings work: http://www.framsticks.com/files/common/GeneticMappingsInArtificialGenomes.pdf
     239    @return mapping from f0 genotype (0-based position in text) to model elements reference numbers
    238240 */
    239241const MultiMap &getF0Map();
     
    246248void clearMap();
    247249
    248 /** generate mapping from the current genotype to the f0 genotype.
     250/** Generate mapping from the current genotype to the f0 genotype.
    249251    This works only if both current and f0 maps are already known.
     252    Read about how mappings work: http://www.framsticks.com/files/common/GeneticMappingsInArtificialGenomes.pdf
    250253    @see convmap
    251254*/
     
    268271void clear();
    269272
    270 /** execute single line of <B>f0</B> genotype.
    271     return value is non-negative reference number of the created item,
     273/** Execute single line of <B>f0</B> genotype.
     274    Return value is non-negative reference number of the created item,
    272275    or negative value. reference number can be used to access
    273276    the item using getPart(int), getJoint(int) and getNeuroItem(int) methods.
     
    285288void useAllDelta(bool yesno);
    286289
    287 /// final validity check of the model, all model data has to be available at this point.
    288 /// if the model was modified, the genotype will be also updated.
    289 /// it also calls "validate" with all side effects.
     290/// Final validity check of the model, all model data has to be available at this point.
     291/// If the model was modified, the genotype will be also updated.
     292/// It also calls "validate" with all side effects.
    290293/// @return > 0 means "valid"
    291294int close();
    292295
    293 /// enable model building.
    294 /// you should use it if you need to create new model, modify the model after close
     296/// Enable model building.
     297/// You should use it if you need to create new model, modify the model after close
    295298/// or modify the model created from the genotype.
    296 /// between open() and close() the model is not fully usable,
     299/// Between open() and close() the model is not fully usable.
    297300void open();
    298301
    299 /// current model written as f0 genotype while building
    300 /// (not cached, not validated, probably unusable and bad if used before close(). but good for debugging.)
     302/// Current model written as f0 genotype while building
     303/// (not cached, not validated, probably unusable and bad if used before close(). But good for debugging.)
    301304Geno rawGeno();
    302305
Note: See TracChangeset for help on using the changeset viewer.