SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
QuadraticTimeMMD.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 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 QUADRATIC_TIME_MMD_H_
33 #define QUADRATIC_TIME_MMD_H_
34 
35 #include <shogun/lib/config.h>
36 
38 
39 namespace shogun
40 {
41 
42 class CFeatures;
43 class CKernel;
44 class CCustomKernel;
45 
48 {
54 };
55 
159 {
160 public:
163 
173  CQuadraticTimeMMD(CKernel* kernel, CFeatures* p_and_q, index_t m);
174 
184  CQuadraticTimeMMD(CKernel* kernel, CFeatures* p, CFeatures* q);
185 
195  CQuadraticTimeMMD(CCustomKernel* custom_kernel, index_t m);
196 
198  virtual ~CQuadraticTimeMMD();
199 
208  virtual float64_t compute_statistic();
209 
217  SGVector<float64_t> compute_statistic(bool multiple_kernels);
218 
228 
236  SGMatrix<float64_t> compute_variance(bool multiple_kernels);
237 
245 
253 
265  virtual float64_t compute_p_value(float64_t statistic);
266 
277  virtual float64_t compute_threshold(float64_t alpha);
278 
280  virtual const char* get_name() const
281  {
282  return "QuadraticTimeMMD";
283  };
284 
287  {
288  return S_QUADRATIC_TIME_MMD;
289  }
290 
291 #ifdef HAVE_EIGEN3
292 
320  index_t num_eigenvalues);
321 
364  index_t num_eigenvalues);
365 #endif // HAVE_EIGEN3
366 
373  void set_num_samples_spectrum(index_t num_samples_spectrum);
374 
381  void set_num_eigenvalues_spectrum(index_t num_eigenvalues_spectrum);
382 
384  void set_statistic_type(EQuadraticMMDType statistic_type);
385 
407 
408 protected:
421 
434 
446 
454 
461  float64_t compute_biased_statistic(int m, int n);
462 
469 
470 private:
472  void init();
473 
474 protected:
477 
480 
485 };
486 
487 }
488 
489 #endif /* QUADRATIC_TIME_MMD_H_ */
EQuadraticMMDType m_statistic_type
virtual const char * get_name() const
float64_t compute_variance_under_alternative()
int32_t index_t
Definition: common.h:62
SGVector< float64_t > compute_biased_statistic_variance(int m, int n)
The Custom Kernel allows for custom user provided kernel matrices.
Definition: CustomKernel.h:36
float64_t compute_unbiased_statistic(int m, int n)
virtual float64_t compute_statistic()
void set_statistic_type(EQuadraticMMDType statistic_type)
SGVector< float64_t > fit_null_gamma()
float64_t compute_incomplete_statistic(int n)
Kernel two sample test base class. Provides an interface for performing a two-sample test using a ker...
virtual EStatisticType get_statistic_type() const
SGVector< float64_t > sample_null_spectrum_DEPRECATED(index_t num_samples, index_t num_eigenvalues)
SGVector< float64_t > sample_null_spectrum(index_t num_samples, index_t num_eigenvalues)
This class implements the quadratic time Maximum Mean Statistic as described in [1]. The MMD is the distance of two probability distributions and in a RKHS which we denote by .
void set_num_eigenvalues_spectrum(index_t num_eigenvalues_spectrum)
double float64_t
Definition: common.h:50
SGVector< float64_t > compute_unbiased_statistic_variance(int m, int n)
void set_num_samples_spectrum(index_t num_samples_spectrum)
virtual float64_t compute_p_value(float64_t statistic)
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
virtual SGVector< float64_t > compute_variance()
The Kernel base class.
Definition: Kernel.h:158
SGVector< float64_t > compute_incomplete_statistic_variance(int n)
virtual float64_t compute_threshold(float64_t alpha)
float64_t compute_biased_statistic(int m, int n)

SHOGUN Machine Learning Toolbox - Documentation