CHammingWordDistance Class Reference


Detailed Description

class HammingWordDistance

Definition at line 21 of file HammingWordDistance.h.

Inheritance diagram for CHammingWordDistance:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 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 ()
bool load_init (FILE *src)
bool save_init (FILE *dest)
virtual EDistanceType get_distance_type ()
virtual const char * get_name () const
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
bool use_sign

Constructor & Destructor Documentation

CHammingWordDistance::CHammingWordDistance ( bool  use_sign  ) 

constructor

Parameters:
use_sign if sign shall be used

Definition at line 18 of file HammingWordDistance.cpp.

CHammingWordDistance::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 27 of file HammingWordDistance.cpp.

CHammingWordDistance::~CHammingWordDistance (  )  [virtual]

Definition at line 39 of file HammingWordDistance.cpp.


Member Function Documentation

void CHammingWordDistance::cleanup (  )  [virtual]

cleanup distance

Implements CDistance.

Definition at line 52 of file HammingWordDistance.cpp.

float64_t CHammingWordDistance::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 66 of file HammingWordDistance.cpp.

void CHammingWordDistance::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 81 of file HammingWordDistance.h.

virtual EDistanceType CHammingWordDistance::get_distance_type (  )  [virtual]

get distance type we are

Returns:
distance type HAMMINGWORD

Implements CDistance.

Definition at line 68 of file HammingWordDistance.h.

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

get name of the distance

Returns:
name HammingWord

Implements CSGObject.

Definition at line 74 of file HammingWordDistance.h.

bool CHammingWordDistance::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 HammingWordDistance.cpp.

bool CHammingWordDistance::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 56 of file HammingWordDistance.cpp.

bool CHammingWordDistance::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 61 of file HammingWordDistance.cpp.


Member Data Documentation

size of the dictionary

Definition at line 95 of file HammingWordDistance.h.

dictionary weights

Definition at line 97 of file HammingWordDistance.h.

if sign shall be used

Definition at line 99 of file HammingWordDistance.h.


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

SHOGUN Machine Learning Toolbox - Documentation