SHOGUN
4.1.0
|
A Streaming File access class.
Definition at line 34 of file StreamingFile.h.
Public Member Functions | |
CStreamingFile () | |
CStreamingFile (const char *fname, char rw='r') | |
virtual | ~CStreamingFile () |
void | close () |
virtual bool | is_seekable () |
virtual void | reset_stream () |
virtual void | get_vector (VwExample *&ex, int32_t &len) |
virtual void | get_vector_and_label (VwExample *&ex, int32_t &len, float64_t &label) |
virtual const char * | get_name () const |
virtual CSGObject * | shallow_copy () const |
virtual CSGObject * | deep_copy () const |
virtual bool | is_generic (EPrimitiveType *generic) const |
template<class T > | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
void | unset_generic () |
virtual void | print_serializable (const char *prefix="") |
virtual bool | save_serializable (CSerializableFile *file, const char *prefix="") |
virtual bool | load_serializable (CSerializableFile *file, const char *prefix="") |
void | set_global_io (SGIO *io) |
SGIO * | get_global_io () |
void | set_global_parallel (Parallel *parallel) |
Parallel * | get_global_parallel () |
void | set_global_version (Version *version) |
Version * | get_global_version () |
SGStringList< char > | get_modelsel_names () |
void | print_modsel_params () |
char * | get_modsel_param_descr (const char *param_name) |
index_t | get_modsel_param_index (const char *param_name) |
void | build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict) |
virtual void | update_parameter_hash () |
virtual bool | parameter_hash_changed () |
virtual bool | equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false) |
virtual CSGObject * | clone () |
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) |
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) |
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) |
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) |
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) |
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) |
Public Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
Parameter * | m_gradient_parameters |
uint32_t | m_hash |
Protected Member Functions | |
virtual void | load_serializable_pre () throw (ShogunException) |
virtual void | load_serializable_post () throw (ShogunException) |
virtual void | save_serializable_pre () throw (ShogunException) |
virtual void | save_serializable_post () throw (ShogunException) |
Protected Attributes | |
CIOBuffer * | buf |
Buffer to hold stuff in memory. More... | |
char | task |
Task. More... | |
char * | filename |
Name of the handled file. More... | |
CStreamingFile | ( | ) |
default constructor
Definition at line 196 of file StreamingFile.cpp.
CStreamingFile | ( | const char * | fname, |
char | rw = 'r' |
||
) |
constructor
fname | filename to open |
rw | mode, 'r' or 'w' |
Definition at line 202 of file StreamingFile.cpp.
|
virtual |
default destructor
Definition at line 233 of file StreamingFile.cpp.
|
inherited |
Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.
dict | dictionary of parameters to be built. |
Definition at line 597 of file SGObject.cpp.
|
virtualinherited |
Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.
Definition at line 714 of file SGObject.cpp.
void close | ( | ) |
Closes the file
Definition at line 54 of file StreamingFile.h.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 198 of file SGObject.cpp.
Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!
May be overwritten but please do with care! Should not be necessary in most cases.
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
tolerant | allows linient check on float equality (within accuracy) |
Definition at line 618 of file SGObject.cpp.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Definition at line 498 of file SGObject.cpp.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
Definition at line 522 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 535 of file SGObject.cpp.
|
virtual |
Implements CSGObject.
Reimplemented in CStreamingVwFile, CStreamingAsciiFile, CStreamingFileFromFeatures, CStreamingVwCacheFile, CStreamingFileFromDenseFeatures< T >, CStreamingFileFromSparseFeatures< T >, and CStreamingFileFromStringFeatures< T >.
Definition at line 288 of file StreamingFile.h.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Function to read VW examples without labels
ex | example |
len | length of feature vector |
Reimplemented in CStreamingVwCacheFile, and CStreamingVwFile.
Definition at line 183 of file StreamingFile.cpp.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Function to read VW examples with labels
ex | example |
len | length of feature vector |
label | label |
Reimplemented in CStreamingVwCacheFile, and CStreamingVwFile.
Definition at line 188 of file StreamingFile.cpp.
|
virtualinherited |
If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.
generic | set to the type of the generic if returning TRUE |
Definition at line 296 of file SGObject.cpp.
|
virtual |
Whether the stream is seekable/resettable
Reimplemented in CStreamingVwFile, and CStreamingVwCacheFile.
Definition at line 64 of file StreamingFile.h.
|
virtualinherited |
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
file | where to load from |
prefix | prefix for members |
Definition at line 369 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 426 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 421 of file SGObject.cpp.
|
virtualinherited |
Definition at line 262 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 474 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 308 of file SGObject.cpp.
|
virtual |
Reset the stream, should be overloaded if possible
Reimplemented in CStreamingVwCacheFile, CStreamingFileFromDenseFeatures< T >, CStreamingFileFromSparseFeatures< T >, and CStreamingFileFromStringFeatures< T >.
Definition at line 69 of file StreamingFile.h.
|
virtualinherited |
Save this object to file.
file | where to save the object; will be closed during returning if PREFIX is an empty string. |
prefix | prefix for members |
Definition at line 314 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel.
Definition at line 436 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 431 of file SGObject.cpp.
|
inherited |
Definition at line 41 of file SGObject.cpp.
|
inherited |
Definition at line 46 of file SGObject.cpp.
|
inherited |
Definition at line 51 of file SGObject.cpp.
|
inherited |
Definition at line 56 of file SGObject.cpp.
|
inherited |
Definition at line 61 of file SGObject.cpp.
|
inherited |
Definition at line 66 of file SGObject.cpp.
|
inherited |
Definition at line 71 of file SGObject.cpp.
|
inherited |
Definition at line 76 of file SGObject.cpp.
|
inherited |
Definition at line 81 of file SGObject.cpp.
|
inherited |
Definition at line 86 of file SGObject.cpp.
|
inherited |
Definition at line 91 of file SGObject.cpp.
|
inherited |
Definition at line 96 of file SGObject.cpp.
|
inherited |
Definition at line 101 of file SGObject.cpp.
|
inherited |
Definition at line 106 of file SGObject.cpp.
|
inherited |
Definition at line 111 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 241 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 283 of file SGObject.cpp.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 192 of file SGObject.cpp.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 303 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 248 of file SGObject.cpp.
|
protected |
Buffer to hold stuff in memory.
Definition at line 293 of file StreamingFile.h.
|
protected |
Name of the handled file.
Definition at line 297 of file StreamingFile.h.
|
inherited |
io
Definition at line 369 of file SGObject.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 384 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 387 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 381 of file SGObject.h.
|
inherited |
parameters
Definition at line 378 of file SGObject.h.
|
inherited |
parallel
Definition at line 372 of file SGObject.h.
|
protected |
Task.
Definition at line 295 of file StreamingFile.h.
|
inherited |
version
Definition at line 375 of file SGObject.h.