CCanberraMetric Class Reference

Inheritance diagram for CCanberraMetric:

Inheritance graph
[legend]

List of all members.

Public Member Functions

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

The Canberra distance sums up the dissimilarity (ratios) between feature dimensions of two data points.

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

A summation element has range [0,1]. Note that $d(x,0)=d(0,x')=n$ and $d(0,0)=0$.

Definition at line 31 of file CanberraMetric.h.


Constructor & Destructor Documentation

CCanberraMetric::CCanberraMetric (  ) 

default constructor

Definition at line 18 of file CanberraMetric.cpp.

CCanberraMetric::CCanberraMetric ( CRealFeatures l,
CRealFeatures r 
)

constructor

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

Definition at line 23 of file CanberraMetric.cpp.

CCanberraMetric::~CCanberraMetric (  )  [virtual]

Definition at line 29 of file CanberraMetric.cpp.


Member Function Documentation

void CCanberraMetric::cleanup (  )  [virtual]

cleanup distance

Implements CDistance.

Definition at line 41 of file CanberraMetric.cpp.

float64_t CCanberraMetric::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 CanberraMetric.cpp.

virtual EDistanceType CCanberraMetric::get_distance_type (  )  [virtual]

get distance type we are

Returns:
distance type CANBERRA

Implements CDistance.

Definition at line 74 of file CanberraMetric.h.

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

get name of the distance

Returns:
name Canberra-Metric

Implements CDistance.

Definition at line 80 of file CanberraMetric.h.

bool CCanberraMetric::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 CanberraMetric.cpp.

bool CCanberraMetric::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 CanberraMetric.cpp.

bool CCanberraMetric::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 CanberraMetric.cpp.


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

SHOGUN Machine Learning Toolbox - Documentation