SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
NOCCO.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) The Shogun Machine Learning Toolbox
3  * Written (w) 2014 Soumyajit De
4  * Written (w) 2012-2013 Heiko Strathmann
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 NOCCO_H_
33 #define NOCCO_H_
34 
35 #include <shogun/lib/config.h>
36 
37 #ifdef HAVE_EIGEN3
39 
40 namespace shogun
41 {
42 
43 template<class T> class SGMatrix;
44 
110 {
111 public:
113  CNOCCO();
114 
125  CNOCCO(CKernel* kernel_p, CKernel* kernel_q, CFeatures* p, CFeatures* q);
126 
128  virtual ~CNOCCO();
129 
138  virtual float64_t compute_statistic();
139 
148  virtual float64_t compute_p_value(float64_t statistic);
149 
157  virtual float64_t compute_threshold(float64_t alpha);
158 
160  virtual const char* get_name() const
161  {
162  return "NOCCO";
163  }
164 
167  {
168  return S_NOCCO;
169  }
170 
175  virtual void set_p(CFeatures* p);
176 
181  virtual void set_q(CFeatures* q);
182 
188 
190  float64_t get_epsilon() const;
191 
200 
201 protected:
210 
211 private:
213  void init();
214 
216  index_t m_num_features;
217 
219  float64_t m_epsilon;
220 
221 };
222 
223 }
224 
225 #endif // NOCCO_H_
226 #endif // HAVE_EIGEN3
virtual const char * get_name() const
Definition: NOCCO.h:160
virtual float64_t compute_p_value(float64_t statistic)
Definition: NOCCO.cpp:189
virtual float64_t compute_statistic()
Definition: NOCCO.cpp:148
int32_t index_t
Definition: common.h:62
virtual EStatisticType get_statistic_type() const
Definition: NOCCO.h:166
This class implements the NOrmalized Cross Covariance Operator (NOCCO) based independence test as des...
Definition: NOCCO.h:109
SGMatrix< float64_t > compute_helper(SGMatrix< float64_t > m)
Definition: NOCCO.cpp:109
float64_t get_epsilon() const
Definition: NOCCO.cpp:104
virtual void set_p(CFeatures *p)
Definition: NOCCO.cpp:85
static const float64_t epsilon
Definition: libbmrm.cpp:25
void set_epsilon(float64_t epsilon)
Definition: NOCCO.cpp:99
virtual ~CNOCCO()
Definition: NOCCO.cpp:66
double float64_t
Definition: common.h:50
virtual float64_t compute_threshold(float64_t alpha)
Definition: NOCCO.cpp:208
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:68
Kernel independence test base class. Provides an interface for performing an independence test...
The Kernel base class.
Definition: Kernel.h:158
virtual SGVector< float64_t > sample_null()
Definition: NOCCO.cpp:227
virtual void set_q(CFeatures *q)
Definition: NOCCO.cpp:92

SHOGUN Machine Learning Toolbox - Documentation