SHOGUN  6.1.3
MomentumCorrection.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 MOMEMTUMCORRECTION_H
33 #define MOMEMTUMCORRECTION_H
34 #include <shogun/lib/SGVector.h>
36 namespace shogun
37 {
45 {
46 public:
47  /* Constructor */
50  {
51  init();
52  }
53 
54  /* Destructor */
55  virtual ~MomentumCorrection() {};
56 
61  virtual bool is_initialized()
62  {
64  }
65 
70  virtual void initialize_previous_direction(index_t len);
71 
79  virtual DescendPair get_corrected_descend_direction(float64_t negative_descend_direction,
80  index_t idx)=0;
81 
82 
90 
96  {
98  }
99 
100 protected:
103 
104 private:
105  /* Init */
106  void init();
107 };
108 
109 }
110 #endif
virtual void initialize_previous_direction(index_t len)
int32_t index_t
Definition: common.h:72
virtual float64_t get_length_previous_descend_direction()
virtual float64_t get_previous_descend_direction(index_t idx)
double float64_t
Definition: common.h:60
SGVector< float64_t > m_previous_descend_direction
This is a base class for descend based correction method.
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.
virtual DescendPair get_corrected_descend_direction(float64_t negative_descend_direction, index_t idx)=0
index_t vlen
Definition: SGVector.h:571

SHOGUN Machine Learning Toolbox - Documentation