SHOGUN
6.0.0
src
shogun
optimization
ConstLearningRate.cpp
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
#include <
shogun/optimization/ConstLearningRate.h
>
33
#include <
shogun/base/Parameter.h
>
34
35
using namespace
shogun
;
36
37
void
ConstLearningRate::set_const_learning_rate
(
float64_t
learning_rate)
38
{
39
REQUIRE
(learning_rate>0.0,
"learning_rate (%f) must be positive"
,learning_rate);
40
m_const_learning_rate
=learning_rate;
41
}
42
43
float64_t
ConstLearningRate::get_learning_rate
(int32_t iter_counter)
44
{
45
REQUIRE
(
m_const_learning_rate
>0.0,
"learning_rate must set\n"
);
46
return
m_const_learning_rate
;
47
}
48
49
void
ConstLearningRate::init()
50
{
51
m_const_learning_rate
=0.0;
52
SG_ADD
(&
m_const_learning_rate
,
"ConstLearningRate__m_const_learning_rate"
,
53
"learning rate in ConstLearningRate"
,
MS_NOT_AVAILABLE
);
54
}
Parameter.h
REQUIRE
#define REQUIRE(x,...)
Definition:
SGIO.h:205
ConstLearningRate.h
shogun::MS_NOT_AVAILABLE
Definition:
SGObject.h:102
shogun::ConstLearningRate::m_const_learning_rate
float64_t m_const_learning_rate
Definition:
ConstLearningRate.h:79
shogun::ConstLearningRate::get_learning_rate
virtual float64_t get_learning_rate(int32_t iter_counter)
Definition:
ConstLearningRate.cpp:43
float64_t
double float64_t
Definition:
common.h:60
shogun
all of classes and functions are contained in the shogun namespace
Definition:
class_list.h:18
shogun::ConstLearningRate::set_const_learning_rate
virtual void set_const_learning_rate(float64_t learning_rate)
Definition:
ConstLearningRate.cpp:37
SG_ADD
#define SG_ADD(...)
Definition:
SGObject.h:94
SHOGUN
Machine Learning Toolbox - Documentation