SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CStreamingVwCacheFile Class Reference

Detailed Description

Class StreamingVwCacheFile to read vector-by-vector from VW cache files.

The cache file is usually generated either by VW or by enabling the cache writing option in a CStreamingVwFile object.

This class reads the example and label into one object of VwExample type.

Definition at line 32 of file StreamingVwCacheFile.h.

Inheritance diagram for CStreamingVwCacheFile:
Inheritance graph
[legend]

Public Member Functions

 CStreamingVwCacheFile ()
 
 CStreamingVwCacheFile (EVwCacheType cache_type)
 
 CStreamingVwCacheFile (char *fname, char rw='r', EVwCacheType cache_type=C_NATIVE)
 
virtual ~CStreamingVwCacheFile ()
 
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
 
void set_env (CVwEnvironment *env_to_use)
 
CVwEnvironment * get_env ()
 
bool is_seekable ()
 
void reset_stream ()
 
void close ()
 
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

CVwCacheReader * cache_reader
 Cache reader. More...
 
CVwEnvironment * env
 Environment used for vw. More...
 
EVwCacheType cache_format
 Cache type. More...
 
CIOBuffer * buf
 Buffer to hold stuff in memory. More...
 
char task
 Task. More...
 
char * filename
 Name of the handled file. More...
 

Constructor & Destructor Documentation

CStreamingVwCacheFile ( )

Default constructor. Assumes cache file is of type C_NATIVE

Definition at line 14 of file StreamingVwCacheFile.cpp.

CStreamingVwCacheFile ( EVwCacheType  cache_type)

Constructor taking cache type as an argument.

Parameters
cache_typecache type - C_NATIVE or C_PROTOBUF

Definition at line 21 of file StreamingVwCacheFile.cpp.

CStreamingVwCacheFile ( char *  fname,
char  rw = 'r',
EVwCacheType  cache_type = C_NATIVE 
)

Constructor taking file name and cache type as arguments

Parameters
fnamefile name
rwread/write mode
cache_typetype of cache - C_NATIVE or C_PROTOBUF

Definition at line 27 of file StreamingVwCacheFile.cpp.

~CStreamingVwCacheFile ( )
virtual

Destructor

Definition at line 33 of file StreamingVwCacheFile.cpp.

Member Function Documentation

void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject * > *  dict)
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.

Parameters
dictdictionary of parameters to be built.

Definition at line 597 of file SGObject.cpp.

CSGObject * clone ( )
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.

Returns
an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed

Definition at line 714 of file SGObject.cpp.

void close ( )
inherited

Closes the file

Definition at line 54 of file StreamingFile.h.

CSGObject * deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

Definition at line 198 of file SGObject.cpp.

bool equals ( CSGObject *  other,
float64_t  accuracy = 0.0,
bool  tolerant = false 
)
virtualinherited

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.

Parameters
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 618 of file SGObject.cpp.

CVwEnvironment* get_env ( )

Return the environment

Returns
environment as CVwEnvironment*

Definition at line 104 of file StreamingVwCacheFile.h.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 235 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 277 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 290 of file SGObject.cpp.

SGStringList< char > get_modelsel_names ( )
inherited
Returns
vector of names of all parameters which are registered for model selection

Definition at line 498 of file SGObject.cpp.

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

Parameters
param_namename of the parameter
Returns
description of the parameter

Definition at line 522 of file SGObject.cpp.

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

Parameters
param_namename of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 535 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual
Returns
object name

Reimplemented from CStreamingFile.

Definition at line 87 of file StreamingVwCacheFile.h.

virtual void get_sparse_vector ( SGSparseVectorEntry< bool > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< uint8_t > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< char > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< int32_t > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< float32_t > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< float64_t > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< int16_t > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< uint16_t > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< int8_t > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< uint32_t > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< int64_t > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< uint64_t > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector ( SGSparseVectorEntry< floatmax_t > *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< bool > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< uint8_t > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< char > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< int32_t > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< float32_t > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< float64_t > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< int16_t > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< uint16_t > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< int8_t > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< uint32_t > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< int64_t > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< uint64_t > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_sparse_vector_and_label ( SGSparseVectorEntry< floatmax_t > *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string ( bool *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string ( uint8_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string ( char *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string ( int32_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string ( float32_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string ( float64_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string ( int16_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string ( uint16_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string ( int8_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string ( uint32_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string ( int64_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string ( uint64_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string ( floatmax_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_string_and_label ( bool *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string_and_label ( uint8_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string_and_label ( char *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string_and_label ( int32_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string_and_label ( float32_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string_and_label ( float64_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string_and_label ( int16_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string_and_label ( uint16_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string_and_label ( int8_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string_and_label ( uint32_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string_and_label ( int64_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string_and_label ( uint64_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_string_and_label ( floatmax_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
void get_vector ( VwExample *&  ex,
int32_t &  len 
)
virtual

Returns the parsed example.

The example contains the label if available, and also contains length of the feature vector. These parameters, passed separately are redundant.

Parameters
exexamples as VwExample*, set by reference
lenlength of vector, untouched

Reimplemented from CStreamingFile.

Definition at line 39 of file StreamingVwCacheFile.cpp.

virtual void get_vector ( bool *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_vector ( uint8_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_vector ( char *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_vector ( int32_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_vector ( float32_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_vector ( float64_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_vector ( int16_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_vector ( uint16_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_vector ( int8_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_vector ( uint32_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_vector ( int64_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_vector ( uint64_t *&  vector,
int32_t &  len 
)
virtualinherited
virtual void get_vector ( floatmax_t *&  vector,
int32_t &  len 
)
virtualinherited
void get_vector_and_label ( VwExample *&  ex,
int32_t &  len,
float64_t &  label 
)
virtual

Returns the parsed example.

TODO: Make this fail if examples are found to be unlabelled.

Parameters
exexample as VwExample*, set by reference
lenlength of vector, untouched
labellabel, untouched

Reimplemented from CStreamingFile.

Definition at line 47 of file StreamingVwCacheFile.cpp.

virtual void get_vector_and_label ( bool *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_vector_and_label ( uint8_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_vector_and_label ( char *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_vector_and_label ( int32_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_vector_and_label ( float32_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_vector_and_label ( float64_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_vector_and_label ( int16_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_vector_and_label ( uint16_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_vector_and_label ( int8_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_vector_and_label ( uint32_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_vector_and_label ( int64_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_vector_and_label ( uint64_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
virtual void get_vector_and_label ( floatmax_t *&  vector,
int32_t &  len,
float64_t &  label 
)
virtualinherited
bool is_generic ( EPrimitiveType *  generic) const
virtualinherited

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

Parameters
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 296 of file SGObject.cpp.

bool is_seekable ( )
virtual

Whether this stream is seekable

Returns
true, since caches can be reset

Reimplemented from CStreamingFile.

Definition at line 115 of file StreamingVwCacheFile.h.

bool load_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

Parameters
filewhere to load from
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 369 of file SGObject.cpp.

void load_serializable_post ( )
throw (ShogunException
)
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.

Exceptions
ShogunExceptionwill 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.

void load_serializable_pre ( )
throw (ShogunException
)
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.

Exceptions
ShogunExceptionwill 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.

bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 262 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 474 of file SGObject.cpp.

void print_serializable ( const char *  prefix = "")
virtualinherited

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 308 of file SGObject.cpp.

void reset_stream ( )
virtual

Reset cache file back to first example.

Used when multiple passes are to be performed

Reimplemented from CStreamingFile.

Definition at line 75 of file StreamingVwCacheFile.cpp.

bool save_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
virtualinherited

Save this object to file.

Parameters
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 314 of file SGObject.cpp.

void save_serializable_post ( )
throw (ShogunException
)
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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 436 of file SGObject.cpp.

void save_serializable_pre ( )
throw (ShogunException
)
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.

Exceptions
ShogunExceptionwill 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.

void set_env ( CVwEnvironment *  env_to_use)

Set environment for vw

Parameters
env_to_useCVwEnvironment* environment

Definition at line 55 of file StreamingVwCacheFile.cpp.

void set_generic ( )
inherited

Definition at line 41 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 46 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 51 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 56 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 61 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 66 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 71 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 76 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 81 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 86 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 91 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 96 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 101 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 106 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 111 of file SGObject.cpp.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO *  io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 228 of file SGObject.cpp.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version *  version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 283 of file SGObject.cpp.

CSGObject * shallow_copy ( ) const
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.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 303 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 248 of file SGObject.cpp.

Member Data Documentation

CIOBuffer* buf
protectedinherited

Buffer to hold stuff in memory.

Definition at line 293 of file StreamingFile.h.

EVwCacheType cache_format
protected

Cache type.

Definition at line 140 of file StreamingVwCacheFile.h.

CVwCacheReader* cache_reader
protected

Cache reader.

Definition at line 134 of file StreamingVwCacheFile.h.

CVwEnvironment* env
protected

Environment used for vw.

Definition at line 137 of file StreamingVwCacheFile.h.

char* filename
protectedinherited

Name of the handled file.

Definition at line 297 of file StreamingFile.h.

SGIO* io
inherited

io

Definition at line 369 of file SGObject.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 384 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 387 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 381 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 378 of file SGObject.h.

Parallel* parallel
inherited

parallel

Definition at line 372 of file SGObject.h.

char task
protectedinherited

Task.

Definition at line 295 of file StreamingFile.h.

Version* version
inherited

version

Definition at line 375 of file SGObject.h.

The documentation for this class was generated from the following files:
SHOGUN Machine Learning Toolbox - Documentation