SHOGUN  v1.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions | Protected Attributes
CBesselKernel Class Reference

Detailed Description

the class Bessel kernel

It is defined as

\[ k(x, y) = \frac{J_{v}( \| x-y \|/\tau)}{ \| x-y \| ^ {-nv} } \]

Where: $J_{v}$ is the Bessel funcion with order $v$, $\tau$ is the kernel width, and $n$ is the kernel degree.

Definition at line 32 of file BesselKernel.h.

Inheritance diagram for CBesselKernel:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CBesselKernel ()
 CBesselKernel (int32_t size, float64_t order, float64_t width, int32_t degree, CDistance *dist)
 CBesselKernel (CFeatures *l, CFeatures *r, float64_t order, float64_t width, int32_t degree, CDistance *dist, int32_t size=10)
virtual ~CBesselKernel ()
virtual bool init (CFeatures *l, CFeatures *r)
virtual void cleanup ()
virtual EKernelType get_kernel_type ()
virtual EFeatureType get_feature_type ()
virtual EFeatureClass get_feature_class ()
virtual const char * get_name () const
virtual void set_order (float64_t v)
virtual float64_t get_order () const
virtual void set_width (float64_t tau)
virtual float64_t get_width () const
virtual void set_degree (int32_t n)
virtual int32_t get_degree () const

Protected Member Functions

float64_t compute (int32_t idx_a, int32_t idx_b)

Protected Attributes

float64_t order
int32_t degree

Constructor & Destructor Documentation

default constructor

Definition at line 17 of file BesselKernel.cpp.

CBesselKernel ( int32_t  size,
float64_t  order,
float64_t  width,
int32_t  degree,
CDistance dist 
)

constructor

Parameters:
sizecache size
orderthe order of the bessel function
widththe kernel width
degreethe kernel degree
distdistance to be used

Definition at line 22 of file BesselKernel.cpp.

CBesselKernel ( CFeatures l,
CFeatures r,
float64_t  order,
float64_t  width,
int32_t  degree,
CDistance dist,
int32_t  size = 10 
)

constructor

Parameters:
lfeatures of left-hand side
rfeatures of right-hand side
orderof the bessel function
widththe kernel width
degreethe degree
distdistance to be used
sizecache size

Definition at line 31 of file BesselKernel.cpp.

~CBesselKernel ( ) [virtual]

clean up kernel

Definition at line 41 of file BesselKernel.cpp.


Member Function Documentation

void cleanup ( ) [virtual]

cleanup

Reimplemented from CKernel.

Definition at line 47 of file BesselKernel.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

Parameters:
idx_aindex a
idx_bindex b
Returns:
computed kernel function at indices a,b

Reimplemented from CDistanceKernel.

Definition at line 67 of file BesselKernel.cpp.

virtual int32_t get_degree ( ) const [virtual]

return the kernel's degree

Returns:
kernel degree

Definition at line 163 of file BesselKernel.h.

virtual EFeatureClass get_feature_class ( ) [virtual]
Returns:
class of features

Reimplemented from CDistanceKernel.

Definition at line 100 of file BesselKernel.h.

virtual EFeatureType get_feature_type ( ) [virtual]
Returns:
type of features

Reimplemented from CDistanceKernel.

Definition at line 92 of file BesselKernel.h.

virtual EKernelType get_kernel_type ( ) [virtual]

return what type of kernel we are

Returns:
kernel type Bessel

Reimplemented from CDistanceKernel.

Definition at line 84 of file BesselKernel.h.

virtual const char* get_name ( ) const [virtual]

return the kernel's name

Returns:
name Bessel

Reimplemented from CDistanceKernel.

Definition at line 109 of file BesselKernel.h.

virtual float64_t get_order ( ) const [virtual]

return the kernel's order

Returns:
kernel order

Definition at line 127 of file BesselKernel.h.

virtual float64_t get_width ( ) const [virtual]

return the kernel's width

Returns:
kernel width

Reimplemented from CDistanceKernel.

Definition at line 145 of file BesselKernel.h.

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

initialize kernel

Parameters:
lfeatures of left-hand side
rfeatures of right-hand side
Returns:
if initializing was successful

Reimplemented from CDistanceKernel.

Definition at line 51 of file BesselKernel.cpp.

virtual void set_degree ( int32_t  n) [virtual]

set the kernel's degree

Parameters:
nkernel degree

Definition at line 154 of file BesselKernel.h.

virtual void set_order ( float64_t  v) [virtual]

set the kernel's order

Parameters:
vkernel order

Definition at line 118 of file BesselKernel.h.

virtual void set_width ( float64_t  tau) [virtual]

set the kernel's width

Parameters:
taukernel width

Reimplemented from CDistanceKernel.

Definition at line 136 of file BesselKernel.h.


Member Data Documentation

int32_t degree [protected]

kernel degree

Definition at line 178 of file BesselKernel.h.

float64_t order [protected]

order of the Bessel function

Definition at line 176 of file BesselKernel.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