SHOGUN  v1.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | 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]

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
 
- Public Member Functions inherited from CDistanceKernel
 CDistanceKernel ()
 
 CDistanceKernel (int32_t cache, float64_t width, CDistance *dist)
 
 CDistanceKernel (CFeatures *l, CFeatures *r, float64_t width, CDistance *dist)
 
virtual ~CDistanceKernel ()
 
virtual void register_params ()
 
- Public Member Functions inherited from CKernel
 CKernel ()
 
 CKernel (int32_t size)
 
 CKernel (CFeatures *l, CFeatures *r, int32_t size)
 
virtual ~CKernel ()
 
float64_t kernel (int32_t idx_a, int32_t idx_b)
 
SGMatrix< float64_t > get_kernel_matrix ()
 
virtual SGVector< float64_t > get_kernel_col (int32_t j)
 
virtual SGVector< float64_t > get_kernel_row (int32_t i)
 
template<class T >
SGMatrix< T > get_kernel_matrix ()
 
virtual bool set_normalizer (CKernelNormalizer *normalizer)
 
virtual CKernelNormalizer * get_normalizer ()
 
virtual bool init_normalizer ()
 
void load (CFile *loader)
 
void save (CFile *writer)
 
CFeatures * get_lhs ()
 
CFeatures * get_rhs ()
 
virtual int32_t get_num_vec_lhs ()
 
virtual int32_t get_num_vec_rhs ()
 
virtual bool has_features ()
 
bool get_lhs_equals_rhs ()
 
virtual void remove_lhs_and_rhs ()
 
virtual void remove_lhs ()
 
virtual void remove_rhs ()
 takes all necessary steps if the rhs is removed from kernel More...
 
void set_cache_size (int32_t size)
 
int32_t get_cache_size ()
 
void list_kernel ()
 
bool has_property (EKernelProperty p)
 
virtual void clear_normal ()
 
virtual void add_to_normal (int32_t vector_idx, float64_t weight)
 
EOptimizationType get_optimization_type ()
 
virtual void set_optimization_type (EOptimizationType t)
 
bool get_is_initialized ()
 
virtual bool init_optimization (int32_t count, int32_t *IDX, float64_t *weights)
 
virtual bool delete_optimization ()
 
bool init_optimization_svm (CSVM *svm)
 
virtual float64_t compute_optimized (int32_t vector_idx)
 
virtual void compute_batch (int32_t num_vec, int32_t *vec_idx, float64_t *target, int32_t num_suppvec, int32_t *IDX, float64_t *alphas, float64_t factor=1.0)
 
float64_t get_combined_kernel_weight ()
 
void set_combined_kernel_weight (float64_t nw)
 
virtual int32_t get_num_subkernels ()
 
virtual void compute_by_subkernel (int32_t vector_idx, float64_t *subkernel_contrib)
 
virtual const float64_t * get_subkernel_weights (int32_t &num_weights)
 
virtual void set_subkernel_weights (SGVector< float64_t > weights)
 
- Public Member Functions inherited from CSGObject
 CSGObject ()
 
 CSGObject (const CSGObject &orig)
 
virtual ~CSGObject ()
 
virtual bool is_generic (EPrimitiveType *generic) const
 
template<class T >
void set_generic ()
 
void unset_generic ()
 
virtual void print_serializable (const char *prefix="")
 
virtual bool save_serializable (CSerializableFile *file, const char *prefix="")
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
 
void set_global_io (SGIO *io)
 
SGIO * get_global_io ()
 
void set_global_parallel (Parallel *parallel)
 
Parallel * get_global_parallel ()
 
void set_global_version (Version *version)
 
Version * get_global_version ()
 
SGVector< char * > get_modelsel_names ()
 
char * get_modsel_param_descr (const char *param_name)
 
index_t get_modsel_param_index (const char *param_name)
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 

Protected Member Functions

float64_t compute (int32_t idx_a, int32_t idx_b)
 
- Protected Member Functions inherited from CDistanceKernel
float64_t compute (int32_t idx_a, int32_t idx_b)
 
- Protected Member Functions inherited from CKernel
void set_property (EKernelProperty p)
 
void unset_property (EKernelProperty p)
 
void set_is_initialized (bool p_init)
 
int32_t compute_row_start (int64_t offs, int32_t n, bool symmetric)
 
virtual void load_serializable_post () throw (ShogunException)
 
virtual void save_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_post () throw (ShogunException)
 
- Protected Member Functions inherited from CSGObject
virtual void load_serializable_pre () throw (ShogunException)
 

Protected Attributes

float64_t order
 
int32_t degree
 
- Protected Attributes inherited from CDistanceKernel
CDistance * distance
 
float64_t width
 
- Protected Attributes inherited from CKernel
int32_t cache_size
 cache_size in MB More...
 
KERNELCACHE_ELEM * kernel_matrix
 
CFeatures * lhs
 feature vectors to occur on left hand side More...
 
CFeatures * rhs
 feature vectors to occur on right hand side More...
 
bool lhs_equals_rhs
 lhs More...
 
int32_t num_lhs
 number of feature vectors on left hand side More...
 
int32_t num_rhs
 number of feature vectors on right hand side More...
 
float64_t combined_kernel_weight
 
bool optimization_initialized
 
EOptimizationType opt_type
 
uint64_t properties
 
CKernelNormalizer * normalizer
 

Additional Inherited Members

- Public Attributes inherited from CSGObject
SGIO * io
 
Parallel * parallel
 
Version * version
 
Parameter * m_parameters
 
Parameter * m_model_selection_parameters
 
- Static Protected Member Functions inherited from CKernel
template<class T >
static void * get_kernel_matrix_helper (void *p)
 

Constructor & Destructor Documentation

CBesselKernel ( )

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  x,
int32_t  y 
)
protectedvirtual

compute kernel function for features a and b idx_{a,b} denote the index of the feature vectors in the corresponding feature object

abstract base method

Parameters
xindex a
yindex b
Returns
computed kernel function at indices a,b

Implements CKernel.

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:
SHOGUN Machine Learning Toolbox - Documentation