NegativeBinomialDistribution Class Reference

#include "NegativeBinomialDistribution.hpp"

Inheritance diagram for openstudio::analysis::NegativeBinomialDistribution:

Public Member Functions
	NegativeBinomialDistribution ()
	NegativeBinomialDistribution (double probabilityPerTrial, int numTrials)
virtual	~NegativeBinomialDistribution ()
double	probabilityPerTrial () const
int	numTrials () const
bool	setProbabilityPerTrial (double value)
bool	setNumTrials (int value)

Static Public Member Functions
static UncertaintyDescriptionType	type ()

Protected Member Functions
	NegativeBinomialDistribution (std::shared_ptr< detail::UncertaintyDescription_Impl > impl)

Detailed Description

NegativeBinomialDistribution is an UncertaintyDescription that can apply aleatory uncertainty to a discrete variable.

Constructor & Destructor Documentation

openstudio::analysis::NegativeBinomialDistribution::NegativeBinomialDistribution

(

)

Returns a negative binomial distribution with 0.5 probability per trial and 20 trials.

openstudio::analysis::NegativeBinomialDistribution::NegativeBinomialDistribution	(	double	probabilityPerTrial,
		int	numTrials
	)

virtual openstudio::analysis::NegativeBinomialDistribution::~NegativeBinomialDistribution ( )

inlinevirtual

openstudio::analysis::NegativeBinomialDistribution::NegativeBinomialDistribution ( std::shared_ptr< detail::UncertaintyDescription_Impl >  impl )

explicitprotected

Member Function Documentation

int openstudio::analysis::NegativeBinomialDistribution::numTrials

(

)

const

double openstudio::analysis::NegativeBinomialDistribution::probabilityPerTrial

(

)

const

bool openstudio::analysis::NegativeBinomialDistribution::setNumTrials

(

int

value

)

Value must be positive.

bool openstudio::analysis::NegativeBinomialDistribution::setProbabilityPerTrial

(

double

value

)

Value needs to be between 0 and 1.

static UncertaintyDescriptionType openstudio::analysis::NegativeBinomialDistribution::type ( )

static