SHOGUN  6.1.3
ConstMean.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) The Shogun Machine Learning Toolbox
3  * Written (w) 2014 Wu Lin
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  * Adapted from the GPML toolbox, specifically meanConst.m
31  * http://www.gaussianprocess.org/gpml/code/matlab/doc/
32  */
33 
34 #ifndef CCONSTMEAN_H_
35 #define CCONSTMEAN_H_
36 
37 #include <shogun/lib/config.h>
38 
40 
41 namespace shogun
42 {
43 
48 class CConstMean : public CMeanFunction
49 {
50 public:
54  CConstMean();
55 
60 
61  virtual ~CConstMean();
62 
67  virtual void set_const(float64_t mean) {m_mean=mean;}
68 
73  virtual const char* get_name() const { return "ConstMean"; }
74 
82  virtual SGVector<float64_t> get_mean_vector(const CFeatures* features) const;
83 
93  const TParameter* param, index_t index=-1);
94 private:
95 
96  void init();
97 
99  float64_t m_mean;
100 };
101 }
102 #endif /* CCONSTMEAN_H_ */
virtual const char * get_name() const
Definition: ConstMean.h:73
int32_t index_t
Definition: common.h:72
parameter struct
An abstract class of the mean function.
Definition: MeanFunction.h:49
std::enable_if<!std::is_same< T, complex128_t >::value, float64_t >::type mean(const Container< T > &a)
double float64_t
Definition: common.h:60
The Const mean function class.
Definition: ConstMean.h:48
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
virtual ~CConstMean()
Definition: ConstMean.cpp:43
virtual SGVector< float64_t > get_parameter_derivative(const CFeatures *features, const TParameter *param, index_t index=-1)
Definition: ConstMean.cpp:67
virtual SGVector< float64_t > get_mean_vector(const CFeatures *features) const
Definition: ConstMean.cpp:60
The class Features is the base class of all feature objects.
Definition: Features.h:69
virtual void set_const(float64_t mean)
Definition: ConstMean.h:67

SHOGUN Machine Learning Toolbox - Documentation