SHOGUN  6.1.3
FirstOrderMinimizer.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 FIRSTORDERMINIMIZER_H
33 #define FIRSTORDERMINIMIZER_H
37 namespace shogun
38 {
39 
53 {
54 public:
57  {
58  init();
59  }
60 
65  {
66  init();
67  set_cost_function(fun);
68  }
69 
74  virtual const char* get_name() const { return "FirstOrderMinimizer"; }
75 
77  virtual ~FirstOrderMinimizer();
78 
83  virtual bool supports_batch_update() const=0;
84 
89  virtual void set_cost_function(FirstOrderCostFunction *fun);
90 
94  virtual void unset_cost_function(bool is_unref=true)
95  {
96  if(is_unref)
97  {
98  SG_UNREF(m_fun);
99  }
100  m_fun=NULL;
101  }
102 
107  virtual void set_penalty_weight(float64_t penalty_weight);
108 
114  virtual void set_penalty_type(Penalty* penalty_type);
115 
116 protected:
128 
143  virtual void update_gradient(SGVector<float64_t> gradient, SGVector<float64_t> var);
144 
147 
150 
153 
154 private:
156  void init();
157 };
158 
159 }
160 #endif
virtual void set_penalty_type(Penalty *penalty_type)
FirstOrderCostFunction * m_fun
The base class for penalty/regularization used in minimization.
Definition: Penalty.h:47
virtual void set_penalty_weight(float64_t penalty_weight)
virtual void update_gradient(SGVector< float64_t > gradient, SGVector< float64_t > var)
virtual const char * get_name() const
virtual void unset_cost_function(bool is_unref=true)
double float64_t
Definition: common.h:60
virtual float64_t get_penalty(SGVector< float64_t > var)
FirstOrderMinimizer(FirstOrderCostFunction *fun)
The first order cost function base class.
virtual bool supports_batch_update() const =0
#define SG_UNREF(x)
Definition: SGObject.h:53
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
The minimizer base class.
Definition: Minimizer.h:43
virtual void set_cost_function(FirstOrderCostFunction *fun)
The first order minimizer base class.

SHOGUN Machine Learning Toolbox - Documentation