pops::GammaKernel Class Reference

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

#include <gamma_kernel.hpp>

Public Member Functions
	GammaKernel (double a, double t)
template<class Generator >
double	random (Generator &generator)
	Returns random value from gamma distribution Used by RadialKernel to determine location of spread. More...
double	pdf (double x)
	Gamma probability density function Used by DeterministicKernel to determine location of spread. More...
double	cdf (double x)
	Gamma cumulative distribution function used by gamma icdf. More...
double	icdf (double x)
	Gamma inverse cumulative distribution (quantile) function Used by DeterministicKernel to determine maximum distance of spread There is no known closed-form solution for Gamma icdf, used Newton's method References include: Abramowitz, M. More...

Protected Attributes
double	alpha
double	theta
std::gamma_distribution< double >	gamma_distribution

Detailed Description

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

Definition at line 33 of file gamma_kernel.hpp.

Constructor & Destructor Documentation

GammaKernel()

pops::GammaKernel::GammaKernel ( double  a, double  t  )

inline

Definition at line 41 of file gamma_kernel.hpp.

Member Function Documentation

cdf()

double pops::GammaKernel::cdf ( double  x )

inline

Gamma cumulative distribution function used by gamma icdf.

Parameters

x	value in distribution

Returns

probability of x

Definition at line 82 of file gamma_kernel.hpp.

Here is the caller graph for this function:

icdf()

double pops::GammaKernel::icdf ( double  x )

inline

Gamma inverse cumulative distribution (quantile) function Used by DeterministicKernel to determine maximum distance of spread There is no known closed-form solution for Gamma icdf, used Newton's method References include: Abramowitz, M.

and Stegun, I.A. (1964) Handbook of Mathematical Functions, Dover, New York, section 26.1. Evans, M., Hastings, N., and Peacock, B. (1993) Statistical Distributions, 2nd ed., Wiley.

Parameters

x	proportion of the distribution

Returns

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

Definition at line 104 of file gamma_kernel.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

pdf()

double pops::GammaKernel::pdf ( double  x )

inline

Gamma 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 68 of file gamma_kernel.hpp.

Here is the caller graph for this function:

random()

template<class Generator >

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

inline

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

Parameters

generator

uniform random number generator

Returns

value from gamma distribution

Definition at line 57 of file gamma_kernel.hpp.

Here is the caller graph for this function:

Member Data Documentation

alpha

double pops::GammaKernel::alpha

protected

Definition at line 36 of file gamma_kernel.hpp.

gamma_distribution

std::gamma_distribution<double> pops::GammaKernel::gamma_distribution

protected

Definition at line 38 of file gamma_kernel.hpp.

theta

double pops::GammaKernel::theta

protected

Definition at line 37 of file gamma_kernel.hpp.

---

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

• include/pops/gamma_kernel.hpp