CDistanceKernel Class Reference

Inheritance diagram for CDistanceKernel:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 CDistanceKernel (int32_t cache, float64_t width, CDistance *dist)
 CDistanceKernel (CFeatures *l, CFeatures *r, float64_t width, CDistance *dist)
virtual ~CDistanceKernel ()
virtual bool init (CFeatures *l, CFeatures *r)
virtual EKernelType get_kernel_type ()
virtual EFeatureType get_feature_type ()
virtual EFeatureClass get_feature_class ()
virtual const char * get_name ()
bool load_init (FILE *src)
bool save_init (FILE *dest)

Protected Member Functions

float64_t compute (int32_t idx_a, int32_t idx_b)


Detailed Description

The Distance kernel takes a distance as input and computes

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

Definition at line 27 of file DistanceKernel.h.


Constructor & Destructor Documentation

CDistanceKernel::CDistanceKernel ( int32_t  cache,
float64_t  width,
CDistance dist 
)

constructor

Parameters:
cache cache size
width width
dist distance

Definition at line 18 of file DistanceKernel.cpp.

CDistanceKernel::CDistanceKernel ( CFeatures l,
CFeatures r,
float64_t  width,
CDistance dist 
)

constructor

Parameters:
l features of left-hand side
r features of right-hand side
width width
dist distance

Definition at line 25 of file DistanceKernel.cpp.

CDistanceKernel::~CDistanceKernel (  )  [virtual]

Definition at line 34 of file DistanceKernel.cpp.


Member Function Documentation

float64_t CDistanceKernel::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 CKernel.

Definition at line 50 of file DistanceKernel.cpp.

virtual EFeatureClass CDistanceKernel::get_feature_class (  )  [virtual]

return feature class the kernel can deal with

Returns:
feature class of distance used

Implements CKernel.

Definition at line 73 of file DistanceKernel.h.

virtual EFeatureType CDistanceKernel::get_feature_type (  )  [virtual]

return feature type the kernel can deal with

Returns:
feature type of distance used

Implements CKernel.

Definition at line 67 of file DistanceKernel.h.

virtual EKernelType CDistanceKernel::get_kernel_type (  )  [virtual]

return what type of kernel we are

Returns:
kernel type DISTANCE

Implements CKernel.

Definition at line 62 of file DistanceKernel.h.

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

return the kernel's name

Returns:
name Distance

Implements CKernel.

Definition at line 79 of file DistanceKernel.h.

bool CDistanceKernel::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 CKernel.

Definition at line 42 of file DistanceKernel.cpp.

bool CDistanceKernel::load_init ( FILE *  src  )  [virtual]

load kernel init_data

Parameters:
src file to load from
Returns:
if loading was successful

Implements CKernel.

Definition at line 56 of file DistanceKernel.cpp.

bool CDistanceKernel::save_init ( FILE *  dest  )  [virtual]

save kernel init_data

Parameters:
dest file to save to
Returns:
if saving was successful

Implements CKernel.

Definition at line 61 of file DistanceKernel.cpp.


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

SHOGUN Machine Learning Toolbox - Documentation