#include <NegativeBinomialDistribution.hpp>

Inheritance diagram for openstudio::analysis::NegativeBinomialDistribution:

Public Member Functions
Constructors and Destructors
	NegativeBinomialDistribution ()
	Returns a negative binomial distribution with 0.5 probability per trial and 20 trials. More...

	NegativeBinomialDistribution (double probabilityPerTrial, int numTrials)

virtual	~NegativeBinomialDistribution ()

Getters
double	probabilityPerTrial () const

int	numTrials () const

Setters
bool	setProbabilityPerTrial (double value)
	Value needs to be between 0 and 1. More...

bool	setNumTrials (int value)
	Value must be positive. More...

Public Member Functions inherited from openstudio::analysis::UncertaintyDescription
virtual	~UncertaintyDescription ()

UncertaintyDescription	clone () const

UncertaintyDescriptionType	type () const

void	restoreDefaults ()
	Restores the default options for this UncertaintyDescription and its type(). More...

template<typename T >
T	cast () const
	Casts the UncertaintyDescription to type T, if possible. More...

template<typename T >
boost::optional< T >	optionalCast () const

Static Public Member Functions
static UncertaintyDescriptionType	type ()

Static Public Member Functions inherited from openstudio::analysis::UncertaintyDescription
static std::vector < UncertaintyDescriptionType >	validTypes (const VariableValueType &variableValueType)
	Returns all the UncertaintyDescriptionTypes that are applicable to variableValueType (VariableValueType::Continuous or VariableValueType::Discrete). More...

static std::vector < UncertaintyDescriptionType >	validTypes (const VariableValueType &variableValueType, const UncertaintyType &uncertaintyType)
	Returns all the UncertaintyDescriptionTypes that are applicable to the specified combination of variableValueType (VariableValueType::Continuous or VariableValueType::Discrete) and uncertaintyType (UncertaintyType::Aleatory or UncertaintyType::Epistemic). More...

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

Protected Member Functions inherited from openstudio::analysis::UncertaintyDescription
	UncertaintyDescription (std::shared_ptr< detail::UncertaintyDescription_Impl > impl)

Additional Inherited Members
Protected Types inherited from openstudio::analysis::UncertaintyDescription
typedef detail::UncertaintyDescription_Impl	ImplType

Related Functions inherited from openstudio::analysis::UncertaintyDescription
typedef boost::optional < UncertaintyDescription >	OptionalUncertaintyDescription

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

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