SHOGUN  v3.2.0
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 
17 
18 namespace shogun
19 {
20 
25 {
26 public:
29 
38  CGradientEvaluation(CMachine* machine, CFeatures* features, CLabels* labels,
39  CEvaluation* evaluation_criterion, bool autolock=true);
40 
41  virtual ~CGradientEvaluation();
42 
47  virtual const char* get_name() const { return "GradientEvaluation"; }
48 
53  virtual CEvaluationResult* evaluate();
54 
60  {
61  SG_REF(diff);
62  SG_UNREF(m_diff);
63  m_diff=diff;
64  }
65 
71  {
72  SG_REF(m_diff);
73  return m_diff;
74  }
75 
76 private:
78  void init();
79 
81  void update_parameter_dictionary();
82 
83 private:
86 
88  CMap<TParameter*, CSGObject*>* m_parameter_dictionary;
89 };
90 }
91 #endif /* CGRADIENTEVALUATION_H_ */
The class Labels models labels, i.e. class assignments of objects.
Definition: Labels.h:35
#define SG_UNREF(x)
Definition: SGRefObject.h:35
A generic learning machine interface.
Definition: Machine.h:138
virtual CEvaluationResult * evaluate()
virtual const char * get_name() const
#define SG_REF(x)
Definition: SGRefObject.h:34
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...
the class CMap, a map based on the hash-table. w: http://en.wikipedia.org/wiki/Hash_table ...
Definition: SGObject.h:40
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:16
The class Features is the base class of all feature objects.
Definition: Features.h:62
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:35

SHOGUN Machine Learning Toolbox - Documentation