pops::CauchyKernel Class Reference

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

#include <cauchy_kernel.hpp>

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

Protected Attributes
double	s
std::cauchy_distribution< double >	cauchy_distribution

Detailed Description

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

Definition at line 33 of file cauchy_kernel.hpp.

Constructor & Destructor Documentation

CauchyKernel()

pops::CauchyKernel::CauchyKernel ( double  scale )

inline

Definition at line 40 of file cauchy_kernel.hpp.

Member Function Documentation

icdf()

double pops::CauchyKernel::icdf ( double  x )

inline

Cauchy 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 77 of file cauchy_kernel.hpp.

Here is the caller graph for this function:

pdf()

double pops::CauchyKernel::pdf ( double  x )

inline

Cauchy 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 cauchy_kernel.hpp.

Here is the caller graph for this function:

random()

template<class Generator >

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

inline

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

Parameters

generator

uniform random number generator

Returns

value from cauchy distribution

Definition at line 55 of file cauchy_kernel.hpp.

Here is the caller graph for this function:

Member Data Documentation

cauchy_distribution

std::cauchy_distribution<double> pops::CauchyKernel::cauchy_distribution

protected

Definition at line 37 of file cauchy_kernel.hpp.

s

double pops::CauchyKernel::s

protected

Definition at line 36 of file cauchy_kernel.hpp.

---

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

• include/pops/cauchy_kernel.hpp