SHOGUN  6.1.3
InverseScalingLearningRate.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 INVERSESCALINGLEARNINGRATE_H
33 #define INVERSESCALINGLEARNINGRATE_H
35 
36 namespace shogun
37 {
52 {
53 public:
54  /* Constructor */
56 
57  /* Destructor */
59 
64  virtual const char* get_name() const { return "InverseScalingLearningRate"; }
65 
71  virtual float64_t get_learning_rate(int32_t iter_counter);
72 
77  virtual void set_initial_learning_rate(float64_t initial_learning_rate);
78 
83  virtual void set_exponent(float64_t exponent);
84 
89  virtual void set_slope(float64_t slope);
90 
95  virtual void set_intercept(float64_t intercept);
96 
97 protected:
106 private:
108  void init();
109 };
110 
111 }
112 
113 #endif
The base class about learning rate for descent-based minimizers.
Definition: LearningRate.h:47
virtual const char * get_name() const
virtual void set_initial_learning_rate(float64_t initial_learning_rate)
virtual void set_exponent(float64_t exponent)
virtual float64_t get_learning_rate(int32_t iter_counter)
double float64_t
Definition: common.h:60
The implements the inverse scaling learning rate.
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
Container< T > exponent(const Container< T > &a)
virtual void set_intercept(float64_t intercept)

SHOGUN Machine Learning Toolbox - Documentation