cyclus::NegativeBinomialIntDist Class Reference

Detailed Description

NegativeBinomialIntDist takes the number of successes desired and a probability of success on a single trial and returns the number of trials needed to reach the desired successes.

When successes is one, this is equivalent to a Geometric distribution.

Definition at line 301 of file random_number_generator.h.

#include <random_number_generator.h>

Inheritance diagram for cyclus::NegativeBinomialIntDist:

Public Types
typedef boost::shared_ptr< NegativeBinomialIntDist >	Ptr
Public Types inherited from cyclus::IntDistribution
typedef boost::shared_ptr< IntDistribution >	Ptr

Public Member Functions
	NegativeBinomialIntDist (int successes, double p_success)
virtual int	p ()
virtual int	sample ()
virtual int	successes ()

Member Typedef Documentation

Ptr

typedef boost::shared_ptr<NegativeBinomialIntDist> cyclus::NegativeBinomialIntDist::Ptr

Definition at line 308 of file random_number_generator.h.

Constructor & Destructor Documentation

NegativeBinomialIntDist()

cyclus::NegativeBinomialIntDist::NegativeBinomialIntDist ( int successes, double p_success )

inline

Definition at line 310 of file random_number_generator.h.

Member Function Documentation

p()

virtual int cyclus::NegativeBinomialIntDist::p ( )

inlinevirtual

Definition at line 323 of file random_number_generator.h.

sample()

virtual int cyclus::NegativeBinomialIntDist::sample ( )

inlinevirtual

Implements cyclus::IntDistribution.

Definition at line 321 of file random_number_generator.h.

successes()

virtual int cyclus::NegativeBinomialIntDist::successes ( )

inlinevirtual

Definition at line 322 of file random_number_generator.h.

---

The documentation for this class was generated from the following file:

• random_number_generator.h