SHOGUN  6.1.3
DescendUpdaterWithCorrection.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 
34 #include <shogun/base/Parameter.h>
35 
36 using namespace shogun;
37 
38 
40 {
42 }
43 
45 {
46  if(m_correction != correction)
47  {
48  SG_REF(correction);
50  m_correction=correction;
51  }
52 }
53 
55  SGVector<float64_t> raw_negative_descend_direction, float64_t learning_rate)
56 {
57  REQUIRE(variable_reference.vlen>0,"variable_reference must set\n");
58  REQUIRE(variable_reference.vlen==raw_negative_descend_direction.vlen,
59  "The length of variable_reference (%d) and the length of gradient (%d) do not match\n",
60  variable_reference.vlen,raw_negative_descend_direction.vlen);
61 
62  if(m_correction)
63  {
64  MomentumCorrection* momentum_correction=dynamic_cast<MomentumCorrection *>(m_correction);
65  if(momentum_correction)
66  {
67  if(!momentum_correction->is_initialized())
68  momentum_correction->initialize_previous_direction(variable_reference.vlen);
69  }
70  }
71 
72  for(index_t idx=0; idx<variable_reference.vlen; idx++)
73  {
74  float64_t negative_descend_direction=get_negative_descend_direction(
75  variable_reference[idx], raw_negative_descend_direction[idx], idx, learning_rate);
76  if(m_correction)
77  {
79  negative_descend_direction, idx);
80  variable_reference[idx]+=pair.descend_direction;
81  }
82  else
83  {
84  variable_reference[idx]-=negative_descend_direction;
85  }
86  }
87 }
88 
89 void DescendUpdaterWithCorrection::init()
90 {
91  m_correction=NULL;
92  SG_ADD((CSGObject **)&m_correction, "DescendUpdaterWithCorrection__m_correction",
93  "correction in DescendUpdaterWithCorrection", MS_NOT_AVAILABLE);
94 }
virtual void initialize_previous_direction(index_t len)
int32_t index_t
Definition: common.h:72
#define REQUIRE(x,...)
Definition: SGIO.h:181
#define SG_REF(x)
Definition: SGObject.h:52
virtual void set_descend_correction(DescendCorrection *correction)
virtual DescendPair get_corrected_descend_direction(float64_t negative_descend_direction, index_t idx)=0
Class SGObject is the base class of all shogun objects.
Definition: SGObject.h:124
double float64_t
Definition: common.h:60
virtual void update_variable(SGVector< float64_t > variable_reference, SGVector< float64_t > raw_negative_descend_direction, float64_t learning_rate)
virtual float64_t get_negative_descend_direction(float64_t variable, float64_t raw_negative_descend_direction, index_t idx, float64_t learning_rate)=0
This is a base class for descend based correction method.
#define SG_UNREF(x)
Definition: SGObject.h:53
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
This is a base class for momentum correction methods.
#define SG_ADD(...)
Definition: SGObject.h:93
index_t vlen
Definition: SGVector.h:571

SHOGUN Machine Learning Toolbox - Documentation