SHOGUN  6.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
HypothesisTest.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 HYPOTHESIS_TEST_H_
33 #define HYPOTHESIS_TEST_H_
34 
35 #include <memory>
36 #include <shogun/lib/config.h>
37 #include <shogun/base/SGObject.h>
38 
39 namespace shogun
40 {
41 
42 class CFeatures;
43 
44 namespace internal
45 {
46 
47 class DataManager;
48 
49 }
50 
69 class CHypothesisTest : public CSGObject
70 {
71 public:
74 
76  virtual ~CHypothesisTest();
77 
92  void set_train_test_mode(bool on);
93 
107  void set_train_test_ratio(float64_t ratio);
108 
121  virtual float64_t compute_p_value(float64_t statistic);
122 
134  virtual float64_t compute_threshold(float64_t alpha);
135 
149  bool perform_test(float64_t alpha);
150 
156  virtual float64_t compute_statistic()=0;
157 
163  virtual SGVector<float64_t> sample_null()=0;
164 
166  virtual const char* get_name() const;
167 protected:
168  explicit CHypothesisTest(index_t num_distributions);
170  const internal::DataManager& get_data_mgr() const;
171 private:
172  CHypothesisTest(const CHypothesisTest& other)=delete;
173  CHypothesisTest& operator=(const CHypothesisTest& other)=delete;
174 
175  struct Self;
176  std::unique_ptr<Self> self;
177 };
178 
179 }
180 
181 #endif // HYPOTHESIS_TEST_H_
int32_t index_t
Definition: common.h:72
virtual float64_t compute_p_value(float64_t statistic)
virtual const char * get_name() const
virtual float64_t compute_threshold(float64_t alpha)
Hypothesis test base class. Provides an interface for statistical hypothesis testing via three method...
bool perform_test(float64_t alpha)
Class SGObject is the base class of all shogun objects.
Definition: SGObject.h:125
virtual SGVector< float64_t > sample_null()=0
double float64_t
Definition: common.h:60
internal::DataManager & get_data_mgr()
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
Class DataManager for fetching/streaming test data block-wise. It can handle data coming from multipl...
Definition: DataManager.h:63
void set_train_test_ratio(float64_t ratio)
virtual float64_t compute_statistic()=0
void set_train_test_mode(bool on)

SHOGUN Machine Learning Toolbox - Documentation