Public Member Functions | Protected Attributes | List of all members
o2scl::prob_dens_lognormal Class Reference

Lognormal density function. More...

#include <prob_dens_func.h>

Inheritance diagram for o2scl::prob_dens_lognormal:
o2scl::prob_dens_positive o2scl::prob_dens_func

Public Member Functions

 prob_dens_lognormal ()
 Create a blank lognormal distribution.
 
 prob_dens_lognormal (double mu, double sigma)
 Create lognormal distribution with mean parameter mu and width parameter sigma. More...
 
 prob_dens_lognormal (const prob_dens_lognormal &pdg)
 Copy constructor.
 
prob_dens_lognormaloperator= (const prob_dens_lognormal &pdg)
 Copy constructor with operator=.
 
void set_mu_sigma (double mu, double sigma)
 Set the maximum and width of the lognormal distribution.
 
void set_seed (unsigned long int s)
 Set the seed.
 
virtual double operator() () const
 Sample from the specified density.
 
virtual double pdf (double x) const
 The normalized density.
 
virtual double log_pdf (double x) const
 The log of the normalized density.
 
virtual double cdf (double x) const
 The cumulative distribution function (from the lower tail)
 
virtual double invert_cdf (double in_cdf) const
 The inverse cumulative distribution function.
 
virtual double entropy () const
 The inverse cumulative distribution function.
 

Protected Attributes

double sigma_
 Width parameter. More...
 
double mu_
 Central value. More...
 
rng_gsl r
 The GSL random number generator.
 

Detailed Description

The distribution

\[ P(x)=\frac{1}{x \sigma \sqrt{2 \pi}} \exp \left[-\frac{\left(\ln x-\mu\right)^2}{2\sigma^2}\right] \]

This class is experimental.

Definition at line 463 of file prob_dens_func.h.

Constructor & Destructor Documentation

◆ prob_dens_lognormal()

o2scl::prob_dens_lognormal::prob_dens_lognormal ( double  mu,
double  sigma 
)
inline

The value of sigma must be larger than zero.

Definition at line 496 of file prob_dens_func.h.

Member Data Documentation

◆ mu_

double o2scl::prob_dens_lognormal::mu_
protected

A value of -1 indicates it is yet unspecified.

Definition at line 477 of file prob_dens_func.h.

◆ sigma_

double o2scl::prob_dens_lognormal::sigma_
protected

A value of -1 indicates it is yet unspecified.

Definition at line 471 of file prob_dens_func.h.


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

Documentation generated with Doxygen. Provided under the GNU Free Documentation License (see License Information).