std::bernoulli_distribution(3)

NAME
std::bernoulli_distribution - A Bernoulli random number distribution.

SYNOPSIS

  Classes
struct param_type

  Public Types
typedef bool result_type

  Public Member Functions
bernoulli_distribution (const param_type &__p)
bernoulli_distribution (double __p=0.5)
result_type max () const
result_type min () const
template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng)
double p () const
void param (const param_type &__param)
param_type param () const
void reset ()

Detailed Description

A Bernoulli random number distribution. Generates a sequence of true and false values with likelihood $ p $ that true will come up and $ (1 - p) $ that false will appear.

Definition at line 2836 of file bits/random.h.

Member Typedef Documentation

  typedef bool std::bernoulli_distribution::result_type

The type of the range of the distribution.

Definition at line 2840 of file bits/random.h.

Constructor & Destructor Documentation

  std::bernoulli_distribution::bernoulli_distribution (double __p = 0.5) [inline, explicit]

Constructs a Bernoulli distribution with likelihood p.

Parameters:
    __p [IN] The likelihood of a true result being returned. Must be in the interval $ [0, 1] $.

Definition at line 2873 of file bits/random.h.

Member Function Documentation

  result_type std::bernoulli_distribution::max () const [inline]

Returns the least upper bound value of the distribution.

Definition at line 2923 of file bits/random.h.

  result_type std::bernoulli_distribution::min () const [inline]

Returns the greatest lower bound value of the distribution.

Definition at line 2916 of file bits/random.h.

  template<typename _UniformRandomNumberGenerator > result_type std::bernoulli_distribution::operator() (_UniformRandomNumberGenerator & __urng) [inline]

Returns the next value in the Bernoullian sequence.

Definition at line 2931 of file bits/random.h.

References p().

  double std::bernoulli_distribution::p () const [inline]

Returns the p parameter of the distribution.

Definition at line 2894 of file bits/random.h.

References std::bernoulli_distribution::bernoulli_distribution::param_type::p().

Referenced by operator()().

  void std::bernoulli_distribution::param (const param_type & __param) [inline]

Sets the parameter set of the distribution.

Parameters:
    __param The new parameter set of the distribution.

Definition at line 2909 of file bits/random.h.

  param_type std::bernoulli_distribution::param () const [inline]

Returns the parameter set of the distribution.

Definition at line 2901 of file bits/random.h.

Referenced by std::operator==(), and std::operator>>().

  void std::bernoulli_distribution::reset () [inline]

Resets the distribution state.

Does nothing for a Bernoulli distribution.

Definition at line 2888 of file bits/random.h.

Author

Generated automatically by Doxygen for libstdc++ from the source code.