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

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 () throw (ShogunException)
virtual float64_t compute (int32_t idx_a, int32_t idx_b)
- 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_tget_kernel_matrix ()
virtual SGVector< float64_tget_kernel_col (int32_t j)
virtual SGVector< float64_tget_kernel_row (int32_t i)
template<class T >
SGMatrix< T > get_kernel_matrix ()
virtual bool set_normalizer (CKernelNormalizer *normalizer)
virtual CKernelNormalizerget_normalizer ()
virtual bool init_normalizer ()
virtual void cleanup ()
void load (CFile *loader)
void save (CFile *writer)
CFeaturesget_lhs ()
CFeaturesget_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
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_tget_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)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_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)

Protected Attributes

CDistancedistance
float64_t sigma
- Protected Attributes inherited from CKernel
int32_t cache_size
 cache_size in MB
KERNELCACHE_ELEMkernel_matrix
CFeatureslhs
 feature vectors to occur on left hand side
CFeaturesrhs
 feature vectors to occur on right hand side
bool lhs_equals_rhs
 lhs
int32_t num_lhs
 number of feature vectors on left hand side
int32_t num_rhs
 number of feature vectors on right hand side
float64_t combined_kernel_weight
bool optimization_initialized
EOptimizationType opt_type
uint64_t properties
CKernelNormalizernormalizer

Additional Inherited Members

- Public Attributes inherited from CSGObject
SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
- 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 save_serializable_pre () throw (ShogunException)
virtual void save_serializable_post () throw (ShogunException)
virtual void register_params ()
- Static Protected Member Functions inherited from CKernel
template<class T >
static void * get_kernel_matrix_helper (void *p)

Constructor & Destructor Documentation

default constructor

Definition at line 17 of file CircularKernel.cpp.

CCircularKernel ( int32_t  size,
float64_t  sigma,
CDistance dist 
)

constructor

Parameters
sizecache size
sigmakernel parameter sigma
distdistance

Definition at line 23 of file CircularKernel.cpp.

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

constructor

Parameters
lfeatures of left-side
rfeatures of right-side
sigmakernel parameter sigma
distdistance

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_aindex a
idx_bindex 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 ( ) 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
lfeatures of left-side
rfeatures of right-side
Returns
true if successful

Reimplemented from CKernel.

Definition at line 50 of file CircularKernel.cpp.

void load_serializable_post ( ) 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
ShogunExceptionWill 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
skernel 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:

SHOGUN Machine Learning Toolbox - Documentation