CCanberraWordDistance Class Reference

Inheritance diagram for CCanberraWordDistance:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 CCanberraWordDistance ()
 CCanberraWordDistance (CStringFeatures< uint16_t > *l, CStringFeatures< uint16_t > *r)
virtual ~CCanberraWordDistance ()
virtual bool init (CFeatures *l, CFeatures *r)
virtual void cleanup ()
bool load_init (FILE *src)
bool save_init (FILE *dest)
virtual EDistanceType get_distance_type ()
virtual const char * get_name ()
void get_dictionary (int32_t &dsize, float64_t *&dweights)

Protected Member Functions

float64_t compute (int32_t idx_a, int32_t idx_b)

Protected Attributes

int32_t dictionary_size
float64_tdictionary_weights


Detailed Description

class CanberraWordDistance

Definition at line 21 of file CanberraWordDistance.h.


Constructor & Destructor Documentation

CCanberraWordDistance::CCanberraWordDistance (  ) 

default constructor

Definition at line 18 of file CanberraWordDistance.cpp.

CCanberraWordDistance::CCanberraWordDistance ( CStringFeatures< uint16_t > *  l,
CStringFeatures< uint16_t > *  r 
)

constructor

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

Definition at line 27 of file CanberraWordDistance.cpp.

CCanberraWordDistance::~CCanberraWordDistance (  )  [virtual]

Definition at line 39 of file CanberraWordDistance.cpp.


Member Function Documentation

void CCanberraWordDistance::cleanup (  )  [virtual]

cleanup distance

Implements CDistance.

Definition at line 51 of file CanberraWordDistance.cpp.

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

compute distance function 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 65 of file CanberraWordDistance.cpp.

void CCanberraWordDistance::get_dictionary ( int32_t &  dsize,
float64_t *&  dweights 
)

get dictionary weights

Parameters:
dsize size of the dictionary
dweights dictionary weights are stored in here

Definition at line 77 of file CanberraWordDistance.h.

virtual EDistanceType CCanberraWordDistance::get_distance_type (  )  [virtual]

get distance type we are

Returns:
distance type CHEBYSHEW

Implements CDistance.

Definition at line 64 of file CanberraWordDistance.h.

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

get name of the distance

Returns:
name Chebyshew-Metric

Implements CDistance.

Definition at line 70 of file CanberraWordDistance.h.

bool CCanberraWordDistance::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 CStringDistance< uint16_t >.

Definition at line 46 of file CanberraWordDistance.cpp.

bool CCanberraWordDistance::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 55 of file CanberraWordDistance.cpp.

bool CCanberraWordDistance::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 60 of file CanberraWordDistance.cpp.


Member Data Documentation

size of the dictionary

Definition at line 91 of file CanberraWordDistance.h.

dictionary weights

Definition at line 93 of file CanberraWordDistance.h.


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

SHOGUN Machine Learning Toolbox - Documentation