CYCLUS
Loading...
Searching...
No Matches
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 276 of file random_number_generator.h.

#include <random_number_generator.h>

Inheritance diagram for cyclus::NegativeBinomialIntDist:
cyclus::IntDistribution

Public Types

typedef boost::shared_ptr< NegativeBinomialIntDistPtr
 
- Public Types inherited from cyclus::IntDistribution
typedef boost::shared_ptr< IntDistributionPtr
 

Public Member Functions

 NegativeBinomialIntDist (int successes, double p_success)
 
virtual int p ()
 
virtual int sample ()
 
virtual int successes ()
 

Member Typedef Documentation

◆ Ptr

Definition at line 282 of file random_number_generator.h.

Constructor & Destructor Documentation

◆ NegativeBinomialIntDist()

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

Definition at line 284 of file random_number_generator.h.

Member Function Documentation

◆ p()

virtual int cyclus::NegativeBinomialIntDist::p ( )
inlinevirtual

Definition at line 294 of file random_number_generator.h.

◆ sample()

virtual int cyclus::NegativeBinomialIntDist::sample ( )
inlinevirtual

Implements cyclus::IntDistribution.

Definition at line 292 of file random_number_generator.h.

◆ successes()

virtual int cyclus::NegativeBinomialIntDist::successes ( )
inlinevirtual

Definition at line 293 of file random_number_generator.h.


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