pops::HyperbolicSecantKernel Class Reference

Dispersal kernel for hyperbolic secant class utilized by RadialKernel and DeterministicKernel. More...

#include <hyperbolic_secant_kernel.hpp>

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

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

Detailed Description

Dispersal kernel for hyperbolic secant class utilized by RadialKernel and DeterministicKernel.

Definition at line 33 of file hyperbolic_secant_kernel.hpp.

Constructor & Destructor Documentation

HyperbolicSecantKernel()

pops::HyperbolicSecantKernel::HyperbolicSecantKernel ( double  s )

inline

Definition at line 40 of file hyperbolic_secant_kernel.hpp.

Member Function Documentation

icdf()

double pops::HyperbolicSecantKernel::icdf ( double  x )

inline

Hyperbolic secant 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 hyperbolic_secant_kernel.hpp.

Here is the caller graph for this function:

pdf()

double pops::HyperbolicSecantKernel::pdf ( double  x )

inline

Hyperbolic secant 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 hyperbolic_secant_kernel.hpp.

Here is the caller graph for this function:

random()

template<class Generator >

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

inline

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

Parameters

generator

uniform random number generator

Returns

value from hyperbolic secant distribution

Definition at line 54 of file hyperbolic_secant_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::HyperbolicSecantKernel::distribution

protected

Definition at line 37 of file hyperbolic_secant_kernel.hpp.

sigma

double pops::HyperbolicSecantKernel::sigma

protected

Definition at line 36 of file hyperbolic_secant_kernel.hpp.

---

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

• include/pops/hyperbolic_secant_kernel.hpp