crn::MultivariateGaussianPDF Class Reference

Multivariate Gaussian distribution. More...

#include <CRNMultivariateGaussianPDF.h>

Inheritance diagram for crn::MultivariateGaussianPDF:

Collaboration diagram for crn::MultivariateGaussianPDF:

Public Member Functions
	MultivariateGaussianPDF (const MatrixDouble &mu, const SquareMatrixDouble &sigma)
	Constructor. More...
	MultivariateGaussianPDF (const MultivariateGaussianPDF &)=default
	MultivariateGaussianPDF (MultivariateGaussianPDF &&)=default
virtual	~MultivariateGaussianPDF () override
	Destructor. More...
MultivariateGaussianPDF &	operator= (const MultivariateGaussianPDF &)=default
MultivariateGaussianPDF &	operator= (MultivariateGaussianPDF &&)=default
size_t	GetDimension () const noexcept
	Returns the number of features. More...
void	SetDimension (size_t d) noexcept
	Sets the number of features. More...
const MatrixDouble &	GetMean () const
	Returns the mean of a given density function. More...
void	SetMean (const MatrixDouble &obj)
	Sets the mean of a given density function. More...
const SquareMatrixDouble &	GetVariance () const
	Returns the variance of a given density function. More...
void	SetVariance (const SquareMatrixDouble &obj)
	Sets the variance of a given density function. More...
double	ValueAt (const MatrixDouble &x) const
	Evaluates a pattern. More...
double	ValueAt (const std::vector< double > &x) const
	Evaluates a pattern. More...
bool	IsValid () const
	Check if PDF is valid (with finite values) More...
String	ToString () const
	Dumps a summary to a string. More...
Public Member Functions inherited from crn::Object
virtual	~Object ()=default

Detailed Description

Multivariate Gaussian distribution.

Model for multivariate Gaussian probability distribution function

Author

Jean DUONG

Date

August 2008

Version

0.1

Definition at line 41 of file CRNMultivariateGaussianPDF.h.

Constructor & Destructor Documentation

MultivariateGaussianPDF::MultivariateGaussianPDF	(	const MatrixDouble &	mu,
		const SquareMatrixDouble &	sigma
	)

Constructor.

Constructor

Parameters

[in]	mu	the mean pattern
[in]	sigma	the covariance matrix

Definition at line 40 of file CRNMultivariateGaussianPDF.cpp.

crn::MultivariateGaussianPDF::MultivariateGaussianPDF ( const MultivariateGaussianPDF &  )

default

crn::MultivariateGaussianPDF::MultivariateGaussianPDF ( MultivariateGaussianPDF &&  )

default

MultivariateGaussianPDF::~MultivariateGaussianPDF ( )

overridevirtual

Destructor.

Destructor

Definition at line 52 of file CRNMultivariateGaussianPDF.cpp.

Member Function Documentation

size_t crn::MultivariateGaussianPDF::GetDimension ( ) const

inlinenoexcept

Returns the number of features.

Definition at line 56 of file CRNMultivariateGaussianPDF.h.

const MatrixDouble& crn::MultivariateGaussianPDF::GetMean ( ) const

inline

Returns the mean of a given density function.

Definition at line 61 of file CRNMultivariateGaussianPDF.h.

const SquareMatrixDouble& crn::MultivariateGaussianPDF::GetVariance ( ) const

inline

Returns the variance of a given density function.

Definition at line 66 of file CRNMultivariateGaussianPDF.h.

bool MultivariateGaussianPDF::IsValid

(

)

const

Check if PDF is valid (with finite values)

Check if PDF is valid (with finite values)

Returns

true if success, false else

Definition at line 201 of file CRNMultivariateGaussianPDF.cpp.

MultivariateGaussianPDF& crn::MultivariateGaussianPDF::operator= ( const MultivariateGaussianPDF &  )

default

MultivariateGaussianPDF& crn::MultivariateGaussianPDF::operator= ( MultivariateGaussianPDF &&  )

default

void MultivariateGaussianPDF::SetDimension ( size_t  d )

noexcept

Sets the number of features.

Set the number of features

Parameters

[in]

d

the new dimension

Definition at line 61 of file CRNMultivariateGaussianPDF.cpp.

void MultivariateGaussianPDF::SetMean

(

const MatrixDouble &

obj

)

Sets the mean of a given density function.

Set the mean of a given density function

Parameters

[in]

obj

the new mean pattern

Definition at line 75 of file CRNMultivariateGaussianPDF.cpp.

void MultivariateGaussianPDF::SetVariance

(

const SquareMatrixDouble &

obj

)

Sets the variance of a given density function.

Set the variance of a given density function

Parameters

[in]

obj

the new covariance matrix

Definition at line 85 of file CRNMultivariateGaussianPDF.cpp.

String MultivariateGaussianPDF::ToString

(

)

const

Dumps a summary to a string.

Dumps a summary to a string

Returns

the string

Definition at line 184 of file CRNMultivariateGaussianPDF.cpp.

double MultivariateGaussianPDF::ValueAt

(

const MatrixDouble &

x

)

const

Evaluates a pattern.

Evaluate a pattern

Exceptions

ExceptionDimension

Parameters

[in]

x

the pattern to evaluate

Returns

the probability for the given pattern

Definition at line 101 of file CRNMultivariateGaussianPDF.cpp.

double MultivariateGaussianPDF::ValueAt

(

const std::vector< double > &

x

)

const

Evaluates a pattern.

Evaluate a pattern

Exceptions

ExceptionDimension

Parameters

[in]

x

the pattern to evaluate

Returns

the probability for the given pattern

Definition at line 140 of file CRNMultivariateGaussianPDF.cpp.

---

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

• /home/travis/build/Liris-Pleiad/libcrn/src/libcrn/CRNMath/CRNMultivariateGaussianPDF.h
• /home/travis/build/Liris-Pleiad/libcrn/src/libcrn/CRNMath/CRNMultivariateGaussianPDF.cpp