pops::LogisticKernel Class Reference

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

#include <logistic_kernel.hpp>

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

Protected Attributes
double	s
std::uniform_real_distribution< double >	distribution

Detailed Description

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

Definition at line 32 of file logistic_kernel.hpp.

Constructor & Destructor Documentation

LogisticKernel()

pops::LogisticKernel::LogisticKernel ( double  scale )

inline

Definition at line 39 of file logistic_kernel.hpp.

Member Function Documentation

icdf()

double pops::LogisticKernel::icdf ( double  x )

inline

Logistic 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 80 of file logistic_kernel.hpp.

Here is the caller graph for this function:

pdf()

double pops::LogisticKernel::pdf ( double  x )

inline

Logistic 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 logistic_kernel.hpp.

Here is the caller graph for this function:

random()

template<class Generator >

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

inline

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

Parameters

generator

uniform random number generator

Returns

value from logistic distribution

Definition at line 54 of file logistic_kernel.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

distribution

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

protected

Definition at line 36 of file logistic_kernel.hpp.

s

double pops::LogisticKernel::s

protected

Definition at line 35 of file logistic_kernel.hpp.

---

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

• include/pops/logistic_kernel.hpp