CChiSquareDistance Class Reference

Inheritance diagram for CChiSquareDistance:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 CChiSquareDistance ()
 CChiSquareDistance (CRealFeatures *l, CRealFeatures *r)
virtual ~CChiSquareDistance ()
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 ChiSquareDistance

This implementation of $\chi^{2}$ distance extends the concept of $\chi^{2}$ metric to negative values.

\[\displaystyle d(\bf{x},\bf{x'}) = \sum_{i=1}^{n}\frac{(x_{i}-x'_{i})^2} {|x_{i}|+|x'_{i}|} \quad \bf{x},\bf{x'} \in R^{n} \]

See also:
K. Rieck, P. Laskov. Linear-Time Computation of Similarity Measures for Sequential Data. Journal of Machine Learning Research, 9:23--48,2008.

Definition at line 31 of file ChiSquareDistance.h.


Constructor & Destructor Documentation

CChiSquareDistance::CChiSquareDistance (  ) 

default constructor

Definition at line 18 of file ChiSquareDistance.cpp.

CChiSquareDistance::CChiSquareDistance ( CRealFeatures l,
CRealFeatures r 
)

constructor

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

Definition at line 23 of file ChiSquareDistance.cpp.

CChiSquareDistance::~CChiSquareDistance (  )  [virtual]

Definition at line 29 of file ChiSquareDistance.cpp.


Member Function Documentation

void CChiSquareDistance::cleanup (  )  [virtual]

cleanup distance

Implements CDistance.

Definition at line 41 of file ChiSquareDistance.cpp.

float64_t CChiSquareDistance::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 ChiSquareDistance.cpp.

virtual EDistanceType CChiSquareDistance::get_distance_type (  )  [virtual]

get distance type we are

Returns:
distance type CHISQUARE

Implements CDistance.

Definition at line 74 of file ChiSquareDistance.h.

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

get name of the distance

Returns:
name Chi-square distance

Implements CDistance.

Definition at line 80 of file ChiSquareDistance.h.

bool CChiSquareDistance::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 ChiSquareDistance.cpp.

bool CChiSquareDistance::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 ChiSquareDistance.cpp.

bool CChiSquareDistance::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 ChiSquareDistance.cpp.


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

SHOGUN Machine Learning Toolbox - Documentation