pops::WeibullKernel Class Reference

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

#include <weibull_kernel.hpp>

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

Protected Attributes
double	a
double	b
std::weibull_distribution< double >	weibull_distribution

Detailed Description

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

Definition at line 33 of file weibull_kernel.hpp.

Constructor & Destructor Documentation

WeibullKernel()

pops::WeibullKernel::WeibullKernel ( double  scale, double  shape  )

inline

Definition at line 41 of file weibull_kernel.hpp.

Member Function Documentation

icdf()

double pops::WeibullKernel::icdf ( double  x )

inline

Weibull 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 84 of file weibull_kernel.hpp.

Here is the caller graph for this function:

pdf()

double pops::WeibullKernel::pdf ( double  x )

inline

Weibull 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 weibull_kernel.hpp.

Here is the caller graph for this function:

random()

template<class Generator >

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

inline

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

Parameters

generator

uniform random number generator

Returns

value from weibull distribution

Definition at line 57 of file weibull_kernel.hpp.

Here is the caller graph for this function:

Member Data Documentation

a

double pops::WeibullKernel::a

protected

Definition at line 36 of file weibull_kernel.hpp.

b

double pops::WeibullKernel::b

protected

Definition at line 37 of file weibull_kernel.hpp.

weibull_distribution

std::weibull_distribution<double> pops::WeibullKernel::weibull_distribution

protected

Definition at line 38 of file weibull_kernel.hpp.

---

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

• include/pops/weibull_kernel.hpp