Stochastic Loading Module
Public Member Functions | Protected Attributes | List of all members
stochastic::NormalDistribution Class Reference

#include <normal_dist.h>

Inheritance diagram for stochastic::NormalDistribution:
Inheritance graph
[legend]
Collaboration diagram for stochastic::NormalDistribution:
Collaboration graph
[legend]

Public Member Functions

 NormalDistribution ()=delete
 
 NormalDistribution (double mean, double std_dev)
 
virtual ~NormalDistribution ()
 
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
 
Distributionoperator= (const Distribution &)=delete
 

Protected Attributes

double mean_
 
double std_dev_
 
boost::math::normal distribution_
 

Detailed Description

Normal distribution

Definition at line 13 of file normal_dist.h.

Constructor & Destructor Documentation

stochastic::NormalDistribution::NormalDistribution ( )
delete

Construct standard normal distribution

stochastic::NormalDistribution::NormalDistribution ( double  mean,
double  std_dev 
)

Construct normal distribution with specified mean and standard deviation

Parameters
[in]meanMean of distribution
[in]std_devStandard deviation of distribution

Definition at line 5 of file normal_dist.cc.

virtual stochastic::NormalDistribution::~NormalDistribution ( )
inlinevirtual

Virtual destructor

Definition at line 31 of file normal_dist.h.

Member Function Documentation

std::vector< double > stochastic::NormalDistribution::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]locationsVector 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 normal_dist.cc.

std::vector< double > stochastic::NormalDistribution::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]probabilitiesVector 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 normal_dist.cc.

std::string stochastic::NormalDistribution::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 normal_dist.h.

Member Data Documentation

boost::math::normal stochastic::NormalDistribution::distribution_
protected

Normal distribution

Definition at line 62 of file normal_dist.h.

double stochastic::NormalDistribution::mean_
protected

Distribution mean

Definition at line 60 of file normal_dist.h.

double stochastic::NormalDistribution::std_dev_
protected

Distribution standard deviation

Definition at line 61 of file normal_dist.h.


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