CYCLUS
Loading...
Searching...
No Matches
cyclus::BinomialIntDist Class Reference

Detailed Description

Binomial distribution requries an integer number of trials and a probability of success for each trial.

Sampling returns the number of successes. When trials is one, this is equivalent to a Bernoulli dist

Definition at line 251 of file random_number_generator.h.

#include <random_number_generator.h>

Inheritance diagram for cyclus::BinomialIntDist:
cyclus::IntDistribution

Public Types

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

Public Member Functions

 BinomialIntDist (int trials, double p_success)
 
virtual int p ()
 
virtual int sample ()
 
virtual int trials ()
 

Member Typedef Documentation

◆ Ptr

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

Definition at line 257 of file random_number_generator.h.

Constructor & Destructor Documentation

◆ BinomialIntDist()

cyclus::BinomialIntDist::BinomialIntDist ( int trials,
double p_success )
inline

Definition at line 259 of file random_number_generator.h.

Member Function Documentation

◆ p()

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

Definition at line 269 of file random_number_generator.h.

◆ sample()

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

Implements cyclus::IntDistribution.

Definition at line 267 of file random_number_generator.h.

◆ trials()

virtual int cyclus::BinomialIntDist::trials ( )
inlinevirtual

Definition at line 268 of file random_number_generator.h.


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