Quetzal-CoaTL
The Coalescence Template Library
Loading...
Searching...
No Matches
quetzal::simulator::DiscreteTimeWrightFisher Class Reference

#include <quetzal/simulator/DiscreteTimeWrightFisher.hpp>

Detailed Description

Discrete time simulation in a Wright-Fisher Population.

Remarks
All methods are static. Use on-the-fly policy.

This simulator consists in a backward coalescent simulation that traces back the ancestry of a sample of gene copies sampled in a populations. Either the user wants to perform generation-by-generation coalescence during a given number of generations (leading to a Forest of coalescent trees rather a single genealogy), or the user would be interested in coalescing lineages until MRCA has been found.

Public Types

template<typename Space , typename Tree >
using forest_type = quetzal::coalescence::container::Forest< Space, Tree >
 

Static Public Member Functions

template<typename Space , typename Tree , typename Generator , typename Binop , typename TimeFun >
static Tree coalesce (forest_type< Space, Tree > const &forest, unsigned int N, Generator &gen, Binop branch, TimeFun make_tree)
 
template<typename Generator >
static unsigned int sample_waiting_time (unsigned int k, unsigned int N, Generator &gen)
 
template<typename Tree , typename Generator , typename Binop , typename TimeFun >
static Tree coalesce (std::vector< Tree > &trees, unsigned int N, Generator &gen, Binop branch, TimeFun make_tree)
 
template<typename MergerType = coalescence::merger_policy::SimultaneousMultipleMerger< coalescence::occupancy_spectrum::sampling_policy::on_the_fly>, typename Tree , typename Generator , typename Binop , typename TimeFun >
static std::vector< Tree > coalesce (std::vector< Tree > &trees, unsigned int N, unsigned int g, Generator &gen, Binop branch, TimeFun make_tree)
 

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