SHOGUN  5.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
CircularKernel.h
Go to the documentation of this file.
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License as published by
4  * the Free Software Foundation; either version 3 of the License, or
5  * (at your option) any later version.
6  *
7  * Written (W) 2011 Abhinav Maurya
8  * Copyright (C) 2011 Berlin Institute of Technology and Max-Planck-Society
9  * Copyright (C) 2011 Indian Institute of Technology Bombay
10  */
11 
12 #include <shogun/lib/config.h>
13 
14 #ifndef _CIRCULARKERNEL_H__
15 #define _CIRCULARKERNEL_H__
16 
17 #include <shogun/lib/common.h>
18 #include <shogun/kernel/Kernel.h>
20 
21 namespace shogun
22 {
23 
24 class CDistance;
25 
38 class CCircularKernel: public CKernel
39 {
40  public:
43 
50  CCircularKernel(int32_t size, float64_t sigma, CDistance* dist);
51 
60 
67  virtual bool init(CFeatures* l, CFeatures* r);
68 
72  virtual EKernelType get_kernel_type() { return K_CIRCULAR; }
73 
78 
83 
87  virtual const char* get_name() const { return "CircularKernel"; }
88 
93  virtual void set_sigma(float64_t s)
94  {
95  sigma=s;
96  }
97 
102  virtual float64_t get_sigma() const
103  {
104  return sigma;
105  }
106 
107  virtual ~CCircularKernel();
108 
117  virtual void load_serializable_post() throw (ShogunException);
118 
128  virtual float64_t compute(int32_t idx_a, int32_t idx_b);
129 
130 private:
131  void init();
132 
133 protected:
134 
137 
139  float64_t sigma;
140 
141 };
142 }
143 
144 #endif /* _CIRCULARKERNEL_H__ */
virtual EKernelType get_kernel_type()
virtual float64_t get_sigma() const
virtual EFeatureClass get_feature_class()=0
virtual bool init(CFeatures *l, CFeatures *r)
EKernelType
Definition: Kernel.h:57
Class Distance, a base class for all the distances used in the Shogun toolbox.
Definition: Distance.h:87
virtual void load_serializable_post()
Class ShogunException defines an exception which is thrown whenever an error inside of shogun occurs...
EFeatureClass
shogun feature class
Definition: FeatureTypes.h:38
virtual EFeatureClass get_feature_class()
double float64_t
Definition: common.h:50
virtual EFeatureType get_feature_type()
EFeatureType
shogun feature type
Definition: FeatureTypes.h:19
virtual float64_t compute(int32_t idx_a, int32_t idx_b)
virtual void set_sigma(float64_t s)
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
virtual const char * get_name() const
The class Features is the base class of all feature objects.
Definition: Features.h:68
virtual EFeatureType get_feature_type()=0
The Kernel base class.
Definition: Kernel.h:159
Circular kernel.

SHOGUN Machine Learning Toolbox - Documentation