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

Parameter set for the distribution. More...

#include <PRNGDistribution.hpp>

Public Types
using	distribution_type = NegativeBinomialDistribution< IntType >

Public Member Functions
	param_type ()
	Default constructor. Creates parameters for k=1, p=0.5.
	param_type (IntType k, double p=0.5)
	Constructs parameters.
IntType	k () const
	Gets the number of successes required.
double	p () const
	Gets the success probability.

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::NegativeBinomialDistribution< IntType >::param_type

Parameter set for the distribution.

Stores the number of successes required and the success probability.

Member Typedef Documentation

distribution_type

template<typename IntType = int>

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

Constructor & Destructor Documentation

param_type() [1/2]

template<typename IntType = int>

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

inline

Default constructor. Creates parameters for k=1, p=0.5.

param_type() [2/2]

template<typename IntType = int>

Infinity::Engine::NegativeBinomialDistribution< IntType >::param_type::param_type ( IntType  k, double  p = 0.5  )

inlineexplicit

Constructs parameters.

Parameters

k	Number of successes required (must be > 0)
p	Probability of success per trial, must be in (0, 1)

Member Function Documentation

k()

template<typename IntType = int>

IntType Infinity::Engine::NegativeBinomialDistribution< IntType >::param_type::k ( ) const

inline

Gets the number of successes required.

p()

template<typename IntType = int>

double Infinity::Engine::NegativeBinomialDistribution< IntType >::param_type::p ( ) const

inline

Gets the success probability.

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