SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
StreamingFeatures.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) 2011 Shashwat Lal Das
8  * Written (W) 2012 Heiko Strathmann
9  * Copyright (C) 2011 Berlin Institute of Technology and Max-Planck-Society
10  */
11 #ifndef _STREAMING_FEATURES__H__
12 #define _STREAMING_FEATURES__H__
13 
14 #include <shogun/lib/config.h>
15 
16 #include <shogun/lib/common.h>
19 
20 namespace shogun
21 {
73 {
74 
75 public:
76 
82 
86  virtual ~CStreamingFeatures();
87 
94  void set_read_functions();
95 
104  virtual void set_vector_reader()=0;
105 
115  virtual void set_vector_and_label_reader()=0;
116 
121  virtual void start_parser()=0;
122 
126  virtual void end_parser()=0;
127 
135  virtual float64_t get_label()=0;
136 
142  virtual bool get_next_example()=0;
143 
149  virtual void release_example()=0;
150 
156  virtual int32_t get_num_features()=0;
157 
163  virtual bool get_has_labels();
164 
175  virtual bool is_seekable();
176 
180  virtual void reset_stream();
181 
191  virtual CFeatures* get_streamed_features(index_t num_elements)
192  {
193  SG_ERROR("%s::get_streamed_features() is not yet implemented!\n",
194  get_name());
195  return NULL;
196  }
197 
198 protected:
199 
202 
205 
207  bool seekable;
208 
209 };
210 }
211 #endif // _STREAMING_FEATURES__H__
virtual const char * get_name() const =0
virtual void start_parser()=0
int32_t index_t
Definition: common.h:62
virtual CFeatures * get_streamed_features(index_t num_elements)
bool has_labels
Whether examples are labelled or not.
#define SG_ERROR(...)
Definition: SGIO.h:129
CStreamingFile * working_file
The StreamingFile object to read from.
A Streaming File access class.
Definition: StreamingFile.h:34
virtual bool get_next_example()=0
virtual void set_vector_and_label_reader()=0
double float64_t
Definition: common.h:50
virtual void set_vector_reader()=0
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
virtual void end_parser()=0
bool seekable
Whether the stream is seekable.
The class Features is the base class of all feature objects.
Definition: Features.h:68
virtual void release_example()=0
Streaming features are features which are used for online algorithms.
virtual float64_t get_label()=0
virtual int32_t get_num_features()=0

SHOGUN Machine Learning Toolbox - Documentation