SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
StandardMomentumCorrection.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 STANDARDMOMENTUMCORRECTION_H
33 #define STANDARDMOMENTUMCORRECTION_H
34 #include <shogun/lib/config.h>
36 namespace shogun
37 {
63 {
64 public:
65  /* Constructor */
68  {
69  init();
70  }
71 
72  /* Destructor */
74 
75 
82  virtual DescendPair get_corrected_descend_direction(float64_t negative_descend_direction,
83  index_t idx)
84  {
85  REQUIRE(idx>=0 && idx<m_previous_descend_direction.vlen,"The index (%d) is invalid\n", idx);
86  DescendPair pair;
88  m_weight*m_previous_descend_direction[idx]-negative_descend_direction;
89  pair.delta=m_previous_descend_direction[idx];
90  pair.descend_direction=m_previous_descend_direction[idx];
91  return pair;
92  }
93 
94 private:
95  /* Init */
96  void init() { m_weight=0.9; }
97 };
98 
99 }
100 #endif
int32_t index_t
Definition: common.h:62
#define REQUIRE(x,...)
Definition: SGIO.h:206
virtual DescendPair get_corrected_descend_direction(float64_t negative_descend_direction, index_t idx)
index_t vlen
Definition: SGVector.h:494
This implements the plain momentum correction.
double float64_t
Definition: common.h:50
SGVector< float64_t > m_previous_descend_direction
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.

SHOGUN Machine Learning Toolbox - Documentation