CJensenMetric Class Reference

Inheritance diagram for CJensenMetric:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 CJensenMetric ()
 CJensenMetric (CRealFeatures *l, CRealFeatures *r)
virtual ~CJensenMetric ()
virtual bool init (CFeatures *l, CFeatures *r)
virtual void cleanup ()
virtual bool load_init (FILE *src)
virtual bool save_init (FILE *dest)
virtual EDistanceType get_distance_type ()
virtual const char * get_name ()

Protected Member Functions

virtual float64_t compute (int32_t idx_a, int32_t idx_b)


Detailed Description

class JensenMetric

The Jensen-Shannon distance/divergence measures the similarity between two data points which is based on the Kullback-Leibler divergence.

\[\displaystyle d(\bf{x},\bf{x'}) = \sum_{i=0}^{n} x_{i} log\frac{x_{i}}{0.5(x_{i} +x'_{i})} + x'_{i} log\frac{x'_{i}}{0.5(x_{i}+x'_{i})} \]

See also:
Wikipedia: Jensen-Shannon divergence

Wikipedia: Kullback-Leibler divergence

Definition at line 33 of file JensenMetric.h.


Constructor & Destructor Documentation

CJensenMetric::CJensenMetric (  ) 

default constructor

Definition at line 18 of file JensenMetric.cpp.

CJensenMetric::CJensenMetric ( CRealFeatures l,
CRealFeatures r 
)

constructor

Parameters:
l features of left-hand side
r features of right-hand side

Definition at line 23 of file JensenMetric.cpp.

CJensenMetric::~CJensenMetric (  )  [virtual]

Definition at line 29 of file JensenMetric.cpp.


Member Function Documentation

void CJensenMetric::cleanup (  )  [virtual]

cleanup distance

Implements CDistance.

Definition at line 41 of file JensenMetric.cpp.

float64_t CJensenMetric::compute ( int32_t  idx_a,
int32_t  idx_b 
) [protected, virtual]

compute distance for features a and b idx_{a,b} denote the index of the feature vectors in the corresponding feature object

Implements CDistance.

Definition at line 55 of file JensenMetric.cpp.

virtual EDistanceType CJensenMetric::get_distance_type (  )  [virtual]

get distance type we are

Returns:
distance type JENSEN

Implements CDistance.

Definition at line 76 of file JensenMetric.h.

virtual const char* CJensenMetric::get_name (  )  [virtual]

get name of the distance

Returns:
name Jensen-Metric

Implements CDistance.

Definition at line 82 of file JensenMetric.h.

bool CJensenMetric::init ( CFeatures l,
CFeatures r 
) [virtual]

init distance

Parameters:
l features of left-hand side
r features of right-hand side
Returns:
if init was successful

Reimplemented from CSimpleDistance< float64_t >.

Definition at line 34 of file JensenMetric.cpp.

bool CJensenMetric::load_init ( FILE *  src  )  [virtual]

load init data from file

Parameters:
src file to load from
Returns:
if loading was successful

Implements CDistance.

Definition at line 45 of file JensenMetric.cpp.

bool CJensenMetric::save_init ( FILE *  dest  )  [virtual]

save init data to file

Parameters:
dest file to save to
Returns:
if saving was successful

Implements CDistance.

Definition at line 50 of file JensenMetric.cpp.


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

SHOGUN Machine Learning Toolbox - Documentation