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
DescendCorrection.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 DESCENDCORRECTION_H
33
#define DESCENDCORRECTION_H
34
#include <
shogun/lib/config.h
>
35
#include <
shogun/lib/SGVector.h
>
36
#include <
shogun/optimization/MinimizerContext.h
>
37
namespace
shogun
38
{
39
#ifndef DOXYGEN_SHOULD_SKIP_THIS
40
struct
DescendPair
41
{
42
DescendPair()
43
{
44
descend_direction=0.0;
45
delta
=0.0;
46
}
47
48
float64_t
descend_direction;
49
float64_t
delta
;
50
};
51
#endif
52
57
class
DescendCorrection
58
{
59
public
:
60
61
/* Constructor */
62
DescendCorrection
()
63
{
64
init();
65
}
66
67
/* Destructor */
68
virtual
~DescendCorrection
() {};
69
74
virtual
void
set_correction_weight
(
float64_t
weight)
75
{
76
REQUIRE
(weight>0,
"weight (%f) must be positive\n"
, weight);
77
m_weight
=weight;
78
}
79
86
virtual
DescendPair
get_corrected_descend_direction
(
float64_t
negative_descend_direction,
87
index_t
idx)=0;
88
97
virtual
void
update_context
(
CMinimizerContext
* context)=0;
98
106
virtual
void
load_from_context
(
CMinimizerContext
* context)=0;
107
108
protected
:
110
float64_t
m_weight
;
111
112
private
:
114
void
init()
115
{
116
m_weight=0.0;
117
}
118
};
119
120
}
121
#endif
index_t
int32_t index_t
Definition:
common.h:62
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::DescendCorrection::update_context
virtual void update_context(CMinimizerContext *context)=0
shogun::DescendCorrection::DescendCorrection
DescendCorrection()
Definition:
DescendCorrection.h:62
shogun::DescendCorrection::get_corrected_descend_direction
virtual DescendPair get_corrected_descend_direction(float64_t negative_descend_direction, index_t idx)=0
float64_t
double float64_t
Definition:
common.h:50
MinimizerContext.h
shogun::DescendCorrection
This is a base class for descend based correction method.
Definition:
DescendCorrection.h:57
shogun
all of classes and functions are contained in the shogun namespace
Definition:
class_list.h:18
shogun::DescendCorrection::m_weight
float64_t m_weight
Definition:
DescendCorrection.h:110
shogun::DescendCorrection::~DescendCorrection
virtual ~DescendCorrection()
Definition:
DescendCorrection.h:68
shogun::DescendCorrection::set_correction_weight
virtual void set_correction_weight(float64_t weight)
Definition:
DescendCorrection.h:74
SGVector.h
shogun::DescendCorrection::load_from_context
virtual void load_from_context(CMinimizerContext *context)=0
delta
#define delta
Definition:
sfa.cpp:23
SHOGUN
Machine Learning Toolbox - Documentation