BernoulliRandom Class Reference

Inheritance diagram for BernoulliRandom:

IntegerRandom MTRand List of all members.

Detailed Description

Bernoulli random number generator.

This class generates random numbers from a Bernoulli distribution.

Author:
Bill Smart
Date:
November 2001
Version:
1.0

Definition at line 528 of file Random.H.

Public Member Functions

 BernoulliRandom (const double success=0.5, const unsigned long seed=1UL)
Generate samples
int number ()
 Generate a sample from the random variable.
Moments of the random variable
double mean () const
double variance () const
double stdDev () const
Parameters of the random variable
double success () const
double probSuccess () const
double failure () const
double probFailure () const
Parameters of the random variable
void setProbSuccess (const double success)
void setProbFailure (const double failure)

Private Attributes

double m_success


Constructor & Destructor Documentation

BernoulliRandom ( const double  success = 0.5,
const unsigned long  seed = 1UL 
) [inline]

This constructor sets the success probability, and the random number seed.

Parameters:
success The probability of a successful trial.
seed Random number seed. Do not set this to zero.

Definition at line 535 of file Random.H.


Member Function Documentation

int number (  )  [inline, virtual]

Generate a sample from the random variable.

This function generates a sample from the random variable represented by the class instance.

Returns:
A sample from the random variable.

Implements IntegerRandom.

Definition at line 540 of file Random.H.

References m_success, and MTRand::rand().

double mean (  )  const [inline, virtual]

Returns:
The mean of the random variable.

Implements IntegerRandom.

Definition at line 545 of file Random.H.

References m_success.

double variance (  )  const [inline, virtual]

Returns:
The variance of the random variable.

Implements IntegerRandom.

Definition at line 546 of file Random.H.

References m_success.

Referenced by stdDev().

double stdDev (  )  const [inline, virtual]

Returns:
The standard deviation of the random variable.

Implements IntegerRandom.

Definition at line 547 of file Random.H.

References variance().

double success (  )  const [inline]

Returns:
The probability of success.

Definition at line 553 of file Random.H.

References m_success.

Referenced by probSuccess().

double probSuccess (  )  const [inline]

Returns:
The probability of success.

Definition at line 555 of file Random.H.

References success().

double failure (  )  const [inline]

Returns:
The probability of failure.

Definition at line 557 of file Random.H.

References m_success.

Referenced by probFailure().

double probFailure (  )  const [inline]

Returns:
The probability of failure.

Definition at line 559 of file Random.H.

References failure().

void setProbSuccess ( const double  success  )  [inline]

Set the probability of success for a trial.

Parameters:
success New probability of success.

Definition at line 566 of file Random.H.

References m_success.

void setProbFailure ( const double  failure  )  [inline]

Set the probability of failure for a trial.

Parameters:
failure New probability of failure.

Definition at line 569 of file Random.H.

References m_success.


Member Data Documentation

double m_success [private]

Definition at line 573 of file Random.H.

Referenced by failure(), mean(), number(), setProbFailure(), setProbSuccess(), success(), and variance().


The documentation for this class was generated from the following file:
Generated on Thu Feb 1 15:31:55 2007 for WURDE by  doxygen 1.5.1