SHOGUN  v3.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Machine.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) 1999-2009 Soeren Sonnenburg
8  * Written (W) 2011-2012 Heiko Strathmann
9  * Copyright (C) 1999-2009 Fraunhofer Institute FIRST and Max-Planck-Society
10  */
11 
12 #ifndef _MACHINE_H__
13 #define _MACHINE_H__
14 
15 #include <shogun/lib/common.h>
16 #include <shogun/base/SGObject.h>
17 #include <shogun/labels/Labels.h>
24 
25 namespace shogun
26 {
27 
28 class CFeatures;
29 class CLabels;
30 class CMath;
31 
34 {
35  CT_NONE = 0,
36  CT_LIGHT = 10,
38  CT_LIBSVM = 20,
41  CT_MPD = 50,
42  CT_GPBT = 60,
46  CT_LDA = 100,
47  CT_LPM = 110,
48  CT_LPBOOST = 120,
49  CT_KNN = 130,
50  CT_SVMLIN=140,
52  CT_GNPPSVM = 160,
53  CT_GMNPSVM = 170,
54  CT_SVMPERF = 200,
55  CT_LIBSVR = 210,
56  CT_SVRLIGHT = 220,
57  CT_LIBLINEAR = 230,
58  CT_KMEANS = 240,
60  CT_SVMOCAS = 260,
61  CT_WDSVMOCAS = 270,
62  CT_SVMSGD = 280,
68  CT_DASVM = 340,
69  CT_LARANK = 350,
73  CT_SGDQN = 390,
77  CT_QDA = 430,
78  CT_NEWTONSVM = 440,
80  CT_LARS = 460,
86  CT_CCSOSVM = 520,
90 };
91 
94 {
102 };
103 
106 {
112 };
113 
114 #define MACHINE_PROBLEM_TYPE(PT) \
115  \
118  virtual EProblemType get_machine_problem_type() const { return PT; }
119 
137 class CMachine : public CSGObject
138 {
139  public:
141  CMachine();
142 
144  virtual ~CMachine();
145 
155  virtual bool train(CFeatures* data=NULL);
156 
163  virtual CLabels* apply(CFeatures* data=NULL);
164 
166  virtual CBinaryLabels* apply_binary(CFeatures* data=NULL);
168  virtual CRegressionLabels* apply_regression(CFeatures* data=NULL);
170  virtual CMulticlassLabels* apply_multiclass(CFeatures* data=NULL);
172  virtual CStructuredLabels* apply_structured(CFeatures* data=NULL);
174  virtual CLatentLabels* apply_latent(CFeatures* data=NULL);
175 
180  virtual void set_labels(CLabels* lab);
181 
186  virtual CLabels* get_labels();
187 
193 
199 
205 
210  void set_solver_type(ESolverType st);
211 
217 
223  virtual void set_store_model_features(bool store_model);
224 
233  virtual bool train_locked(SGVector<index_t> indices)
234  {
235  SG_ERROR("train_locked(SGVector<index_t>) is not yet implemented "
236  "for %s\n", get_name());
237  return false;
238  }
241  virtual float64_t apply_one(int32_t i)
242  {
244  return 0.0;
245  }
246 
252  virtual CLabels* apply_locked(SGVector<index_t> indices);
253 
256  SGVector<index_t> indices);
259  SGVector<index_t> indices);
262  SGVector<index_t> indices);
265  SGVector<index_t> indices);
268  SGVector<index_t> indices);
269 
278  virtual void data_lock(CLabels* labs, CFeatures* features);
281  virtual void post_lock(CLabels* labs, CFeatures* features) { };
282 
284  virtual void data_unlock();
287  virtual bool supports_locking() const { return false; }
290  bool is_data_locked() const { return m_data_locked; }
293  virtual EProblemType get_machine_problem_type() const
294  {
296  return PT_BINARY;
297  }
298 
299  virtual const char* get_name() const { return "Machine"; }
300 
301  protected:
312  virtual bool train_machine(CFeatures* data=NULL)
313  {
314  SG_ERROR("train_machine is not yet implemented for %s!\n",
315  get_name());
316  return false;
317  }
318 
329  virtual void store_model_features()
330  {
331  SG_ERROR("Model storage and therefore unlocked Cross-Validation and"
332  " Model-Selection is not supported for %s. Locked may"
333  " work though.\n", get_name());
334  }
335 
342  virtual bool is_label_valid(CLabels *lab) const
343  {
344  return true;
345  }
348  virtual bool train_require_labels() const { return true; }
349 
350  protected:
355  CLabels* m_labels;
364  bool m_data_locked;
365 };
366 }
367 #endif // _MACHINE_H__

SHOGUN Machine Learning Toolbox - Documentation