SHOGUN
4.1.0
Main Page
Related Pages
Modules
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Modules
Pages
src
shogun
optimization
ConstLearningRate.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 CONSTLEARNINGRATE_H
33
#define CONSTLEARNINGRATE_H
34
#include <
shogun/optimization/LearningRate.h
>
35
#include <
shogun/lib/config.h
>
36
37
namespace
shogun
38
{
45
class
ConstLearningRate
:
public
LearningRate
46
{
47
public
:
49
ConstLearningRate
():
LearningRate
() { init(); }
50
52
virtual
~ConstLearningRate
() {}
53
58
virtual
void
set_const_learning_rate
(
float64_t
learning_rate)
59
{
60
REQUIRE
(learning_rate>0.0,
"learning_rate (%f) must be positive"
,learning_rate);
61
m_const_learning_rate
=learning_rate;
62
}
63
72
virtual
float64_t
get_learning_rate
(int32_t iter_counter)
73
{
74
REQUIRE
(
m_const_learning_rate
>0.0,
"learning_rate must set\n"
);
75
return
m_const_learning_rate
;
76
}
77
82
virtual
void
update_context
(
CMinimizerContext
* context)
83
{
84
REQUIRE
(context,
"Context must set\n"
);
85
}
86
92
virtual
void
load_from_context
(
CMinimizerContext
* context)
93
{
94
REQUIRE
(context,
"Context must set\n"
);
95
}
96
97
protected
:
98
100
float64_t
m_const_learning_rate
;
101
102
private
:
104
void
init()
105
{
106
m_const_learning_rate=0.0;
107
}
108
};
109
110
}
111
112
#endif
shogun::ConstLearningRate::~ConstLearningRate
virtual ~ConstLearningRate()
Definition:
ConstLearningRate.h:52
shogun::ConstLearningRate::load_from_context
virtual void load_from_context(CMinimizerContext *context)
Definition:
ConstLearningRate.h:92
shogun::LearningRate
The base class about learning rate for descent-based minimizers.
Definition:
LearningRate.h:46
shogun::CMinimizerContext
The class is used to serialize and deserialize variables for the optimization framework.
Definition:
MinimizerContext.h:45
config.h
REQUIRE
#define REQUIRE(x,...)
Definition:
SGIO.h:206
shogun::ConstLearningRate::update_context
virtual void update_context(CMinimizerContext *context)
Definition:
ConstLearningRate.h:82
shogun::ConstLearningRate::m_const_learning_rate
float64_t m_const_learning_rate
Definition:
ConstLearningRate.h:100
shogun::ConstLearningRate
This implements the const learning rate class for a descent-based minimizer.
Definition:
ConstLearningRate.h:45
float64_t
double float64_t
Definition:
common.h:50
shogun::ConstLearningRate::get_learning_rate
virtual float64_t get_learning_rate(int32_t iter_counter)
Definition:
ConstLearningRate.h:72
shogun
all of classes and functions are contained in the shogun namespace
Definition:
class_list.h:18
LearningRate.h
shogun::ConstLearningRate::ConstLearningRate
ConstLearningRate()
Definition:
ConstLearningRate.h:49
shogun::ConstLearningRate::set_const_learning_rate
virtual void set_const_learning_rate(float64_t learning_rate)
Definition:
ConstLearningRate.h:58
SHOGUN
Machine Learning Toolbox - Documentation