A library for working with phylogenetic and population genetic data.
v0.32.0
SimulatorPendantLengthDistribution Class Reference

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

Detailed Description

Definition at line 237 of file distributions.hpp.

Public Member Functions

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

Public Attributes

double max = 1.0
 
double min = 0.0
 

Constructor & Destructor Documentation

◆ SimulatorPendantLengthDistribution() [1/3]

◆ ~SimulatorPendantLengthDistribution()

◆ SimulatorPendantLengthDistribution() [2/3]

◆ SimulatorPendantLengthDistribution() [3/3]

Member Function Documentation

◆ generate()

double generate ( PlacementTreeEdge const &  edge)
inline

Return a randomly chosen position on an edge.

Definition at line 270 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 261 of file distributions.hpp.

Member Data Documentation

◆ max

double max = 1.0

Definition at line 285 of file distributions.hpp.

◆ min

double min = 0.0

Definition at line 284 of file distributions.hpp.


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