Public Member Functions | Protected Attributes

CCircularKernel Class Reference


Detailed Description

Circular kernel.

Formally described as

\[ k(x, y) = \frac{2}{\pi}*\arccos(\frac{-||{\bf x}-{\bf x'}||}{\sigma}) - \frac{2}{\pi}*(\frac{||{\bf x}-{\bf x'}||}{\sigma})*\sqrt{1-(\frac{||{\bf x}-{\bf x'}||}{\sigma})^2} \mbox{if}~ ||x-y|| \leq \sigma \mbox{, zero otherwise} \]

Definition at line 38 of file CircularKernel.h.

Inheritance diagram for CCircularKernel:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CCircularKernel ()
 CCircularKernel (int32_t size, float64_t sigma, CDistance *dist)
 CCircularKernel (CFeatures *l, CFeatures *r, float64_t sigma, CDistance *dist)
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 () const
virtual void set_sigma (float64_t s)
virtual float64_t get_sigma () const
virtual ~CCircularKernel ()
virtual void load_serializable_post (void) throw (ShogunException)
virtual float64_t compute (int32_t idx_a, int32_t idx_b)

Protected Attributes

CDistancedistance
float64_t sigma

Constructor & Destructor Documentation

CCircularKernel ( void   ) 

default constructor

Definition at line 17 of file CircularKernel.cpp.

CCircularKernel ( 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 CircularKernel.cpp.

CCircularKernel ( 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 33 of file CircularKernel.cpp.

~CCircularKernel (  )  [virtual]

Definition at line 44 of file CircularKernel.cpp.


Member Function Documentation

float64_t compute ( int32_t  idx_a,
int32_t  idx_b 
) [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 69 of file CircularKernel.cpp.

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

Implements CKernel.

Definition at line 82 of file CircularKernel.h.

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

Implements CKernel.

Definition at line 77 of file CircularKernel.h.

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

Implements CKernel.

Definition at line 72 of file CircularKernel.h.

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

Implements CSGObject.

Definition at line 87 of file CircularKernel.h.

virtual float64_t get_sigma (  )  const [virtual]

return the kernel's sigma

Returns:
kernel sigma

Definition at line 102 of file CircularKernel.h.

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 50 of file CircularKernel.cpp.

void load_serializable_post ( void   )  throw (ShogunException) [virtual]

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

Exceptions:
ShogunException Will be thrown if an error occurres.

Reimplemented from CKernel.

Definition at line 58 of file CircularKernel.cpp.

virtual void set_sigma ( float64_t  s  )  [virtual]

set the kernel's sigma

Parameters:
s kernel sigma

Definition at line 93 of file CircularKernel.h.


Member Data Documentation

CDistance* distance [protected]

distance

Definition at line 136 of file CircularKernel.h.

float64_t sigma [protected]

width

Definition at line 139 of file CircularKernel.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