SHOGUN  6.0.0
KernelSelectionStrategy.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) The Shogun Machine Learning Toolbox
3  * Written (w) 2012 - 2013 Heiko Strathmann
4  * Written (w) 2014 - 2017 Soumyajit De
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice, this
11  * list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  * The views and conclusions contained in the software and documentation are those
28  * of the authors and should not be interpreted as representing official policies,
29  * either expressed or implied, of the Shogun Development Team.
30  */
31 
32 #ifndef KERNEL_SELECTION_STRAGERY_H_
33 #define KERNEL_SELECTION_STRAGERY_H_
34 
35 #include <memory>
36 #include <shogun/base/SGObject.h>
38 
39 namespace shogun
40 {
41 
42 class CKernel;
43 class CMMD;
44 class CQuadraticTimeMMD;
45 template <class> class SGVector;
46 template <class> class SGMatrix;
47 
48 namespace internal
49 {
50 
51 class KernelManager;
52 
53 }
54 #ifndef DOXYGEN_SHOULD_SKIP_THIS
55 class CKernelSelectionStrategy : public CSGObject
56 {
57  friend class CMMD;
58  friend class CStreamingMMD;
59  friend class CQuadraticTimeMMD;
60 public:
62  CKernelSelectionStrategy(EKernelSelectionMethod method, bool weighted = false);
63  CKernelSelectionStrategy(EKernelSelectionMethod method, index_t num_runs, index_t num_folds, float64_t alpha);
65  CKernelSelectionStrategy& operator=(const CKernelSelectionStrategy& other)=delete;
66  virtual ~CKernelSelectionStrategy();
67 
69  CKernelSelectionStrategy& use_num_runs(index_t num_runs);
70  CKernelSelectionStrategy& use_num_folds(index_t num_folds);
71  CKernelSelectionStrategy& use_alpha(float64_t alpha);
72  CKernelSelectionStrategy& use_weighted(bool weighted);
73 
74  EKernelSelectionMethod get_method() const;
75  index_t get_num_runs() const;
76  index_t get_num_folds() const;
77  float64_t get_alpha() const;
78  bool get_weighted() const;
79 
80  void add_kernel(CKernel* kernel);
81  CKernel* select_kernel(CMMD* estimator);
82  virtual const char* get_name() const;
83  void erase_intermediate_results();
84 
85  SGMatrix<float64_t> get_measure_matrix();
86  SGVector<float64_t> get_measure_vector();
87 private:
88  struct Self;
89  std::unique_ptr<Self> self;
90  void init();
91  const internal::KernelManager& get_kernel_mgr() const;
92 };
93 #endif // DOXYGEN_SHOULD_SKIP_THIS
94 }
95 #endif // KERNEL_SELECTION_STRAGERY_H_
int32_t index_t
Definition: common.h:72
EKernelSelectionMethod
Definition: TestEnums.h:61
double float64_t
Definition: common.h:60
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18

SHOGUN Machine Learning Toolbox - Documentation