LTI-Lib latest version v1.9 - last update 10 Apr 2010

lti::bhattacharyyaDistance Class Reference

Computes the bhattacharyya distance of two distributions. More...

#include <ltiBhattacharyyaDistance.h>

Inheritance diagram for lti::bhattacharyyaDistance:
Inheritance graph
[legend]
Collaboration diagram for lti::bhattacharyyaDistance:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 bhattacharyyaDistance ()
 bhattacharyyaDistance (const bhattacharyyaDistance &other)
virtual ~bhattacharyyaDistance ()
virtual const char * getTypeName () const
double apply (const dmatrix &cluster1, const dmatrix &cluster2) const
bool apply (const dmatrix &cluster1, const dmatrix &cluster2, double &distance) const
double apply (const dvector &centroid1, const dmatrix &cov1, const dvector &centroid2, const dmatrix &cov2) const
bool apply (const dvector &centroid1, const dmatrix &cov1, const dvector &centroid2, const dmatrix &cov2, double &distance) const
bhattacharyyaDistancecopy (const bhattacharyyaDistance &other)
bhattacharyyaDistanceoperator= (const bhattacharyyaDistance &other)
virtual functorclone () const
const parametersgetParameters () const

Detailed Description

Computes the bhattacharyya distance of two distributions.

Either two matrices with the distributions, with each row representing a data point, or the means and the covarianz matrices of both distributions are given the the functor.


Constructor & Destructor Documentation

lti::bhattacharyyaDistance::bhattacharyyaDistance (  ) 

default constructor

lti::bhattacharyyaDistance::bhattacharyyaDistance ( const bhattacharyyaDistance other  ) 

copy constructor

Parameters:
other the object to be copied
virtual lti::bhattacharyyaDistance::~bhattacharyyaDistance (  )  [virtual]

destructor


Member Function Documentation

bool lti::bhattacharyyaDistance::apply ( const dvector centroid1,
const dmatrix cov1,
const dvector centroid2,
const dmatrix cov2,
double &  distance 
) const

compute the distance between the two distributions

Parameters:
centroid1 dvector with the first centroid
cov1 dmatrix with the covariance matrix of distribution 1
centroid2 dvector with the second centroid
cov2 dmatrix with the covariance matrix of distribution 2
distance the result will be left here
Returns:
true if apply successful or false otherwise.
double lti::bhattacharyyaDistance::apply ( const dvector centroid1,
const dmatrix cov1,
const dvector centroid2,
const dmatrix cov2 
) const

compute the distance between the two distributions

Parameters:
centroid1 dvector with the first centroid
cov1 dmatrix with the covariance matrix of distribution 1
centroid2 dvector with the second centroid
cov2 dmatrix with the covariance matrix of distribution 2
Returns:
the distance
bool lti::bhattacharyyaDistance::apply ( const dmatrix cluster1,
const dmatrix cluster2,
double &  distance 
) const

compute the distance between the two distributions

Parameters:
cluster1 dmatrix with the first distribution
cluster2 dmatrix with the second one
distance the result will be left here
Returns:
true if apply successful or false otherwise.
double lti::bhattacharyyaDistance::apply ( const dmatrix cluster1,
const dmatrix cluster2 
) const

compute the distance between the two distributions

Parameters:
cluster1 dmatrix with the first distribution
cluster2 dmatrix with the second one
Returns:
the distance
virtual functor* lti::bhattacharyyaDistance::clone (  )  const [virtual]

returns a pointer to a clone of this functor.

Implements lti::functor.

bhattacharyyaDistance& lti::bhattacharyyaDistance::copy ( const bhattacharyyaDistance other  ) 

copy data of "other" functor.

Parameters:
other the functor to be copied
Returns:
a reference to this functor object

Reimplemented from lti::functor.

const parameters& lti::bhattacharyyaDistance::getParameters (  )  const

returns used parameters

Reimplemented from lti::functor.

virtual const char* lti::bhattacharyyaDistance::getTypeName (  )  const [virtual]

returns the name of this type ("bhattacharyyaDistance")

Reimplemented from lti::linearAlgebraFunctor.

bhattacharyyaDistance& lti::bhattacharyyaDistance::operator= ( const bhattacharyyaDistance other  ) 

alias for copy member

Parameters:
other the functor to be copied
Returns:
a reference to this functor object

Reimplemented from lti::functor.


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

Generated on Sat Apr 10 15:28:10 2010 for LTI-Lib by Doxygen 1.6.1