CBrayCurtisDistance Class Reference

Inheritance diagram for CBrayCurtisDistance:

Inheritance graph
[legend]

List of all members.

Public Member Functions

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

The Bray-Curtis distance (Sorensen distance) is similar to the Manhattan distance with normalization.

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

Definition at line 29 of file BrayCurtisDistance.h.


Constructor & Destructor Documentation

CBrayCurtisDistance::CBrayCurtisDistance (  ) 

default constructor

Definition at line 18 of file BrayCurtisDistance.cpp.

CBrayCurtisDistance::CBrayCurtisDistance ( CRealFeatures l,
CRealFeatures r 
)

constructor

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

Definition at line 23 of file BrayCurtisDistance.cpp.

CBrayCurtisDistance::~CBrayCurtisDistance (  )  [virtual]

Definition at line 29 of file BrayCurtisDistance.cpp.


Member Function Documentation

void CBrayCurtisDistance::cleanup (  )  [virtual]

cleanup distance

Implements CDistance.

Definition at line 41 of file BrayCurtisDistance.cpp.

float64_t CBrayCurtisDistance::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 BrayCurtisDistance.cpp.

virtual EDistanceType CBrayCurtisDistance::get_distance_type (  )  [virtual]

get distance type we are

Returns:
distance type BRAYCURTIS

Implements CDistance.

Definition at line 72 of file BrayCurtisDistance.h.

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

get name of the distance

Returns:
name Bray-Curtis distance

Implements CDistance.

Definition at line 78 of file BrayCurtisDistance.h.

bool CBrayCurtisDistance::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 BrayCurtisDistance.cpp.

bool CBrayCurtisDistance::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 BrayCurtisDistance.cpp.

bool CBrayCurtisDistance::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 BrayCurtisDistance.cpp.


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

SHOGUN Machine Learning Toolbox - Documentation