SHOGUN  6.1.3
ShiftInvariantKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) The Shogun Machine Learning Toolbox
3  * Written (w) 2016 Soumyajit De
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice, this
10  * list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
19  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * The views and conclusions contained in the software and documentation are those
27  * of the authors and should not be interpreted as representing official policies,
28  * either expressed or implied, of the Shogun Development Team.
29  */
30 
31 #include <shogun/lib/config.h>
32 
33 #ifndef SHIFT_INVARIANT_KERNEL_H_
34 #define SHIFT_INVARIANT_KERNEL_H_
35 
36 #include <shogun/kernel/Kernel.h>
38 
39 namespace shogun
40 {
41 
42 namespace internal
43 {
44  class KernelManager;
45 }
46 
56 {
57 
58  friend class internal::KernelManager;
59 
60 public:
63 
71 
73  virtual ~CShiftInvariantKernel();
74 
82  virtual bool init(CFeatures* l, CFeatures* r);
83 
85  virtual void precompute_distance();
86 
91  virtual void cleanup();
92 
103  virtual float64_t compute(int32_t x, int32_t y)=0;
104 
106  virtual EKernelType get_kernel_type()=0;
107 
109  virtual EFeatureType get_feature_type()=0;
110 
112  virtual EFeatureClass get_feature_class()=0;
113 
115  virtual EDistanceType get_distance_type() const;
116 
118  virtual const char* get_name() const
119  {
120  return "ShiftInvariantKernel";
121  }
122 
123 protected:
132  virtual float64_t distance(int32_t idx_a, int32_t idx_b) const;
133 
136 
137 private:
139  virtual void register_params();
140 
142  CCustomDistance* m_precomputed_distance;
143 
149  void set_precomputed_distance(CCustomDistance* precomputed_distance);
150 
152  CCustomDistance* get_precomputed_distance() const;
153 
154 };
155 
156 }
157 
158 #endif // SHIFT_INVARIANT_KERNEL_H__
float distance(CJLCoverTreePoint p1, CJLCoverTreePoint p2, float64_t upper_bound)
Base class for the family of kernel functions that only depend on the difference of the inputs...
Class Distance, a base class for all the distances used in the Shogun toolbox.
Definition: Distance.h:87
EFeatureClass
shogun feature class
Definition: FeatureTypes.h:38
EDistanceType
Definition: Distance.h:32
double float64_t
Definition: common.h:60
EFeatureType
shogun feature type
Definition: FeatureTypes.h:19
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
The class Features is the base class of all feature objects.
Definition: Features.h:69
The Kernel base class.
The Custom Distance allows for custom user provided distance matrices.
virtual const char * get_name() const

SHOGUN Machine Learning Toolbox - Documentation