Parallel PopGen Package
GO_Fish::allele_trajectories::sim_constants Struct Reference

specification of simulation constants More...

#include <go_fish_data_struct.h>

Public Attributes

int seed1
 random number seed 1 of 2 More...
 
int seed2
 random number seed 2 of 2 More...
 
int num_generations
 number of generations in simulation More...
 
float num_sites
 number of sites in simulation More...
 
int num_populations
 number of populations in simulation More...
 
bool init_mse
 true: initialize simulation in mutation_selection_equilibrium; false: initialize blank simulation or using previous simulation time sample More...
 
int prev_sim_sample
 time sample of previous simulation to use for initializing current simulation More...
 
int compact_interval
 how often to compact the simulation and remove fixed or lost mutations More...
 
int device
 GPU identity to run simulation on, if -1 next available GPU will be assigned. More...
 

Detailed Description

specification of simulation constants

Definition at line 57 of file go_fish_data_struct.h.

Member Data Documentation

§ seed1

int GO_Fish::allele_trajectories::sim_constants::seed1

random number seed 1 of 2

default: 0xbeeff00d

Examples:
Example1-Speed, Example2-DaDi, and Example3-Compilation.

Definition at line 58 of file go_fish_data_struct.h.

§ seed2

int GO_Fish::allele_trajectories::sim_constants::seed2

random number seed 2 of 2

default: 0xdecafbad

Examples:
Example1-Speed, Example2-DaDi, and Example3-Compilation.

Definition at line 59 of file go_fish_data_struct.h.

§ num_generations

int GO_Fish::allele_trajectories::sim_constants::num_generations

number of generations in simulation

default: 0

Examples:
Example1-Speed, Example2-DaDi, and Example3-Compilation.

Definition at line 60 of file go_fish_data_struct.h.

§ num_sites

float GO_Fish::allele_trajectories::sim_constants::num_sites

number of sites in simulation

default: 1000

Examples:
Example1-Speed, Example2-DaDi, and Example3-Compilation.

Definition at line 61 of file go_fish_data_struct.h.

§ num_populations

int GO_Fish::allele_trajectories::sim_constants::num_populations

number of populations in simulation

default: 1

Examples:
Example1-Speed, Example2-DaDi, and Example3-Compilation.

Definition at line 62 of file go_fish_data_struct.h.

§ init_mse

bool GO_Fish::allele_trajectories::sim_constants::init_mse

true: initialize simulation in mutation_selection_equilibrium; false: initialize blank simulation or using previous simulation time sample

default: true

Examples:
Example3-Compilation.

Definition at line 63 of file go_fish_data_struct.h.

§ prev_sim_sample

int GO_Fish::allele_trajectories::sim_constants::prev_sim_sample

time sample of previous simulation to use for initializing current simulation

overridden by init_mse if init_mse = true
default: -1 (if init_mse = false, ignore previous simulation & initialize blank simulation)

Examples:
Example3-Compilation.

Definition at line 64 of file go_fish_data_struct.h.

§ compact_interval

int GO_Fish::allele_trajectories::sim_constants::compact_interval

how often to compact the simulation and remove fixed or lost mutations

default: 35 := compact every 35 generations
compact_interval = 0 turns off compact (mutations will not be removed even if lost or fixed)

Note: Changing the compact interval will change the result of the simulation run for the same seed numbers. However, these are not independent simulation runs! Changing the compact interval produces new random, but correlated simulation results.

Examples:
Example1-Speed, Example2-DaDi, and Example3-Compilation.

Definition at line 65 of file go_fish_data_struct.h.

§ device

int GO_Fish::allele_trajectories::sim_constants::device

GPU identity to run simulation on, if -1 next available GPU will be assigned.

default: -1

Definition at line 67 of file go_fish_data_struct.h.


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