Contents
The functionality of FFPopSim
is described in detail in the following sections.
Population Class Overviews
Simulations in FFPopSim
are centered around population classes. These methods of these classes are divided in categories and described at the following pages:
Genealogies
FFPopSim
can genealogies at individual loci within haploid_highd
, using multi_locus_genealogy
. Internally, this class itself contains instances of rooted_tree
.
The documentation for the genealogy tracking capability is divided in two parts:
see the website of our review for examples and scripts;
see
haploid_highd
or the reference pages below for details on specific functions.
Reference Pages
The classes used in FFPopSim
are listed in the following pages for reference purposes:
- clone Class Reference
- genotype_value_pair Class Reference
- haploid_lowd Class Reference
- haploid_highd Class Reference
- hivgene Class reference
- hivpopulation Class Reference
- index_value_pair Class Reference
- multi_locus_genealogy Class Reference
- polymorphism Class Reference
- rooted_tree Class Reference
- stat Class Reference
- tree_key Class Reference
- tree_step Class Reference
- tree_node Class Reference
- tree_edge Class Reference
In addition, the following helper functions are defined: