Public Member Functions | Protected Member Functions

CKernelDistance Class Reference


Detailed Description

The Kernel distance takes a distance as input.

It turns a kernel into something distance like by computing

\[ d({\bf x}, {\bf x'}) = e^{-\frac{k({\bf x}, {\bf x'})}{width}} \]

Definition at line 33 of file KernelDistance.h.

Inheritance diagram for CKernelDistance:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CKernelDistance (void)
 CKernelDistance (float64_t width, CKernel *k)
 CKernelDistance (CFeatures *l, CFeatures *r, float64_t width, CKernel *k)
virtual ~CKernelDistance ()
virtual bool init (CFeatures *l, CFeatures *r)
virtual EDistanceType get_distance_type ()
virtual EFeatureType get_feature_type ()
virtual EFeatureClass get_feature_class ()
virtual const char * get_name () const
virtual void cleanup ()

Protected Member Functions

float64_t compute (int32_t idx_a, int32_t idx_b)

Constructor & Destructor Documentation

CKernelDistance ( void   ) 

default constructor

Definition at line 20 of file KernelDistance.cpp.

CKernelDistance ( float64_t  width,
CKernel k 
)

constructor

Parameters:
width width
k kernel

Definition at line 25 of file KernelDistance.cpp.

CKernelDistance ( CFeatures l,
CFeatures r,
float64_t  width,
CKernel k 
)

constructor

Parameters:
l features of left-hand side
r features of right-hand side
width width
k kernel

Definition at line 36 of file KernelDistance.cpp.

~CKernelDistance (  )  [virtual]

destructor

Definition at line 50 of file KernelDistance.cpp.


Member Function Documentation

virtual void cleanup (  )  [virtual]

clean up kernel

Implements CDistance.

Definition at line 93 of file KernelDistance.h.

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

Parameters:
idx_a index a
idx_b index b
Returns:
computed kernel function at indices a,b

Implements CDistance.

Definition at line 65 of file KernelDistance.cpp.

virtual EDistanceType get_distance_type (  )  [virtual]

return what type of kernel we are

Returns:
distance type DISTANCE

Implements CDistance.

Definition at line 71 of file KernelDistance.h.

virtual EFeatureClass get_feature_class (  )  [virtual]

return feature class the distance can deal with

Returns:
feature class of distance used

Implements CDistance.

Definition at line 82 of file KernelDistance.h.

virtual EFeatureType get_feature_type (  )  [virtual]

return feature type the distance can deal with

Returns:
feature type of distance used

Implements CDistance.

Definition at line 76 of file KernelDistance.h.

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

return the distances's name

Returns:
name Distance

Implements CSGObject.

Definition at line 88 of file KernelDistance.h.

bool init ( CFeatures l,
CFeatures r 
) [virtual]

initialize kernel

Parameters:
l features of left-hand side
r features of right-hand side
Returns:
if initializing was successful

Reimplemented from CDistance.

Definition at line 58 of file KernelDistance.cpp.


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