Quetzal-CoaTL
The Coalescence Template Library
Loading...
Searching...
No Matches
quetzal::demography::dispersal_kernel::gaussian< 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< Distance >

Gaussian dispersal location kernel (thin-tailed)

To be used as a reference against leptokurtic kernels. Suitable for diffusion-based dispersal or complete random-walk during a constant time.

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 &p)
 Probability density function.
 
static constexpr Distance mean_dispersal_distance (param_type const &p)
 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< Distance >::mean_dispersal_distance ( param_type const &  p)
inlinestaticconstexpr

Mean dispersal distance.

Parameters
pParameters of the distribution
Returns
The value of the expression \( \frac{a\sqrt{\pi}}{2} \)

◆ pdf()

template<QuantityOf< isq::length > Distance = mp_units::quantity<mp_units::si::metre>>
static constexpr pdf_result_type quetzal::demography::dispersal_kernel::gaussian< Distance >::pdf ( Distance  r,
param_type const &  p 
)
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{1}{\pi a^2}.exp(-\frac{r^2}{a^2}) \)

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