std::tr1::bernoulli_distribution(3)

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

SYNOPSIS

  Public Types
typedef int input_type
typedef bool result_type

  Public Member Functions
bernoulli_distribution (double __p=0.5)
template<class _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng)
double p () const
void reset ()

  Friends
template<typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const bernoulli_distribution &__x)
template<typename _CharT , typename _Traits > std::basic_istream< _CharT, _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &__is, bernoulli_distribution &__x)

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 1697 of file tr1/random.h.

Constructor & Destructor Documentation

  std::tr1::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 1711 of file tr1/random.h.

Member Function Documentation

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

Gets the next value in the Bernoullian sequence.

Definition at line 1737 of file tr1/random.h.

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

Gets the p parameter of the distribution.

Definition at line 1721 of file tr1/random.h.

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

Resets the distribution state.

Does nothing for a Bernoulli distribution.

Definition at line 1730 of file tr1/random.h.

Friends And Related Function Documentation

  template<typename _CharT , typename _Traits > std::basic_ostream<_CharT, _Traits>& operator<< (std::basic_ostream< _CharT, _Traits > & __os, const bernoulli_distribution & __x) [friend]

Inserts a bernoulli_distribution random number distribution __x into the output stream __os.

Parameters:
    __os An output stream.
    __x A bernoulli_distribution random number distribution.

Returns:
    The output stream with the state of __x inserted or in an error state.

Definition at line 828 of file tr1/random.tcc.

  template<typename _CharT , typename _Traits > std::basic_istream<_CharT, _Traits>& operator>> (std::basic_istream< _CharT, _Traits > & __is, bernoulli_distribution & __x) [friend]

Extracts a bernoulli_distribution random number distribution __x from the input stream __is.

Parameters:
    __is An input stream.
    __x A bernoulli_distribution random number generator engine.

Returns:
    The input stream with __x extracted or in an error state.

Definition at line 1770 of file tr1/random.h.

Author

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