#include <HistogramBinDistribution.hpp>

Inheritance diagram for openstudio::analysis::HistogramBinDistribution:

Public Member Functions
Constructors and Destructors
	HistogramBinDistribution ()
	Returns a histogram bin distribution with abscissas of [0,1] and counts of [1,0]. More...

	HistogramBinDistribution (std::vector< double > abscissas, std::vector< double > counts)
	This distribution requires either counts or ordinates; the defaut here is counts. More...

virtual	~HistogramBinDistribution ()

Getters
std::vector< double >	abscissas () const

std::vector< double >	counts () const

std::vector< double >	ordinates () const

boost::optional< int >	numPairs () const

Setters
bool	setAbscissas (const std::vector< double > &value)
	Abscissas values must be strictly increasing. More...

bool	setCounts (const std::vector< double > &value)
	The last value of counts must be 0; all other values must be positive. More...

void	resetCounts ()

bool	setOrdinates (const std::vector< double > &value)
	The last value of ordinates must be 0; all other values must be positive. More...

void	resetOrdinates ()

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
	HistogramBinDistribution (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

HistogramBinDistribution is an UncertaintyDescription that can apply aleatory uncertainty to a continuous variable.

Constructor & Destructor Documentation

openstudio::analysis::HistogramBinDistribution::HistogramBinDistribution ( )

Returns a histogram bin distribution with abscissas of [0,1] and counts of [1,0].

openstudio::analysis::HistogramBinDistribution::HistogramBinDistribution	(	std::vector< double >	abscissas,
		std::vector< double >	counts
	)

This distribution requires either counts or ordinates; the defaut here is counts.

virtual openstudio::analysis::HistogramBinDistribution::~HistogramBinDistribution ( )

inlinevirtual

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

explicitprotected

std::vector<double> openstudio::analysis::HistogramBinDistribution::abscissas ( ) const

std::vector<double> openstudio::analysis::HistogramBinDistribution::counts ( ) const

boost::optional<int> openstudio::analysis::HistogramBinDistribution::numPairs ( ) const

std::vector<double> openstudio::analysis::HistogramBinDistribution::ordinates ( ) const

void openstudio::analysis::HistogramBinDistribution::resetCounts ( )

void openstudio::analysis::HistogramBinDistribution::resetOrdinates ( )

bool openstudio::analysis::HistogramBinDistribution::setAbscissas ( const std::vector< double > & value )

Abscissas values must be strictly increasing.

bool openstudio::analysis::HistogramBinDistribution::setCounts ( const std::vector< double > & value )

The last value of counts must be 0; all other values must be positive.

bool openstudio::analysis::HistogramBinDistribution::setOrdinates ( const std::vector< double > & value )

The last value of ordinates must be 0; all other values must be positive.

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

static