SHOGUN  4.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
SGDMinimizer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) The Shogun Machine Learning Toolbox
3  * Written (w) 2015 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  */
31 
32 #ifndef SGDMINIMIZER_H
33 #define SGDMINIMIZER_H
35 
36 namespace shogun
37 {
38 
46 {
47 public:
49  SGDMinimizer();
50 
55 
57  virtual ~SGDMinimizer();
58 
63  virtual const char* get_name() const { return "SGDMinimizer"; }
64 
65 
70  virtual float64_t minimize();
71 
72 protected:
73  /* init the minimization process */
74  virtual void init_minimization();
75 
76 private:
77  /* Init */
78  void init();
79 };
80 
81 }
82 #endif /* SGDMINIMIZER_H */
virtual void init_minimization()
The first order stochastic cost function base class.
virtual float64_t minimize()
The base class for stochastic first-order gradient-based minimizers.
double float64_t
Definition: common.h:50
virtual const char * get_name() const
Definition: SGDMinimizer.h:63
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
The class implements the stochastic gradient descend (SGD) minimizer.
Definition: SGDMinimizer.h:45

SHOGUN Machine Learning Toolbox - Documentation