Infinity Engine v0.6.20
C++ API Documentation
Loading...
Searching...
No Matches
Infinity::Engine::BernoulliDistribution::param_type Struct Reference

Parameter set for the distribution. More...

#include <PRNGDistribution.hpp>

Public Types

using distribution_type = BernoulliDistribution
 

Public Member Functions

 param_type ()
 Default constructor. Creates parameters for fair coin (p=0.5).
 
 param_type (double p)
 Constructs parameters.
 
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

Parameter set for the distribution.

Stores the success probability parameter.

Member Typedef Documentation

◆ distribution_type

Constructor & Destructor Documentation

◆ param_type() [1/2]

Infinity::Engine::BernoulliDistribution::param_type::param_type ( )
inline

Default constructor. Creates parameters for fair coin (p=0.5).

◆ param_type() [2/2]

Infinity::Engine::BernoulliDistribution::param_type::param_type ( double  p)
inlineexplicit

Constructs parameters.

Parameters
pProbability of success, must be in [0, 1]

Member Function Documentation

◆ p()

double Infinity::Engine::BernoulliDistribution::param_type::p ( ) const
inline

Gets the success probability.

Friends And Related Symbol Documentation

◆ operator!=

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

◆ operator==

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