pops::NormalKernel Class Reference

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

#include <normal_kernel.hpp>

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

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

Detailed Description

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

Definition at line 34 of file normal_kernel.hpp.

Constructor & Destructor Documentation

NormalKernel()

pops::NormalKernel::NormalKernel ( double  s )

inline

Definition at line 41 of file normal_kernel.hpp.

Member Function Documentation

icdf()

double pops::NormalKernel::icdf ( double  x )

inline

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 82 of file normal_kernel.hpp.

Here is the caller graph for this function:

pdf()

double pops::NormalKernel::pdf ( double  x )

inline

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 66 of file normal_kernel.hpp.

Here is the caller graph for this function:

random()

template<class Generator >

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

inline

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

Parameters

generator

uniform random number generator

Returns

value from normal distribution

Definition at line 55 of file normal_kernel.hpp.

Here is the caller graph for this function:

Member Data Documentation

normal_distribution

std::normal_distribution<double> pops::NormalKernel::normal_distribution

protected

Definition at line 38 of file normal_kernel.hpp.

sigma

double pops::NormalKernel::sigma

protected

Definition at line 37 of file normal_kernel.hpp.

---

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

• include/pops/normal_kernel.hpp