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

A one-dimensional Gaussian probability density. More...

#include <prob_dens_func.h>

Inheritance diagram for o2scl::prob_dens_gaussian:
o2scl::prob_dens_func

Public Member Functions

 prob_dens_gaussian ()
 Create a standard normal distribution.
 
 prob_dens_gaussian (double cent, double sigma)
 Create a Gaussian distribution with width sigma. More...
 
 prob_dens_gaussian (const prob_dens_gaussian &pdg)
 Copy constructor.
 
prob_dens_gaussianoperator= (const prob_dens_gaussian &pdg)
 Copy constructor with operator=.
 
void set_seed (unsigned long int s)
 Set the seed.
 
void set_center (double cent)
 Set the center.
 
void set_sigma (double sigma)
 Set the Gaussian width (must be positive)
 
double mean ()
 Get the center.
 
double stddev ()
 Get the Gaussian width.
 
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 cent_
 Central value.
 
double sigma_
 Width parameter. More...
 
o2scl::rng_gsl r
 Base GSL random number generator.
 

Detailed Description

The distribution

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

This class is experimental.

Definition at line 105 of file prob_dens_func.h.

Constructor & Destructor Documentation

◆ prob_dens_gaussian()

o2scl::prob_dens_gaussian::prob_dens_gaussian ( double  cent,
double  sigma 
)
inline

The value of sigma must be larger than zero.

Definition at line 135 of file prob_dens_func.h.

Member Data Documentation

◆ sigma_

double o2scl::prob_dens_gaussian::sigma_
protected

A value of -1 indicates it is yet unspecified.

Definition at line 117 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).