A library for working with phylogenetic and population genetic data.
v0.27.0
Public Member Functions | List of all members
Simulator Class Reference

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

Detailed Description

Simulate Pqueries on the Tree of a Sample.

Definition at line 48 of file simulator.hpp.

Public Member Functions

 Simulator ()=default
 
 Simulator (Simulator &&)=default
 
 Simulator (Simulator const &)=default
 
 ~Simulator ()=default
 
SimulatorEdgeDistribution & edge_distribution ()
 
SimulatorExtraPlacementDistribution & extra_placement_distribution ()
 
void generate (Sample &sample, size_t n)
 Generate n many Pqueries and place them in the Sample. More...
 
SimulatorLikeWeightRatioDistribution & like_weight_ratio_distribution ()
 
Simulator & operator= (Simulator &&)=default
 
Simulator & operator= (Simulator const &)=default
 
SimulatorPendantLengthDistribution & pendant_length_distribution ()
 
SimulatorProximalLengthDistribution & proximal_length_distribution ()
 

Constructor & Destructor Documentation

◆ Simulator() [1/3]

Simulator ( )
default

◆ ~Simulator()

~Simulator ( )
default

◆ Simulator() [2/3]

Simulator ( Simulator const &  )
default

◆ Simulator() [3/3]

Simulator ( Simulator &&  )
default

Member Function Documentation

◆ edge_distribution()

SimulatorEdgeDistribution& edge_distribution ( )
inline

Definition at line 75 of file simulator.hpp.

◆ extra_placement_distribution()

SimulatorExtraPlacementDistribution& extra_placement_distribution ( )
inline

Definition at line 80 of file simulator.hpp.

◆ generate()

void generate ( Sample &  sample,
size_t  n 
)

Generate n many Pqueries and place them in the Sample.

Definition at line 47 of file simulator.cpp.

◆ like_weight_ratio_distribution()

SimulatorLikeWeightRatioDistribution& like_weight_ratio_distribution ( )
inline

Definition at line 85 of file simulator.hpp.

◆ operator=() [1/2]

Simulator& operator= ( Simulator &&  )
default

◆ operator=() [2/2]

Simulator& operator= ( Simulator const &  )
default

◆ pendant_length_distribution()

SimulatorPendantLengthDistribution& pendant_length_distribution ( )
inline

Definition at line 95 of file simulator.hpp.

◆ proximal_length_distribution()

SimulatorProximalLengthDistribution& proximal_length_distribution ( )
inline

Definition at line 90 of file simulator.hpp.

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