A library for working with phylogenetic and population genetic data.
v0.27.0
SimulatorProximalLengthDistribution Class Reference

#include <genesis/placement/simulator/distributions.hpp>

Detailed Description

Definition at line 296 of file distributions.hpp.

Public Member Functions

 SimulatorProximalLengthDistribution ()=default
 
 SimulatorProximalLengthDistribution (SimulatorProximalLengthDistribution &&)=default
 
 SimulatorProximalLengthDistribution (SimulatorProximalLengthDistribution const &)=default
 
 ~SimulatorProximalLengthDistribution ()=default
 
double generate (PlacementTreeEdge const &edge)
 Return a randomly chosen position on an edge. More...
 
SimulatorProximalLengthDistributionoperator= (SimulatorProximalLengthDistribution &&)=default
 
SimulatorProximalLengthDistributionoperator= (SimulatorProximalLengthDistribution const &)=default
 
void prepare (Sample const &sample)
 Prepare the distribution for usage. Needs to be called before generate(). More...
 

Constructor & Destructor Documentation

◆ SimulatorProximalLengthDistribution() [1/3]

◆ ~SimulatorProximalLengthDistribution()

◆ SimulatorProximalLengthDistribution() [2/3]

◆ SimulatorProximalLengthDistribution() [3/3]

Member Function Documentation

◆ generate()

double generate ( PlacementTreeEdge const &  edge)
inline

Return a randomly chosen position on an edge.

Definition at line 329 of file distributions.hpp.

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ prepare()

void prepare ( Sample const &  sample)
inline

Prepare the distribution for usage. Needs to be called before generate().

Definition at line 320 of file distributions.hpp.


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