Nemo  2.4.0
Simulate forward-in-time genetic evolution in a spatially explicit, individual-based stochastic simulator
ttrait_with_map.h
Go to the documentation of this file.
1 
29 #ifndef TTRAIT_WITH_MAP_H
30 #define TTRAIT_WITH_MAP_H
31 
32 #include <string>
33 #include <vector>
34 #include <map>
35 #include <utility>
36 #include "ttrait.h"
37 
38 
39 // ------------------------------------------------------------------------------
43 // ------------------------------------------------------------------------------
44 
45 class GeneticMap {
46 
47 private:
48 
49  unsigned long _currentIndividual;
50 
52  map< trait_t, unsigned int > _traits;
53 
55  unsigned int _nTrait;
56 
60  vector< unsigned int* > _lociLookupTable; //this is the actual map, for each trait
62  vector< unsigned int > _numChrsmPerTrait;
64  vector< unsigned int > _numLociPerTrait;
66  vector< unsigned int* > _numLociPerChrsmPerTrait;
69  vector< unsigned int* > _locPositionsPerTrait;
70 
74  vector< vector < unsigned int > > _recPositions[2];
75 
78  vector< bool > _chrsmFirstRecombPosition[2];
79 
81  vector< unsigned int > _junctions;
82 
83  unsigned int _numChromosome;
84  unsigned int *_perChrsmLength; //array length is _numChromosome
85  unsigned int *_chrsmFirstLocusPosition; //array length is _numChromosome
86  unsigned int _totalLength; // total map length
87  unsigned int _recombLength; // this is _totalLength + 1; used to draw the x-over spots
88  unsigned int _totalNumLoci;
89  double _resolution;
92 
93 
94 public:
95 
100 
102 
103  bool getGeneticMap (trait_t trait, double** table, unsigned int table_length);
104 
105  double getResolution ( ) {return _resolution;}
106 
107  double setResolution (double val)
108  {
109  _resolution = (val < _resolution ? val : _resolution);
110  return _resolution;
111  }
112 
113  void rescaleMap (double val);
114  void reset_tables ();
115  void clear ();
116 
122  void setLookupTable (unsigned int idx);
123 
131  void recombine (sex_t SEX);
132 
134  vector< pair<unsigned int, unsigned int> > reduceJunctions (sex_t SEX, unsigned int trait_idx);
135 
143  bool registerIndForRecombine (unsigned long ID)
144  {
145  if (ID == _currentIndividual) return false;
146  else _currentIndividual = ID;
147  return true;
148  }
149 
151  unsigned int addTrait (trait_t trait, unsigned int nChrm, unsigned int nLoc, unsigned int* nLocChrm,
152  double resolution, unsigned int* locPositions);
153 
154  void unregisterTrait (trait_t trait);
155 
159  bool checkRegisteredTrait (trait_t trait);
160 
161 // void unregisterTrait_at (unsigned int traitIdx);
162 
164  vector< unsigned int>& getRecLoci (sex_t SEX, unsigned int trait)
165  {
166  return _recPositions[SEX][trait];
167  }
168 
170  vector< bool >& getFirstRecPosition (sex_t SEX)
171  { return _chrsmFirstRecombPosition[SEX]; }
172 
173  unsigned int* getLocusPositionTable (const trait_t trait)
174  {return _locPositionsPerTrait[ _traits[ trait ] ];}
175 };
176 
177 
178 // ------------------------------------------------------------------------------
182 // ------------------------------------------------------------------------------
184 
185  string _paramPrefix;
186 
188 
189 protected:
190 
191  //recombination:
192  unsigned int _mapIndex;
194  double _recombRate;
196  unsigned int _numChromosome;
197  unsigned int _numLoci;
199  unsigned int *_numLociPerChrmsm;
200  unsigned int *_chrsmLength;
201  unsigned int *_lociMapPositions;
202 
203  friend class TTraitWithMap;
204 
205 public:
206 
207 
208  static GeneticMap _map;
209 
210 
215  {}
216 
217  TTProtoWithMap(const TTProtoWithMap& TP);
218 
219  virtual ~TTProtoWithMap();
220 
223 
224  virtual bool is_mappable () {return true;}
226  virtual bool is_mapped () {return _map.checkRegisteredTrait(this->get_type());}
228  virtual vector< unsigned int > get_locus_map_positions ();
230 
231  void setMapIndex (unsigned int idx) {_mapIndex = idx;}
232 
233  unsigned int getMapIndex () {return _mapIndex;}
234 
235  static GeneticMap& getGeneticMapRef () {return _map;}
236 
237  double getRecombRate () const {return _recombRate;}
238 
239  bool setGeneticMapParameters (string prefix, unsigned int numLoci = 0);
240 
241  void addGeneticMapParameters (string prefix);
242 
244 
245  bool setRecombinationMapNonRandom (vector< vector<double> >& lociPositions);
246 
247  bool setRecombinationMapFixed ();
248 
249  bool setNumLociPerChromosome (string param_name);
250 
252 
253  void registerGeneticMap ();
254 
255  void unregisterFromGeneticMap ();
256 
257  bool areGeneticMapParamSet(string prefix);
258 
259  bool isRecombinationFree(string prefix);
260 
261  void recordRandomMap ();
262 
263  static void recombine (unsigned long indID);
264 
265  virtual void reset ();
266 
267 };
268 
269 
270 // ------------------------------------------------------------------------------
274 // ------------------------------------------------------------------------------
275 class TTraitWithMap : public TTrait {
276 
277 protected:
278 
280 
281 public:
282 
284 
285  virtual ~TTraitWithMap() {}
286 
287 };
288 
289 #endif
GeneticMap.
Definition: ttrait_with_map.h:45
void setLookupTable(unsigned int idx)
Bbuilds the lookup table for each trait.
Definition: ttrait_with_map.cc:973
vector< bool > & getFirstRecPosition(sex_t SEX)
Returns the vector of the first chromosome position for recombination, used for all traits.
Definition: ttrait_with_map.h:170
unsigned int * getLocusPositionTable(const trait_t trait)
Definition: ttrait_with_map.h:173
void reset_tables()
Definition: ttrait_with_map.cc:1299
vector< unsigned int > _numLociPerTrait
Vector of number of loci for each trait.
Definition: ttrait_with_map.h:64
vector< unsigned int * > _lociLookupTable
A list of tables that map the map position (cM) to a locus, for each trait.
Definition: ttrait_with_map.h:60
unsigned int _nTrait
Number of traits registered in the map.
Definition: ttrait_with_map.h:55
unsigned int _recombLength
Definition: ttrait_with_map.h:87
vector< pair< unsigned int, unsigned int > > reduceJunctions(sex_t SEX, unsigned int trait_idx)
Remove multiple x-over at the same locus when traits differ in number of loci.
Definition: ttrait_with_map.cc:1209
double setResolution(double val)
Definition: ttrait_with_map.h:107
double _recombinationRate
Definition: ttrait_with_map.h:91
vector< unsigned int > _numChrsmPerTrait
Vector of number of chromosomes for each trait.
Definition: ttrait_with_map.h:62
vector< bool > _chrsmFirstRecombPosition[2]
Two vectors holding the starting copy of each chromosome to use when creating the two gametes that ar...
Definition: ttrait_with_map.h:78
double _totRecombEventsMean
Definition: ttrait_with_map.h:90
unsigned int addTrait(trait_t trait, unsigned int nChrm, unsigned int nLoc, unsigned int *nLocChrm, double resolution, unsigned int *locPositions)
Returns the table index for the registered trait.
Definition: ttrait_with_map.cc:691
unsigned int * _chrsmFirstLocusPosition
Definition: ttrait_with_map.h:85
void recombine(sex_t SEX)
Called by TTProtoWithMap::recombine twice to create the two gametes necessary for the creation of a n...
Definition: ttrait_with_map.cc:1105
unsigned int _totalLength
Definition: ttrait_with_map.h:86
vector< unsigned int * > _locPositionsPerTrait
Vector containing the table of map position for the loci of each trait.
Definition: ttrait_with_map.h:69
vector< vector< unsigned int > > _recPositions[2]
Vector of tables containing, for each trait, the locus number at which x-overs happen.
Definition: ttrait_with_map.h:74
unsigned int * _perChrsmLength
Definition: ttrait_with_map.h:84
vector< unsigned int * > _numLociPerChrsmPerTrait
Vector containing a table of number of loci per chromosome for each trait.
Definition: ttrait_with_map.h:66
bool getGeneticMap(trait_t trait, double **table, unsigned int table_length)
Definition: ttrait_with_map.cc:914
GeneticMap()
Definition: ttrait_with_map.h:96
~GeneticMap()
Definition: ttrait_with_map.h:101
unsigned int _numChromosome
Definition: ttrait_with_map.h:83
unsigned int _totalNumLoci
Definition: ttrait_with_map.h:88
double _resolution
Definition: ttrait_with_map.h:89
bool checkRegisteredTrait(trait_t trait)
Returns true if trait 'trait' has registered a genetic map, false otherwise.
Definition: ttrait_with_map.cc:673
void unregisterTrait(trait_t trait)
Definition: ttrait_with_map.cc:649
vector< unsigned int > & getRecLoci(sex_t SEX, unsigned int trait)
Returns a vector of the loci where crossing-overs take place.
Definition: ttrait_with_map.h:164
void clear()
Definition: ttrait_with_map.cc:682
unsigned long _currentIndividual
Definition: ttrait_with_map.h:49
double getResolution()
Definition: ttrait_with_map.h:105
vector< unsigned int > _junctions
A vector to store the position of the recombination events.
Definition: ttrait_with_map.h:81
map< trait_t, unsigned int > _traits
Table mapping trait type to its position index in the following tables.
Definition: ttrait_with_map.h:52
bool registerIndForRecombine(unsigned long ID)
Called by TTProtoWithMap::recombine with individual ID passed down from Individual::recombine.
Definition: ttrait_with_map.h:143
void rescaleMap(double val)
Definition: ttrait_with_map.cc:944
TTProtoWithMap.
Definition: ttrait_with_map.h:183
double _mapResolution
Definition: ttrait_with_map.h:195
static GeneticMap _map
Definition: ttrait_with_map.h:208
static GeneticMap & getGeneticMapRef()
Definition: ttrait_with_map.h:235
bool setNumLociPerChromosome(string param_name)
Definition: ttrait_with_map.cc:297
void unregisterFromGeneticMap()
Definition: ttrait_with_map.cc:584
virtual vector< unsigned int > get_locus_map_positions()
Returns the map positions of the loci in vector.
Definition: ttrait_with_map.cc:602
unsigned int * _lociMapPositions
Definition: ttrait_with_map.h:201
string _paramPrefix
Definition: ttrait_with_map.h:185
bool setRecombinationMapFixed()
Definition: ttrait_with_map.cc:388
bool setRecombinationMapNonRandom(vector< vector< double > > &lociPositions)
Definition: ttrait_with_map.cc:364
void recordRandomMap()
Definition: ttrait_with_map.cc:533
virtual bool is_mappable()
Checks if the trait is mappable, i.e., if the loci can be placed on a genetic map.
Definition: ttrait_with_map.h:224
bool areGeneticMapParamSet(string prefix)
Definition: ttrait_with_map.cc:88
unsigned int * _chrsmLength
Definition: ttrait_with_map.h:200
virtual bool is_mapped()
Checks if the trait's loci are placed on a genetic map.
Definition: ttrait_with_map.h:226
double _recombRate
Definition: ttrait_with_map.h:194
double * _recombRatePerChrmsm
Definition: ttrait_with_map.h:198
unsigned int _numLoci
Definition: ttrait_with_map.h:197
TTProtoWithMap()
Definition: ttrait_with_map.h:211
unsigned int getMapIndex()
Definition: ttrait_with_map.h:233
bool setGeneticMapParameters(string prefix, unsigned int numLoci=0)
Definition: ttrait_with_map.cc:125
double _totRecombEventsMean
Definition: ttrait_with_map.h:193
unsigned int _numChromosome
Definition: ttrait_with_map.h:196
bool isRecombinationFree(string prefix)
Definition: ttrait_with_map.cc:98
virtual void reset()
Definition: ttrait_with_map.cc:637
bool _isRegistered
Definition: ttrait_with_map.h:187
unsigned int * _numLociPerChrmsm
Definition: ttrait_with_map.h:199
void reset_recombination_pointers()
Definition: ttrait_with_map.cc:627
void registerGeneticMap()
Definition: ttrait_with_map.cc:575
void addGeneticMapParameters(string prefix)
Definition: ttrait_with_map.cc:77
unsigned int _mapIndex
Definition: ttrait_with_map.h:192
void setMapIndex(unsigned int idx)
Definition: ttrait_with_map.h:231
virtual ~TTProtoWithMap()
Definition: ttrait_with_map.cc:70
static void recombine(unsigned long indID)
Definition: ttrait_with_map.cc:592
bool setRecombinationMapRandom()
Definition: ttrait_with_map.cc:438
double getRecombRate() const
Definition: ttrait_with_map.h:237
TTraitWithMap.
Definition: ttrait_with_map.h:275
TTProtoWithMap * _myProto
Definition: ttrait_with_map.h:279
virtual ~TTraitWithMap()
Definition: ttrait_with_map.h:285
TTraitWithMap()
Definition: ttrait_with_map.h:283
Interface for all trait types, declares all basic trait operations.
Definition: ttrait.h:45
TTrait setter.
Definition: ttrait.h:130
virtual trait_t get_type() const =0
Type accessor.
Nemo2.
std::string trait_t
Trait types.
Definition: types.h:62
sex_t
Sex types, males are always 0 and females 1!!
Definition: types.h:35

Generated for Nemo v2.4.0 by  doxygen 1.9.1 -- Nemo is hosted on  Download Nemo

Locations of visitors to this page
Catalogued on GSR