Public Member Functions | Protected Member Functions | Protected Attributes

CHammingWordDistance Class Reference


Detailed Description

class HammingWordDistance

Definition at line 25 of file HammingWordDistance.h.

Inheritance diagram for CHammingWordDistance:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CHammingWordDistance ()
 CHammingWordDistance (bool use_sign)
 CHammingWordDistance (CStringFeatures< uint16_t > *l, CStringFeatures< uint16_t > *r, bool use_sign)
virtual ~CHammingWordDistance ()
virtual bool init (CFeatures *l, CFeatures *r)
virtual void cleanup ()
virtual EDistanceType get_distance_type ()
virtual const char * get_name () const

Protected Member Functions

float64_t compute (int32_t idx_a, int32_t idx_b)

Protected Attributes

bool use_sign

Constructor & Destructor Documentation

default constructor

Definition at line 23 of file HammingWordDistance.cpp.

CHammingWordDistance ( bool  use_sign  ) 

constructor

Parameters:
use_sign if sign shall be used

Definition at line 28 of file HammingWordDistance.cpp.

CHammingWordDistance ( CStringFeatures< uint16_t > *  l,
CStringFeatures< uint16_t > *  r,
bool  use_sign 
)

constructor

Parameters:
l features of left-hand side
r features of right-hand side
use_sign if sign shall be used

Definition at line 37 of file HammingWordDistance.cpp.

~CHammingWordDistance (  )  [virtual]

Definition at line 49 of file HammingWordDistance.cpp.


Member Function Documentation

void cleanup (  )  [virtual]

cleanup distance

Implements CStringDistance< uint16_t >.

Definition at line 60 of file HammingWordDistance.cpp.

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

compute kernel 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 64 of file HammingWordDistance.cpp.

virtual EDistanceType get_distance_type (  )  [virtual]

get distance type we are

Returns:
distance type HAMMINGWORD

Implements CStringDistance< uint16_t >.

Definition at line 61 of file HammingWordDistance.h.

virtual const char* get_name ( void   )  const [virtual]

get name of the distance

Returns:
name HammingWord

Reimplemented from CStringDistance< uint16_t >.

Definition at line 67 of file HammingWordDistance.h.

bool 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 54 of file HammingWordDistance.cpp.


Member Data Documentation

bool use_sign [protected]

if sign shall be used

Definition at line 80 of file HammingWordDistance.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

SHOGUN Machine Learning Toolbox - Documentation