libcrn  3.9.5
A document image processing library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
crn::UnivariateGaussianPDF Class Reference

Univariate Gaussian distribution. More...

#include <CRNUnivariateGaussianPDF.h>

+ Inheritance diagram for crn::UnivariateGaussianPDF:
+ Collaboration diagram for crn::UnivariateGaussianPDF:

Public Member Functions

 UnivariateGaussianPDF (double m, double v)
 Constructor. More...
 
 UnivariateGaussianPDF (const UnivariateGaussianPDF &)=default
 
 UnivariateGaussianPDF (UnivariateGaussianPDF &&)=default
 
virtual ~UnivariateGaussianPDF () override
 Destructor. More...
 
UnivariateGaussianPDFoperator= (const UnivariateGaussianPDF &)=default
 No assignment allowed. More...
 
UnivariateGaussianPDFoperator= (UnivariateGaussianPDF &&)=default
 
double GetMean () const noexcept
 Returns the mean of a given density function. More...
 
void SetMean (const double mu) noexcept
 Sets the mean of a given density function. More...
 
double GetVariance () const noexcept
 Returns the variance of a given density function. More...
 
void SetVariance (const double v)
 Sets the variance of a given density function. More...
 
double GetDeviation () const
 Returns the standard deviation of a given density function. More...
 
double ValueAt (const double x) const
 Evaluates a pattern. More...
 
String ToString () const
 Dumps a summary to a string. More...
 
double IntersectionAbscissa (const UnivariateGaussianPDF &pdf) const
 Estimates intersection point between with another PDF, using trinom solving. More...
 
double IntersectionAbscissaApprox (const UnivariateGaussianPDF &pdf) const
 Estimates intersection point between with another PDF, using dichotomy. More...
 
std::vector< double > MakeRandomSample (size_t n=1, size_t m=100, bool reseed=true) const
 Creates a data sample following the PDF's probability law. More...
 
void Deserialize (xml::Element &el)
 
xml::Element Serialize (xml::Element &parent) const
 
- Public Member Functions inherited from crn::Object
virtual ~Object ()=default
 

Detailed Description

Univariate Gaussian distribution.

Model for univariate Gaussian probability distribution function

Author
Jean DUONG
Date
October 2008
Version
0.2

Definition at line 40 of file CRNUnivariateGaussianPDF.h.

Constructor & Destructor Documentation

UnivariateGaussianPDF::UnivariateGaussianPDF ( double  m,
double  v 
)

Constructor.

Constructor

Parameters
[in]mumean
[in]vvariance

Definition at line 40 of file CRNUnivariateGaussianPDF.cpp.

crn::UnivariateGaussianPDF::UnivariateGaussianPDF ( const UnivariateGaussianPDF )
default
crn::UnivariateGaussianPDF::UnivariateGaussianPDF ( UnivariateGaussianPDF &&  )
default
UnivariateGaussianPDF::~UnivariateGaussianPDF ( )
overridevirtual

Destructor.

Destructor

Definition at line 50 of file CRNUnivariateGaussianPDF.cpp.

Member Function Documentation

void UnivariateGaussianPDF::Deserialize ( xml::Element el)
Exceptions
ExceptionInvalidArgumentnot a UnivariateGaussianPDF
ExceptionNotFoundattribute not found
ExceptionDomainwrong attribute
Parameters
[in]elthe element to read

Definition at line 253 of file CRNUnivariateGaussianPDF.cpp.

double crn::UnivariateGaussianPDF::GetDeviation ( ) const
inline

Returns the standard deviation of a given density function.

Definition at line 66 of file CRNUnivariateGaussianPDF.h.

double crn::UnivariateGaussianPDF::GetMean ( ) const
inlinenoexcept

Returns the mean of a given density function.

Definition at line 56 of file CRNUnivariateGaussianPDF.h.

double crn::UnivariateGaussianPDF::GetVariance ( ) const
inlinenoexcept

Returns the variance of a given density function.

Definition at line 61 of file CRNUnivariateGaussianPDF.h.

double UnivariateGaussianPDF::IntersectionAbscissa ( const UnivariateGaussianPDF pdf) const

Estimates intersection point between with another PDF, using trinom solving.

Estimates intersection point between with another PDF, using trinom solving

Parameters
[in]pdfthe other PDF
Returns
the intersection abscissa

Definition at line 110 of file CRNUnivariateGaussianPDF.cpp.

double UnivariateGaussianPDF::IntersectionAbscissaApprox ( const UnivariateGaussianPDF pdf) const

Estimates intersection point between with another PDF, using dichotomy.

Estimates intersection point between with another PDF, using dichotomy

Parameters
[in]pdfthe other PDF
Returns
the intersection abscissa

Definition at line 153 of file CRNUnivariateGaussianPDF.cpp.

std::vector< double > UnivariateGaussianPDF::MakeRandomSample ( size_t  n = 1,
size_t  m = 100,
bool  reseed = true 
) const

Creates a data sample following the PDF's probability law.

Simulate a random sample following the PDF's low

Parameters
[in]nsize of sample
[in]mtemporary sample size
[in]reseedshall the random seed be reinitialized?
Returns
a set of patterns generated by the mixture's low

Definition at line 198 of file CRNUnivariateGaussianPDF.cpp.

UnivariateGaussianPDF& crn::UnivariateGaussianPDF::operator= ( const UnivariateGaussianPDF )
default

No assignment allowed.

UnivariateGaussianPDF& crn::UnivariateGaussianPDF::operator= ( UnivariateGaussianPDF &&  )
default
xml::Element UnivariateGaussianPDF::Serialize ( xml::Element parent) const

Definition at line 266 of file CRNUnivariateGaussianPDF.cpp.

void UnivariateGaussianPDF::SetMean ( const double  mu)
noexcept

Sets the mean of a given density function.

Sets the mean of a given density function

Parameters
[in]muthe new mean

Definition at line 57 of file CRNUnivariateGaussianPDF.cpp.

void UnivariateGaussianPDF::SetVariance ( const double  v)

Sets the variance of a given density function.

Sets the variance of a given density function

Exceptions
ExceptionDimensionnegative variance
Parameters
[in]vthe new variance

Definition at line 69 of file CRNUnivariateGaussianPDF.cpp.

String UnivariateGaussianPDF::ToString ( ) const

Dumps a summary to a string.

Dumps a summary to a string

Returns
the string

Definition at line 236 of file CRNUnivariateGaussianPDF.cpp.

double UnivariateGaussianPDF::ValueAt ( const double  x) const

Evaluates a pattern.

Evaluates a pattern

Parameters
[in]xthe pattern to evaluate
Returns
the probability

Definition at line 88 of file CRNUnivariateGaussianPDF.cpp.


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