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
CExponentialKernel Class Reference

Detailed Description

The Exponential Kernel, closely related to the Gaussian Kernel computed on CDotFeatures.

It is computed as

\[ k({\bf x},{\bf x'})= exp(-\frac{||{\bf x}-{\bf x'}||}{\tau}) \]

where $\tau$ is the kernel width.

Definition at line 37 of file ExponentialKernel.h.

Inheritance diagram for CExponentialKernel:
Inheritance graph
[legend]

Public Member Functions

 CExponentialKernel ()
 CExponentialKernel (CDotFeatures *l, CDotFeatures *r, float64_t width, CDistance *distance, int32_t size)
virtual ~CExponentialKernel ()
virtual bool init (CFeatures *l, CFeatures *r)
virtual void cleanup ()
virtual EKernelType get_kernel_type ()
virtual const char * get_name () const
virtual float64_t get_width () const
- Public Member Functions inherited from CDotKernel
 CDotKernel ()
 CDotKernel (int32_t cachesize)
 CDotKernel (CFeatures *l, CFeatures *r)
virtual EFeatureClass get_feature_class ()
virtual EFeatureType get_feature_type ()
- 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 ()
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 Member Functions

virtual float64_t compute (int32_t idx_a, int32_t idx_b)
virtual void load_serializable_post () throw (ShogunException)

Protected Attributes

CDistancem_distance
float64_t m_width

Additional Inherited Members

- Public Attributes inherited from CSGObject
SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
- 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 22 of file ExponentialKernel.cpp.

CExponentialKernel ( CDotFeatures l,
CDotFeatures r,
float64_t  width,
CDistance distance,
int32_t  size 
)

constructor

Parameters
lfeatures of left-hand side
rfeatures of right-hand side
widthwidth
distancedistance to be used
sizecache size

Definition at line 28 of file ExponentialKernel.cpp.

~CExponentialKernel ( )
virtual

destructor

Definition at line 38 of file ExponentialKernel.cpp.

Member Function Documentation

void cleanup ( )
virtual

clean up kernel

Reimplemented from CKernel.

Definition at line 44 of file ExponentialKernel.cpp.

float64_t compute ( int32_t  idx_a,
int32_t  idx_b 
)
protectedvirtual

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

Reimplemented from CDotKernel.

Definition at line 57 of file ExponentialKernel.cpp.

virtual EKernelType get_kernel_type ( )
virtual

return what type of kernel we are

Returns
kernel type EXPONENTIAL

Implements CDotKernel.

Definition at line 74 of file ExponentialKernel.h.

virtual const char* get_name ( ) const
virtual

return the kernel's name

Returns
name Exponential

Reimplemented from CDotKernel.

Definition at line 80 of file ExponentialKernel.h.

virtual float64_t get_width ( ) const
virtual

return the kernel's width

Returns
kernel width

Definition at line 86 of file ExponentialKernel.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 CDotKernel.

Definition at line 49 of file ExponentialKernel.cpp.

void load_serializable_post ( ) throw (ShogunException)
protectedvirtual

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 64 of file ExponentialKernel.cpp.

Member Data Documentation

CDistance* m_distance
protected

distance

Definition at line 117 of file ExponentialKernel.h.

float64_t m_width
protected

width

Definition at line 119 of file ExponentialKernel.h.


The documentation for this class was generated from the following files:

SHOGUN Machine Learning Toolbox - Documentation