genomicSimulationC 0.3
Data Fields
gsc_SimData Struct Reference

Composite type that is used to run crossing simulations. More...

#include <sim-operations.h>

+ Collaboration diagram for gsc_SimData:

Data Fields

unsigned int n_labels
 The number of custom labels in the simulation. More...
 
gsc_LabelIDlabel_ids
 The identifier number of each label in the simulation, in order of their lookup index. More...
 
int * label_defaults
 Array containing the default (birth) value of each custom label. More...
 
gsc_KnownGenome genome
 A gsc_KnownGenome, which stores the information of known markers and linkage groups, as well as one or more recombination maps for use in simulating meiosis. More...
 
gsc_AlleleMatrixm
 Pointer to an gsc_AlleleMatrix, which stores data and metadata of founders and simulated offspring. More...
 
unsigned int n_eff_sets
 The number of sets of allele effects in the simulation. More...
 
gsc_EffectIDeff_set_ids
 The identifier number of each set of allele effects in the simulation, ordered by their lookup index. More...
 
gsc_MarkerEffectse
 Array of n_eff_sets gsc_MarkerEffects, optional for the use of the simulation. More...
 
rnd_pcg_t rng
 Random number generator working memory. More...
 
gsc_PedigreeID current_id
 Highest SimData-unique ID that has been generated so far. More...
 
unsigned int n_groups
 Number of groups currently existing in simulation. More...
 

Detailed Description

Composite type that is used to run crossing simulations.

The core of this type is a list of markers. These are used to index the rows of the allele matrix and the position map, and the columns of the effect matrix.

Has short name: SimData

Definition at line 866 of file sim-operations.h.

Field Documentation

◆ current_id

gsc_PedigreeID gsc_SimData::current_id

Highest SimData-unique ID that has been generated so far.

Used to track which IDs have already been given out.

Definition at line 888 of file sim-operations.h.

◆ e

gsc_MarkerEffects* gsc_SimData::e

Array of n_eff_sets gsc_MarkerEffects, optional for the use of the simulation.

Used for calculating breeding values for genotypes.

Definition at line 884 of file sim-operations.h.

◆ eff_set_ids

gsc_EffectID* gsc_SimData::eff_set_ids

The identifier number of each set of allele effects in the simulation, ordered by their lookup index.

Definition at line 882 of file sim-operations.h.

◆ genome

gsc_KnownGenome gsc_SimData::genome

A gsc_KnownGenome, which stores the information of known markers and linkage groups, as well as one or more recombination maps for use in simulating meiosis.

Definition at line 873 of file sim-operations.h.

◆ label_defaults

int* gsc_SimData::label_defaults

Array containing the default (birth) value of each custom label.

Definition at line 870 of file sim-operations.h.

◆ label_ids

gsc_LabelID* gsc_SimData::label_ids

The identifier number of each label in the simulation, in order of their lookup index.

Definition at line 868 of file sim-operations.h.

◆ m

gsc_AlleleMatrix* gsc_SimData::m

Pointer to an gsc_AlleleMatrix, which stores data and metadata of founders and simulated offspring.

The gsc_AlleleMatrix is start of a linked list if there are many genotypes.

Definition at line 876 of file sim-operations.h.

◆ n_eff_sets

unsigned int gsc_SimData::n_eff_sets

The number of sets of allele effects in the simulation.

Definition at line 881 of file sim-operations.h.

◆ n_groups

unsigned int gsc_SimData::n_groups

Number of groups currently existing in simulation.

It is guaranteed to never be less than the number of groups in simulation even if not perfectly accurate.

Definition at line 891 of file sim-operations.h.

◆ n_labels

unsigned int gsc_SimData::n_labels

The number of custom labels in the simulation.

Definition at line 867 of file sim-operations.h.

◆ rng

rnd_pcg_t gsc_SimData::rng

Random number generator working memory.

Definition at line 887 of file sim-operations.h.


The documentation for this struct was generated from the following file: