Infinity::Engine::PoissonDistribution< IntType >::param_type Struct Reference

Parameter set for the distribution. More...

#include <PRNGDistribution.hpp>

Public Types
using	distribution_type = PoissonDistribution< IntType >

Public Member Functions
	param_type ()
	Default constructor. Creates parameters for mean=1.0.
	param_type (double mean)
	Constructs parameters.
double	mean () const
	Gets the mean (rate) parameter.

Friends
bool	operator== (const param_type &lhs, const param_type &rhs)
bool	operator!= (const param_type &lhs, const param_type &rhs)

Detailed Description

template<typename IntType = int>
struct Infinity::Engine::PoissonDistribution< IntType >::param_type

Parameter set for the distribution.

Stores the mean (rate) parameter of the Poisson distribution.

Member Typedef Documentation

distribution_type

template<typename IntType = int>

using Infinity::Engine::PoissonDistribution< IntType >::param_type::distribution_type = PoissonDistribution<IntType>

Constructor & Destructor Documentation

param_type() [1/2]

template<typename IntType = int>

Infinity::Engine::PoissonDistribution< IntType >::param_type::param_type ( )

inline

Default constructor. Creates parameters for mean=1.0.

param_type() [2/2]

template<typename IntType = int>

Infinity::Engine::PoissonDistribution< IntType >::param_type::param_type ( double  mean )

inlineexplicit

Constructs parameters.

Parameters

mean	Mean number of events (must be > 0), also called lambda or rate

Member Function Documentation

mean()

template<typename IntType = int>

double Infinity::Engine::PoissonDistribution< IntType >::param_type::mean ( ) const

inline

Gets the mean (rate) parameter.

Friends And Related Symbol Documentation

operator!=

template<typename IntType = int>

bool operator!= ( const param_type &  lhs, const param_type &  rhs  )

friend

operator==

template<typename IntType = int>

bool operator== ( const param_type &  lhs, const param_type &  rhs  )

friend