stochastic::BetaDistribution Class Reference

#include <beta_dist.h>

Inheritance diagram for stochastic::BetaDistribution:

Collaboration diagram for stochastic::BetaDistribution:

Public Member Functions
	BetaDistribution ()=delete
	BetaDistribution (double alpha, double beta)
virtual	~BetaDistribution ()
std::string	name () const override
std::vector< double >	cumulative_dist_func (const std::vector< double > &locations) const override
std::vector< double >	inv_cumulative_dist_func (const std::vector< double > &probabilities) const override
Public Member Functions inherited from stochastic::Distribution
	Distribution ()=default
virtual	~Distribution ()
	Distribution (const Distribution &)=delete
Distribution &	operator= (const Distribution &)=delete

Protected Attributes
double	alpha_
double	beta_
boost::math::beta_distribution< double >	distribution_

Detailed Description

Beta distribution

Definition at line 13 of file beta_dist.h.

Constructor & Destructor Documentation

stochastic::BetaDistribution::BetaDistribution ( )

delete

Delete default constructor

stochastic::BetaDistribution::BetaDistribution	(	double	alpha,
		double	beta
	)

Construct beta distribution with specified mean and standard deviation

Parameters

[in]	alpha	Shape parameter
[in]	beta	Shape parameter

Definition at line 5 of file beta_dist.cc.

virtual stochastic::BetaDistribution::~BetaDistribution ( )

inlinevirtual

Virtual destructor

Definition at line 31 of file beta_dist.h.

Member Function Documentation

std::vector< double > stochastic::BetaDistribution::cumulative_dist_func ( const std::vector< double > &  locations ) const

overridevirtual

Compute the cumulative distribution function (CDF) of the distribution at specified input locations

Parameters

[in]

locations

Vector containing locations at which to calculate CDF

Returns

Vector of evaluated values of CDF at input locations

Implements stochastic::Distribution.

Definition at line 12 of file beta_dist.cc.

std::vector< double > stochastic::BetaDistribution::inv_cumulative_dist_func ( const std::vector< double > &  probabilities ) const

overridevirtual

Compute the inverse cumulative distribution function (ICDF) of the distribution at specified input locations

Parameters

[in]

probabilities

Vector containing probabilities at which to calculate ICDF

Returns

Vector of evaluated values of ICDF at input locations

Implements stochastic::Distribution.

Definition at line 23 of file beta_dist.cc.

std::string stochastic::BetaDistribution::name ( ) const

inlineoverridevirtual

Get the name of the distribution model

Returns

Model name as a string

Implements stochastic::Distribution.

Definition at line 37 of file beta_dist.h.

Member Data Documentation

double stochastic::BetaDistribution::alpha_

protected

Shape parameter

Definition at line 60 of file beta_dist.h.

double stochastic::BetaDistribution::beta_

protected

Shape parameter

Definition at line 61 of file beta_dist.h.

boost::math::beta_distribution<double> stochastic::BetaDistribution::distribution_

protected

Beta distribution

Definition at line 63 of file beta_dist.h.

---

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

• include/beta_dist.h
• src/beta_dist.cc