/usr/include/shogun/io/StreamingFile.h is in libshogun-dev 1.1.0-4ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 | /*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* Written (W) 2011 Shashwat Lal Das
* Copyright (C) 2011 Berlin Institute of Technology and Max-Planck-Society
*/
#ifndef __STREAMING_FILE_H__
#define __STREAMING_FILE_H__
#include <shogun/lib/config.h>
#include <shogun/base/DynArray.h>
#include <shogun/lib/common.h>
#include <shogun/io/File.h>
#include <shogun/io/SGIO.h>
#include <shogun/lib/DataType.h>
#include <shogun/io/IOBuffer.h>
#include <shogun/classifier/vw/vw_common.h>
#include <ctype.h>
#include <fcntl.h>
#include <unistd.h>
namespace shogun
{
/** @brief A Streaming File access class.
*
* - Vectors are read as one vector per line
* - NOT YET IMPLEMENTED:
* - Matrices are written out as one column per line
* - Sparse Matrices are written out as one column per line (libsvm/svmlight
* style format)
* - Strings are written out as one string per line
*
*/
class CStreamingFile: public CSGObject
{
public:
/** default constructor */
CStreamingFile();
/** constructor
*
* @param fname filename to open
* @param rw mode, 'r' or 'w'
*/
CStreamingFile(char* fname, char rw='r');
/** default destructor */
virtual ~CStreamingFile();
/**
* Closes the file
*/
void close()
{
buf->close_file();
}
/**
* Whether the stream is seekable/resettable
*
* @return false by default, unless overloaded
*/
inline virtual bool is_seekable() { return false; }
/**
* Reset the stream, should be overloaded if possible
*/
virtual void reset_stream() { SG_ERROR("Unable to reset the input stream!\n"); }
/** @name Dense Vector Access Functions
*
* Functions to access dense vectors of one of several
* base data types. These functions are used when
* reading one dense vector at a time from an input
* source and return the vector and length of the
* vector by reference.
*/
//@{
virtual void get_vector(bool*& vector, int32_t& len);
virtual void get_vector(uint8_t*& vector, int32_t& len);
virtual void get_vector(char*& vector, int32_t& len);
virtual void get_vector(int32_t*& vector, int32_t& len);
virtual void get_vector(float32_t*& vector, int32_t& len);
virtual void get_vector(float64_t*& vector, int32_t& len);
virtual void get_vector(int16_t*& vector, int32_t& len);
virtual void get_vector(uint16_t*& vector, int32_t& len);
virtual void get_vector(int8_t*& vector, int32_t& len);
virtual void get_vector(uint32_t*& vector, int32_t& len);
virtual void get_vector(int64_t*& vector, int32_t& len);
virtual void get_vector(uint64_t*& vector, int32_t& len);
virtual void get_vector(floatmax_t*& vector, int32_t& len);
//@}
/** @name Dense Vector And Label Access Functions
*
* Functions to access dense vectors of one of several
* base data types. These functions are used when
* reading one dense vector at a time from an input
* source and return the vector, length and label of
* the vector by reference.
*/
//@{
virtual void get_vector_and_label
(bool*& vector, int32_t& len, float64_t& label);
virtual void get_vector_and_label
(uint8_t*& vector, int32_t& len, float64_t& label);
virtual void get_vector_and_label
(char*& vector, int32_t& len, float64_t& label);
virtual void get_vector_and_label
(int32_t*& vector, int32_t& len, float64_t& label);
virtual void get_vector_and_label
(float32_t*& vector, int32_t& len, float64_t& label);
virtual void get_vector_and_label
(float64_t*& vector, int32_t& len, float64_t& label);
virtual void get_vector_and_label
(int16_t*& vector, int32_t& len, float64_t& label);
virtual void get_vector_and_label
(uint16_t*& vector, int32_t& len, float64_t& label);
virtual void get_vector_and_label
(int8_t*& vector, int32_t& len, float64_t& label);
virtual void get_vector_and_label
(uint32_t*& vector, int32_t& len, float64_t& label);
virtual void get_vector_and_label
(int64_t*& vector, int32_t& len, float64_t& label);
virtual void get_vector_and_label
(uint64_t*& vector, int32_t& len, float64_t& label);
virtual void get_vector_and_label
(floatmax_t*& vector, int32_t& len, float64_t& label);
//@}
/** @name String Access Functions
*
* Functions to access string of one of several base
* data types. These functions are used when reading
* one string vector at a time from an input source
* and return the vector and length of the vector by
* reference.
*/
//@{
virtual void get_string(bool*& vector, int32_t& len);
virtual void get_string(uint8_t*& vector, int32_t& len);
virtual void get_string(char*& vector, int32_t& len);
virtual void get_string(int32_t*& vector, int32_t& len);
virtual void get_string(float32_t*& vector, int32_t& len);
virtual void get_string(float64_t*& vector, int32_t& len);
virtual void get_string(int16_t*& vector, int32_t& len);
virtual void get_string(uint16_t*& vector, int32_t& len);
virtual void get_string(int8_t*& vector, int32_t& len);
virtual void get_string(uint32_t*& vector, int32_t& len);
virtual void get_string(int64_t*& vector, int32_t& len);
virtual void get_string(uint64_t*& vector, int32_t& len);
virtual void get_string(floatmax_t*& vector, int32_t& len);
//@}
/** @name String And Label Access Functions
*
* Functions to access strings of one of several
* base data types. These functions are used when
* reading one string vector at a time from an input
* source and return the vector, length and label of the
* vector by reference.
*/
//@{
virtual void get_string_and_label
(bool*& vector, int32_t& len, float64_t& label);
virtual void get_string_and_label
(uint8_t*& vector, int32_t& len, float64_t& label);
virtual void get_string_and_label
(char*& vector, int32_t& len, float64_t& label);
virtual void get_string_and_label
(int32_t*& vector, int32_t& len, float64_t& label);
virtual void get_string_and_label
(float32_t*& vector, int32_t& len, float64_t& label);
virtual void get_string_and_label
(float64_t*& vector, int32_t& len, float64_t& label);
virtual void get_string_and_label
(int16_t*& vector, int32_t& len, float64_t& label);
virtual void get_string_and_label
(uint16_t*& vector, int32_t& len, float64_t& label);
virtual void get_string_and_label
(int8_t*& vector, int32_t& len, float64_t& label);
virtual void get_string_and_label
(uint32_t*& vector, int32_t& len, float64_t& label);
virtual void get_string_and_label
(int64_t*& vector, int32_t& len, float64_t& label);
virtual void get_string_and_label
(uint64_t*& vector, int32_t& len, float64_t& label);
virtual void get_string_and_label
(floatmax_t*& vector, int32_t& len, float64_t& label);
//@}
/** @name Sparse Vector Access Functions
*
* Functions to access sparse vectors of one of
* several base data types. These functions are used
* when reading one sparse vector at a time from an
* input source and return the vector and length of
* the vector by reference.
*/
//@{
virtual void get_sparse_vector
(SGSparseVectorEntry<bool>*& vector, int32_t& len);
virtual void get_sparse_vector
(SGSparseVectorEntry<uint8_t>*& vector, int32_t& len);
virtual void get_sparse_vector
(SGSparseVectorEntry<char>*& vector, int32_t& len);
virtual void get_sparse_vector
(SGSparseVectorEntry<int32_t>*& vector, int32_t& len);
virtual void get_sparse_vector
(SGSparseVectorEntry<float32_t>*& vector, int32_t& len);
virtual void get_sparse_vector
(SGSparseVectorEntry<float64_t>*& vector, int32_t& len);
virtual void get_sparse_vector
(SGSparseVectorEntry<int16_t>*& vector, int32_t& len);
virtual void get_sparse_vector
(SGSparseVectorEntry<uint16_t>*& vector, int32_t& len);
virtual void get_sparse_vector
(SGSparseVectorEntry<int8_t>*& vector, int32_t& len);
virtual void get_sparse_vector
(SGSparseVectorEntry<uint32_t>*& vector, int32_t& len);
virtual void get_sparse_vector
(SGSparseVectorEntry<int64_t>*& vector, int32_t& len);
virtual void get_sparse_vector
(SGSparseVectorEntry<uint64_t>*& vector, int32_t& len);
virtual void get_sparse_vector
(SGSparseVectorEntry<floatmax_t>*& vector, int32_t& len);
//@}
/** @name Sparse Vector And Label Access Functions
*
* Functions to access sparse vectors of one of
* several base data types. These functions are used
* when reading one sparse vector at a time from an
* input source and return the vector, length and
* label of the vector by reference.
*/
//@{
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<bool>*& vector, int32_t& len, float64_t& label);
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<uint8_t>*& vector, int32_t& len, float64_t& label);
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<char>*& vector, int32_t& len, float64_t& label);
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<int32_t>*& vector, int32_t& len, float64_t& label);
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<float32_t>*& vector, int32_t& len, float64_t& label);
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<float64_t>*& vector, int32_t& len, float64_t& label);
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<int16_t>*& vector, int32_t& len, float64_t& label);
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<uint16_t>*& vector, int32_t& len, float64_t& label);
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<int8_t>*& vector, int32_t& len, float64_t& label);
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<uint32_t>*& vector, int32_t& len, float64_t& label);
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<int64_t>*& vector, int32_t& len, float64_t& label);
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<uint64_t>*& vector, int32_t& len, float64_t& label);
virtual void get_sparse_vector_and_label
(SGSparseVectorEntry<floatmax_t>*& vector, int32_t& len, float64_t& label);
//@}
/**
* Function to read VW examples without labels
*
* @param ex example
* @param len length of feature vector
*/
virtual void get_vector(VwExample*& ex, int32_t& len);
/**
* Function to read VW examples with labels
*
* @param ex example
* @param len length of feature vector
* @param label label
*/
virtual void get_vector_and_label(VwExample*& ex, int32_t& len, float64_t& label);
/** @return object name */
inline virtual const char* get_name() const { return "StreamingFile"; }
protected:
/// Buffer to hold stuff in memory
CIOBuffer* buf;
/// Task
char task;
/// Name of the handled file
char* filename;
};
}
#endif //__STREAMING_FILE_H__
|