A toolkit for working with phylogenetic data.
v0.24.0
SimulatorEdgeDistribution Class Reference

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

Detailed Description

Definition at line 49 of file distributions.hpp.

Public Member Functions

 SimulatorEdgeDistribution ()=default
 
 SimulatorEdgeDistribution (SimulatorEdgeDistribution const &)=default
 
 SimulatorEdgeDistribution (SimulatorEdgeDistribution &&)=default
 
 ~SimulatorEdgeDistribution ()=default
 
size_t generate ()
 Return a randomly chosen edge index, according to the distribution. More...
 
SimulatorEdgeDistributionoperator= (SimulatorEdgeDistribution const &)=default
 
SimulatorEdgeDistributionoperator= (SimulatorEdgeDistribution &&)=default
 
void prepare (Sample const &sample)
 Prepare the distribution for usage. Needs to be called before generate(). More...
 

Public Attributes

std::vector< double > edge_weights
 

Constructor & Destructor Documentation

◆ SimulatorEdgeDistribution() [1/3]

◆ ~SimulatorEdgeDistribution()

◆ SimulatorEdgeDistribution() [2/3]

◆ SimulatorEdgeDistribution() [3/3]

Member Function Documentation

◆ generate()

size_t generate ( )
inline

Return a randomly chosen edge index, according to the distribution.

Definition at line 94 of file distributions.hpp.

◆ operator=() [1/2]

SimulatorEdgeDistribution& operator= ( SimulatorEdgeDistribution const &  )
default

◆ operator=() [2/2]

◆ prepare()

void prepare ( Sample const &  sample)
inline

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

Definition at line 73 of file distributions.hpp.

Member Data Documentation

◆ edge_weights

std::vector<double> edge_weights

Definition at line 105 of file distributions.hpp.


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