pops::LogNormalKernel Class Reference

Dispersal kernel for log normal distribution class utilized by RadialKernel and DeterministicKernel. More...

#include <lognormal_kernel.hpp>

Public Member Functions
	LogNormalKernel (double s)
template<class Generator >
double	random (Generator &generator)
	Returns random value from log normal distribution Used by RadialKernel to determine location of spread. More...
double	pdf (double x)
	Log normal probability density function Used by DeterministicKernel to determine location of spread. More...
double	icdf (double x)
	Log normal inverse cumulative distribution (quantile) function Used by DeterministicKernel to determine maximum distance of spread. More...

Protected Attributes
double	sigma
std::lognormal_distribution< double >	lognormal_distribution

Detailed Description

Dispersal kernel for log normal distribution class utilized by RadialKernel and DeterministicKernel.

Definition at line 35 of file lognormal_kernel.hpp.

Constructor & Destructor Documentation

LogNormalKernel()

pops::LogNormalKernel::LogNormalKernel ( double  s )

inline

Definition at line 42 of file lognormal_kernel.hpp.

Member Function Documentation

icdf()

double pops::LogNormalKernel::icdf ( double  x )

inline

Log normal inverse cumulative distribution (quantile) function Used by DeterministicKernel to determine maximum distance of spread.

Parameters

x	proportion of the distribution

Returns

value in distribution that is less than or equal to probability (x)

Note

uses approximation for inverse error function from "A handy approximation for the error function and its inverse" by Sergei Winitzki

Definition at line 87 of file lognormal_kernel.hpp.

Here is the caller graph for this function:

pdf()

double pops::LogNormalKernel::pdf ( double  x )

inline

Log normal probability density function Used by DeterministicKernel to determine location of spread.

Parameters

x	point within same space of distribution

Returns

relative likelihood that a random variable would equal x

Definition at line 67 of file lognormal_kernel.hpp.

Here is the caller graph for this function:

random()

template<class Generator >

double pops::LogNormalKernel::random ( Generator &  generator )

inline

Returns random value from log normal distribution Used by RadialKernel to determine location of spread.

Parameters

generator

uniform random number generator

Returns

value from log normal distribution

Definition at line 56 of file lognormal_kernel.hpp.

Here is the caller graph for this function:

Member Data Documentation

lognormal_distribution

std::lognormal_distribution<double> pops::LogNormalKernel::lognormal_distribution

protected

Definition at line 39 of file lognormal_kernel.hpp.

sigma

double pops::LogNormalKernel::sigma

protected

Definition at line 38 of file lognormal_kernel.hpp.

---

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

• include/pops/lognormal_kernel.hpp