Public Member Functions | Protected Member Functions | Protected Attributes

CSphericalKernel Class Reference


Detailed Description

Spherical kernel.

Formally described as

\[ k(x, y) = 1 - \frac{3}{2} \frac{|x-y|}{\sigma} + \frac{1}{2} \left( \frac{|x-y|}{\sigma} \right)^3 \mbox{if}~ |x-y| \leq \sigma \mbox{, zero otherwise} \]

Definition at line 38 of file SphericalKernel.h.

Inheritance diagram for CSphericalKernel:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CSphericalKernel ()
 CSphericalKernel (int32_t size, float64_t sigma, CDistance *dist)
 CSphericalKernel (CFeatures *l, CFeatures *r, float64_t sigma, CDistance *dist)
virtual bool init (CFeatures *l, CFeatures *r)
void init ()
virtual EKernelType get_kernel_type ()
virtual EFeatureType get_feature_type ()
virtual EFeatureClass get_feature_class ()
virtual const char * get_name () const
virtual void set_sigma (float64_t s)
virtual float64_t get_sigma () const
virtual ~CSphericalKernel ()

Protected Member Functions

virtual float64_t compute (int32_t idx_a, int32_t idx_b)

Protected Attributes

CDistancedistance
float64_t sigma

Constructor & Destructor Documentation

CSphericalKernel ( void   ) 

default constructor

Definition at line 17 of file SphericalKernel.cpp.

CSphericalKernel ( int32_t  size,
float64_t  sigma,
CDistance dist 
)

constructor

Parameters:
size cache size
sigma kernel parameter sigma
dist distance

Definition at line 23 of file SphericalKernel.cpp.

CSphericalKernel ( CFeatures l,
CFeatures r,
float64_t  sigma,
CDistance dist 
)

constructor

Parameters:
l features of left-side
r features of right-side
sigma kernel parameter sigma
dist distance

Definition at line 32 of file SphericalKernel.cpp.

~CSphericalKernel (  )  [virtual]

Definition at line 43 of file SphericalKernel.cpp.


Member Function Documentation

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 CKernel.

Definition at line 63 of file SphericalKernel.cpp.

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

Implements CKernel.

Definition at line 84 of file SphericalKernel.h.

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

Implements CKernel.

Definition at line 79 of file SphericalKernel.h.

virtual EKernelType get_kernel_type (  )  [virtual]
Returns:
kernel type

Implements CKernel.

Definition at line 74 of file SphericalKernel.h.

virtual const char* get_name ( void   )  const [virtual]
Returns:
name of kernel

Implements CSGObject.

Definition at line 89 of file SphericalKernel.h.

virtual float64_t get_sigma (  )  const [virtual]

return the kernel's sigma

Returns:
kernel sigma

Definition at line 104 of file SphericalKernel.h.

void init ( void   ) 

Do basic initialisations like default settings and registering parameters

Reimplemented from CKernel.

Definition at line 57 of file SphericalKernel.cpp.

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

initialize kernel with features

Parameters:
l features of left-side
r features of right-side
Returns:
true if successful

Reimplemented from CKernel.

Definition at line 49 of file SphericalKernel.cpp.

virtual void set_sigma ( float64_t  s  )  [virtual]

set the kernel's sigma

Parameters:
s kernel sigma

Definition at line 95 of file SphericalKernel.h.


Member Data Documentation

CDistance* distance [protected]

distance

Definition at line 113 of file SphericalKernel.h.

float64_t sigma [protected]

width

Definition at line 116 of file SphericalKernel.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