SHOGUN
6.0.0
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/base/SGObject.h
>
35
namespace
shogun
36
{
37
#ifndef DOXYGEN_SHOULD_SKIP_THIS
38
struct
DescendPair
39
{
40
DescendPair()
41
{
42
descend_direction=0.0;
43
delta=0.0;
44
}
45
46
float64_t
descend_direction;
47
float64_t
delta;
48
};
49
#endif
50
55
class
DescendCorrection
:
public
CSGObject
56
{
57
public
:
58
/* Constructor */
59
DescendCorrection
()
60
{
61
init();
62
}
63
64
/* Destructor */
65
virtual
~DescendCorrection
() {};
66
71
virtual
void
set_correction_weight(
float64_t
weight);
72
79
virtual
DescendPair get_corrected_descend_direction(
float64_t
negative_descend_direction,
80
index_t
idx)=0;
81
82
protected
:
84
float64_t
m_weight
;
85
86
private
:
88
void
init();
89
};
90
91
}
92
#endif
SGObject.h
index_t
int32_t index_t
Definition:
common.h:72
shogun::DescendCorrection::DescendCorrection
DescendCorrection()
Definition:
DescendCorrection.h:59
shogun::CSGObject
Class SGObject is the base class of all shogun objects.
Definition:
SGObject.h:125
float64_t
double float64_t
Definition:
common.h:60
shogun::DescendCorrection
This is a base class for descend based correction method.
Definition:
DescendCorrection.h:55
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:84
shogun::DescendCorrection::~DescendCorrection
virtual ~DescendCorrection()
Definition:
DescendCorrection.h:65
SHOGUN
Machine Learning Toolbox - Documentation