SHOGUN  4.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
AdaptMomentumCorrection.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 ADAPTMOMEMTUMCORRECTION_H
33 #define ADAPTMOMEMTUMCORRECTION_H
34 #include <shogun/lib/SGVector.h>
37 
38 namespace shogun
39 {
52 {
53 public:
54 
55  /* Constructor */
58  {
59  init();
60  }
61 
66  virtual const char* get_name() const { return "AdaptMomentumCorrection"; }
67 
72  virtual void set_momentum_correction(MomentumCorrection* correction);
73 
74  /* Destructor */
75  virtual ~AdaptMomentumCorrection();
76 
81  virtual bool is_initialized();
82 
87  virtual void set_correction_weight(float64_t weight);
88 
99  virtual DescendPair get_corrected_descend_direction(float64_t negative_descend_direction,
100  index_t idx);
101 
106  virtual void initialize_previous_direction(index_t len);
107 
114  virtual void set_adapt_rate(float64_t adapt_rate, float64_t rate_min=0.0, float64_t rate_max=CMath::INFTY);
115 
120  virtual void set_init_descend_rate(float64_t init_descend_rate);
121 
122 protected:
135 private:
137  void init();
138 
139 };
140 
141 }
142 #endif
virtual DescendPair get_corrected_descend_direction(float64_t negative_descend_direction, index_t idx)
virtual void set_adapt_rate(float64_t adapt_rate, float64_t rate_min=0.0, float64_t rate_max=CMath::INFTY)
int32_t index_t
Definition: common.h:62
static const float64_t INFTY
infinity
Definition: Math.h:2048
virtual void set_momentum_correction(MomentumCorrection *correction)
virtual void set_init_descend_rate(float64_t init_descend_rate)
virtual const char * get_name() const
double float64_t
Definition: common.h:50
virtual void initialize_previous_direction(index_t len)
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
This is a base class for momentum correction methods.
This implements the adaptive momentum correction method.
virtual void set_correction_weight(float64_t weight)

SHOGUN Machine Learning Toolbox - Documentation