pops::ExponentialKernel Class Reference

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

#include <exponential_kernel.hpp>

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

Protected Attributes
double	beta
std::exponential_distribution< double >	exponential_distribution

Detailed Description

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

Definition at line 33 of file exponential_kernel.hpp.

Constructor & Destructor Documentation

ExponentialKernel()

pops::ExponentialKernel::ExponentialKernel ( double  b )

inline

Definition at line 40 of file exponential_kernel.hpp.

Member Function Documentation

icdf()

double pops::ExponentialKernel::icdf ( double  x )

inline

Exponential 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)

Definition at line 79 of file exponential_kernel.hpp.

Here is the caller graph for this function:

pdf()

double pops::ExponentialKernel::pdf ( double  x )

inline

Exponential 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 65 of file exponential_kernel.hpp.

Here is the caller graph for this function:

random()

template<class Generator >

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

inline

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

Parameters

generator

uniform random number generator

Returns

value from exponential distribution

Definition at line 54 of file exponential_kernel.hpp.

Here is the caller graph for this function:

Member Data Documentation

beta

double pops::ExponentialKernel::beta

protected

Definition at line 36 of file exponential_kernel.hpp.

exponential_distribution

std::exponential_distribution<double> pops::ExponentialKernel::exponential_distribution

protected

Definition at line 37 of file exponential_kernel.hpp.

---

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

• include/pops/exponential_kernel.hpp