SHOGUN  4.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
GradientEvaluation.h
Go to the documentation of this file.
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License as published by
4  * the Free Software Foundation; either version 3 of the License, or
5  * (at your option) any later version.
6  *
7  * Written (W) 2013 Roman Votyakov
8  * Copyright (C) 2012 Jacob Walker
9  */
10 
11 #ifndef CGRADIENTEVALUATION_H_
12 #define CGRADIENTEVALUATION_H_
13 
14 #include <shogun/lib/config.h>
15 
19 
20 namespace shogun
21 {
22 
27 {
28 public:
31 
40  CGradientEvaluation(CMachine* machine, CFeatures* features, CLabels* labels,
41  CEvaluation* evaluation_criterion, bool autolock=true);
42 
43  virtual ~CGradientEvaluation();
44 
49  virtual const char* get_name() const { return "GradientEvaluation"; }
50 
55  virtual CEvaluationResult* evaluate();
56 
62  {
63  SG_REF(diff);
64  SG_UNREF(m_diff);
65  m_diff=diff;
66  }
67 
73  {
74  SG_REF(m_diff);
75  return m_diff;
76  }
77 
78 private:
80  void init();
81 
83  void update_parameter_dictionary();
84 
85 private:
88 
90  CMap<TParameter*, CSGObject*>* m_parameter_dictionary;
91 };
92 }
93 #endif /* CGRADIENTEVALUATION_H_ */
The class Labels models labels, i.e. class assignments of objects.
Definition: Labels.h:43
#define SG_REF(x)
Definition: SGObject.h:51
A generic learning machine interface.
Definition: Machine.h:143
virtual CEvaluationResult * evaluate()
Abstract class that contains the result generated by the MachineEvaluation class. ...
An abstract class that describes a differentiable function used for GradientEvaluation.
Machine Evaluation is an abstract class that evaluates a machine according to some criterion...
virtual const char * get_name() const
#define SG_UNREF(x)
Definition: SGObject.h:52
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
The class Features is the base class of all feature objects.
Definition: Features.h:68
Class evaluates a machine using its associated differentiable function for the function value and its...
void set_function(CDifferentiableFunction *diff)
CDifferentiableFunction * get_function()
Class Evaluation, a base class for other classes used to evaluate labels, e.g. accuracy of classifica...
Definition: Evaluation.h:40
the class CMap, a map based on the hash-table. w: http://en.wikipedia.org/wiki/Hash_table ...
Definition: SGObject.h:36

SHOGUN Machine Learning Toolbox - Documentation