stochastic::InverseGaussianDistribution Class Reference

#include <inv_gauss_dist.h>

Inheritance diagram for stochastic::InverseGaussianDistribution:

Collaboration diagram for stochastic::InverseGaussianDistribution:

Public Member Functions
	InverseGaussianDistribution ()=delete
	InverseGaussianDistribution (double mean, double scale)
virtual	~InverseGaussianDistribution ()
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::inverse_gaussian	distribution_

Detailed Description

Inverse Gaussian distribution

Definition at line 13 of file inv_gauss_dist.h.

Constructor & Destructor Documentation

stochastic::InverseGaussianDistribution::InverseGaussianDistribution ( )

delete

Delete default constructor

stochastic::InverseGaussianDistribution::InverseGaussianDistribution	(	double	mean,
		double	scale
	)

Construct inverse Gaussian distribution with specified mean and standard deviation

Parameters

[in]	mean	Mean of distribution
[in]	scale	Scale parameter of distribution

Definition at line 5 of file inv_gauss_dist.cc.

virtual stochastic::InverseGaussianDistribution::~InverseGaussianDistribution ( )

inlinevirtual

Virtual destructor

Definition at line 31 of file inv_gauss_dist.h.

Member Function Documentation

std::vector< double > stochastic::InverseGaussianDistribution::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 14 of file inv_gauss_dist.cc.

std::vector< double > stochastic::InverseGaussianDistribution::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 26 of file inv_gauss_dist.cc.

std::string stochastic::InverseGaussianDistribution::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 inv_gauss_dist.h.

Member Data Documentation

boost::math::inverse_gaussian stochastic::InverseGaussianDistribution::distribution_

protected

Inverse Gaussian distribution

Definition at line 62 of file inv_gauss_dist.h.

double stochastic::InverseGaussianDistribution::mean_

protected

Distribution mean

Definition at line 60 of file inv_gauss_dist.h.

double stochastic::InverseGaussianDistribution::std_dev_

protected

Distribution standard deviation

Definition at line 61 of file inv_gauss_dist.h.

---

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

• include/inv_gauss_dist.h
• src/inv_gauss_dist.cc