Stochastic Loading Module
Public Member Functions | List of all members
stochastic::Distribution Class Referenceabstract

#include <distribution.h>

Inheritance diagram for stochastic::Distribution:
Inheritance graph
[legend]

Public Member Functions

 Distribution ()=default
 
virtual ~Distribution ()
 
 Distribution (const Distribution &)=delete
 
Distributionoperator= (const Distribution &)=delete
 
virtual std::string name () const =0
 
virtual std::vector< double > cumulative_dist_func (const std::vector< double > &locations) const =0
 
virtual std::vector< double > inv_cumulative_dist_func (const std::vector< double > &probabilities) const =0
 

Detailed Description

Abstract base class for distribution models

Definition at line 12 of file distribution.h.

Constructor & Destructor Documentation

stochastic::Distribution::Distribution ( )
default

Default constructor

virtual stochastic::Distribution::~Distribution ( )
inlinevirtual

Virtual destructor

Definition at line 22 of file distribution.h.

stochastic::Distribution::Distribution ( const Distribution )
delete

Delete copy constructor

Member Function Documentation

virtual std::vector<double> stochastic::Distribution::cumulative_dist_func ( const std::vector< double > &  locations) const
pure virtual

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

Implemented in stochastic::StudentstDistribution, stochastic::BetaDistribution, stochastic::InverseGaussianDistribution, stochastic::LognormalDistribution, and stochastic::NormalDistribution.

virtual std::vector<double> stochastic::Distribution::inv_cumulative_dist_func ( const std::vector< double > &  probabilities) const
pure virtual

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

Implemented in stochastic::StudentstDistribution, stochastic::BetaDistribution, stochastic::InverseGaussianDistribution, stochastic::LognormalDistribution, and stochastic::NormalDistribution.

virtual std::string stochastic::Distribution::name ( ) const
pure virtual
Distribution& stochastic::Distribution::operator= ( const Distribution )
delete

Delete assignment operator


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