quetzal::demography::dispersal_kernel::negative_exponential< 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::negative_exponential< Distance >

Negative Exponential dispersal location kernel (exponential tail fatness)

To be used as reference against more fat-tailed kernels. Suitable for representing a travel at constant speed in a random direction with a constant stopping rate, or a correlated random walk with settlement.

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::negative_exponential< Distance >::mean_dispersal_distance ( param_type const &  p )

inlinestaticconstexpr

Mean dispersal distance.

Parameters

p	Parameters of the distribution

Returns

The value of the expression \( 2a \)

pdf()

template<QuantityOf< isq::length > Distance = mp_units::quantity<mp_units::si::metre>>

static constexpr pdf_result_type quetzal::demography::dispersal_kernel::negative_exponential< Distance >::pdf ( Distance  r, param_type const &  p  )

inlinestaticconstexpr

Probability density function.

Parameters

r	The distance radius from the source to the target
p	Parameters of the distribution

Returns

The value of the expression \( \frac{1}{2 \pi a^2} exp(-\frac{r}{a}) \)

---

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

• /home/runner/work/quetzal-CoaTL/quetzal-CoaTL/src/include/quetzal/demography/dispersal_kernel.hpp