stochastic::LognormalDistribution Class Reference

#include <lognormal_dist.h>

Inheritance diagram for stochastic::LognormalDistribution:

Collaboration diagram for stochastic::LognormalDistribution:

Public Member Functions
	LognormalDistribution ()=delete
	LognormalDistribution (double mean, double std_dev)
virtual	~LognormalDistribution ()
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	mean_
double	std_dev_
boost::math::lognormal	distribution_

Detailed Description

Lognormal distribution

Definition at line 13 of file lognormal_dist.h.

Constructor & Destructor Documentation

stochastic::LognormalDistribution::LognormalDistribution ( )

delete

Delete default constructor

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

Construct lognormal distribution with specified mean and standard deviation

Parameters

[in]	mean	Mean of distribution
[in]	std_dev	Standard deviation of distribution

Definition at line 5 of file lognormal_dist.cc.

virtual stochastic::LognormalDistribution::~LognormalDistribution ( )

inlinevirtual

Virtual destructor

Definition at line 31 of file lognormal_dist.h.

Member Function Documentation

std::vector< double > stochastic::LognormalDistribution::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 lognormal_dist.cc.

std::vector< double > stochastic::LognormalDistribution::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 lognormal_dist.cc.

std::string stochastic::LognormalDistribution::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 lognormal_dist.h.

Member Data Documentation

boost::math::lognormal stochastic::LognormalDistribution::distribution_

protected

Lognormal distribution

Definition at line 62 of file lognormal_dist.h.

double stochastic::LognormalDistribution::mean_

protected

Distribution mean

Definition at line 60 of file lognormal_dist.h.

double stochastic::LognormalDistribution::std_dev_

protected

Distribution standard deviation

Definition at line 61 of file lognormal_dist.h.

---

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

• include/lognormal_dist.h
• src/lognormal_dist.cc