Quetzal-CoaTL
The Coalescence Template Library
Loading...
Searching...
No Matches
quetzal::demography::dispersal_kernel::gaussian_mixture< Distance > Struct Template Reference

#include <quetzal/demography/dispersal_kernel.hpp>

Detailed Description

template<QuantityOf< isq::length > Distance = mp_units::quantity<mp_units::si::metre>>
struct quetzal::demography::dispersal_kernel::gaussian_mixture< Distance >

Gaussian Mixture dispersal location kernel (leptokurtic, never fat-tailed)

Used in theoretical studies.

Classes

struct  param_type
 Dispersal location kernel parameter. More...
 

Public Types

using pdf_result_type = quantity< inverse(pow< 2 >(Distance::reference)), typename Distance::rep >
 Probability density function value type.
 

Static Public Member Functions

static constexpr pdf_result_type pdf (Distance r, param_type const &param)
 Probability density function.
 
static constexpr Distance mean_dispersal_distance (param_type const &param)
 Mean dispersal distance.
 

Member Function Documentation

◆ mean_dispersal_distance()

template<QuantityOf< isq::length > Distance = mp_units::quantity<mp_units::si::metre>>
static constexpr Distance quetzal::demography::dispersal_kernel::gaussian_mixture< Distance >::mean_dispersal_distance ( param_type const &  param)
inlinestaticconstexpr

Mean dispersal distance.

Parameters
pParameters of the distribution
Returns
The value of the expression \( \frac{\sqrt{\pi}}{2}~ (pa_1+(1-p)a_2) \)

◆ pdf()

template<QuantityOf< isq::length > Distance = mp_units::quantity<mp_units::si::metre>>
static constexpr pdf_result_type quetzal::demography::dispersal_kernel::gaussian_mixture< Distance >::pdf ( Distance  r,
param_type const &  param 
)
inlinestaticconstexpr

Probability density function.

Parameters
rThe distance radius from the source to the target
pParameters of the distribution
Returns
The value of the expression \( \frac{p}{\pi a_1^2} exp(- \frac{r^2}{a_1^2}) + \frac{1-p}{\pi a_2^2} exp(\frac{r^2}{a_2^2}) \)

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