pops::ExponentialPowerKernel Class Reference

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

#include <exponential_power_kernel.hpp>

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

Protected Attributes
double	alpha
double	beta
std::uniform_real_distribution< double >	distribution

Detailed Description

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

Definition at line 33 of file exponential_power_kernel.hpp.

Constructor & Destructor Documentation

ExponentialPowerKernel()

pops::ExponentialPowerKernel::ExponentialPowerKernel ( double  a, double  b  )

inline

Definition at line 41 of file exponential_power_kernel.hpp.

Member Function Documentation

icdf()

double pops::ExponentialPowerKernel::icdf ( double  x )

inline

Exponential Power 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 81 of file exponential_power_kernel.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

pdf()

double pops::ExponentialPowerKernel::pdf ( double  x )

inline

Exponential Power 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 69 of file exponential_power_kernel.hpp.

Here is the caller graph for this function:

random()

template<class Generator >

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

inline

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

Parameters

generator

uniform random number generator

Returns

value from exponential power distribution

Definition at line 57 of file exponential_power_kernel.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

alpha

double pops::ExponentialPowerKernel::alpha

protected

Definition at line 36 of file exponential_power_kernel.hpp.

beta

double pops::ExponentialPowerKernel::beta

protected

Definition at line 37 of file exponential_power_kernel.hpp.

distribution

std::uniform_real_distribution<double> pops::ExponentialPowerKernel::distribution

protected

Definition at line 38 of file exponential_power_kernel.hpp.

---

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

• include/pops/exponential_power_kernel.hpp