Public Member Functions | Protected Member Functions | Protected Attributes

CCauchyKernel Class Reference


Detailed Description

Cauchy kernel.

Formally described as

\[ K(x,x') = \frac{1}{1+\frac{\| x-x' \|^2}{\sigma}} \]

Definition at line 35 of file CauchyKernel.h.

Inheritance diagram for CCauchyKernel:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CCauchyKernel ()
 CCauchyKernel (int32_t cache, float64_t sigma, CDistance *dist)
 CCauchyKernel (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 ~CCauchyKernel ()

Protected Member Functions

virtual float64_t compute (int32_t idx_a, int32_t idx_b)

Protected Attributes

CDistancem_distance
 distance to be used
float64_t m_sigma
 sigma parameter of kernel

Constructor & Destructor Documentation

CCauchyKernel (  ) 

default constructor

Definition at line 16 of file CauchyKernel.cpp.

CCauchyKernel ( int32_t  cache,
float64_t  sigma,
CDistance dist 
)

constructor

Parameters:
cache size of cache
sigma kernel parameter sigma
dist distance to be used

Definition at line 21 of file CauchyKernel.cpp.

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

constructor

Parameters:
l features left-side
r features right-side
sigma kernel parameter sigma
dist distance to be used

Definition at line 29 of file CauchyKernel.cpp.

~CCauchyKernel (  )  [virtual]

Definition at line 38 of file CauchyKernel.cpp.


Member Function Documentation

float64_t compute ( int32_t  idx_a,
int32_t  idx_b 
) [protected, virtual]

compute kernel for specific feature vectors corresponding to [idx_a] of left-side and [idx_b] of right-side

Parameters:
idx_a left-side index
idx_b right-side index
Returns:
kernel value

Implements CKernel.

Definition at line 58 of file CauchyKernel.cpp.

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

Implements CKernel.

Definition at line 76 of file CauchyKernel.h.

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

Implements CKernel.

Definition at line 71 of file CauchyKernel.h.

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

Implements CKernel.

Definition at line 66 of file CauchyKernel.h.

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

Implements CSGObject.

Definition at line 81 of file CauchyKernel.h.

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

initialize kernel with features

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

Reimplemented from CKernel.

Definition at line 44 of file CauchyKernel.cpp.


Member Data Documentation

CDistance* m_distance [protected]

distance to be used

Definition at line 103 of file CauchyKernel.h.

float64_t m_sigma [protected]

sigma parameter of kernel

Definition at line 106 of file CauchyKernel.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