SHOGUN  4.2.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
CVwParser Class Reference

Detailed Description

CVwParser is the object which provides the functions to parse examples from buffered input.

An instance of this class can be created in CStreamingVwFile and the appropriate read_*_features function called to parse examples from different formats.

It also encapsulates a CVwCacheWriter object which may be used in case a cache file is to be generated simultaneously with parsing.

Definition at line 48 of file VwParser.h.

Inheritance diagram for CVwParser:
[legend]

Public Member Functions

 CVwParser ()
 
 CVwParser (CVwEnvironment *env_to_use)
 
virtual ~CVwParser ()
 
CVwEnvironment * get_env ()
 
void set_env (CVwEnvironment *env_to_use)
 
void set_cache_parameters (char *fname, EVwCacheType type=C_NATIVE)
 
EVwCacheType get_cache_type ()
 
void set_write_cache (bool wr_cache)
 
bool get_write_cache ()
 
void set_mm (float64_t label)
 
void noop_mm (float64_t label)
 
void set_minmax (float64_t label)
 
int32_t read_features (CIOBuffer *buf, VwExample *&ex)
 
int32_t read_svmlight_features (CIOBuffer *buf, VwExample *&ae)
 
int32_t read_dense_features (CIOBuffer *buf, VwExample *&ae)
 
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)
 
bool has (const std::string &name) const
 
template<typename T >
bool has (const Tag< T > &tag) const
 
template<typename T , typename U = void>
bool has (const std::string &name) const
 
template<typename T >
void set (const Tag< T > &_tag, const T &value)
 
template<typename T , typename U = void>
void set (const std::string &name, const T &value)
 
template<typename T >
T get (const Tag< T > &_tag) const
 
template<typename T , typename U = void>
T get (const std::string &name) const
 
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 ()
 

Public Attributes

hash_func_t hasher
 Hash function to use, of type hash_func_t. More...
 
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

void init_cache (char *fname, EVwCacheType type=C_NATIVE)
 
void feature_value (substring &s, v_array< substring > &name, float32_t &v)
 
void tokenize (char delim, substring s, v_array< substring > &ret)
 
char * safe_index (char *start, char v, char *max)
 
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)
 
template<typename T >
void register_param (Tag< T > &_tag, const T &value)
 
template<typename T >
void register_param (const std::string &name, const T &value)
 

Protected Attributes

CVwEnvironment * env
 Environment of VW - used by parser. More...
 
CVwCacheWriter * cache_writer
 Object which will be used for writing cache. More...
 
EVwCacheType cache_type
 Type of cache. More...
 
bool write_cache
 Whether to write cache or not. More...
 

Constructor & Destructor Documentation

CVwParser ( )

Default constructor

Definition at line 21 of file VwParser.cpp.

CVwParser ( CVwEnvironment *  env_to_use)

Constructor taking environment as parameter.

Parameters
env_to_useCVwEnvironment to use

Definition at line 31 of file VwParser.cpp.

~CVwParser ( )
virtual

Destructor

Definition at line 48 of file VwParser.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 630 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 747 of file SGObject.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 231 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 651 of file SGObject.cpp.

void feature_value ( substring &  s,
v_array< substring > &  name,
float32_t &  v 
)
protected

Get value of feature from a given substring. A default of 1 is assumed if no explicit value is specified.

Parameters
ssubstring, usually a feature:value string
namereturned array of substrings, split into name and value
vvalue of feature, set by reference

Definition at line 277 of file VwParser.cpp.

T get ( const Tag< T > &  _tag) const
inherited

Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
_tagname and type information of parameter
Returns
value of the parameter identified by the input tag

Definition at line 367 of file SGObject.h.

T get ( const std::string &  name) const
inherited

Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
namename of the parameter
Returns
value of the parameter corresponding to the input name and type

Definition at line 388 of file SGObject.h.

EVwCacheType get_cache_type ( )

Return the type of cache

Returns
cache type as EVwCacheType

Definition at line 109 of file VwParser.h.

CVwEnvironment* get_env ( )

Get the environment

Returns
environment as CVwEnvironment*

Definition at line 73 of file VwParser.h.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 268 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 310 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 323 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 531 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 555 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 568 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual

Return the name of the object

Returns
VwParser

Implements CSGObject.

Definition at line 205 of file VwParser.h.

bool get_write_cache ( )

Return whether cache will be written or not

Returns
will cache be written?

Definition at line 134 of file VwParser.h.

bool has ( const std::string &  name) const
inherited

Checks if object has a class parameter identified by a name.

Parameters
namename of the parameter
Returns
true if the parameter exists with the input name

Definition at line 289 of file SGObject.h.

bool has ( const Tag< T > &  tag) const
inherited

Checks if object has a class parameter identified by a Tag.

Parameters
tagtag of the parameter containing name and type information
Returns
true if the parameter exists with the input tag

Definition at line 301 of file SGObject.h.

bool has ( const std::string &  name) const
inherited

Checks if a type exists for a class parameter identified by a name.

Parameters
namename of the parameter
Returns
true if the parameter exists with the input name and type

Definition at line 312 of file SGObject.h.

void init_cache ( char *  fname,
EVwCacheType  type = C_NATIVE 
)
protected

Initialize the cache writer

Parameters
fnamecache file name
typecache type as EVwCacheType, default is C_NATIVE

Definition at line 254 of file VwParser.cpp.

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 329 of file SGObject.cpp.

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 402 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 459 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 454 of file SGObject.cpp.

void noop_mm ( float64_t  label)

A dummy function performing no operation in case training is not to be performed.

Parameters
labellabel

Definition at line 157 of file VwParser.h.

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

Definition at line 295 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 507 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 341 of file SGObject.cpp.

int32_t read_dense_features ( CIOBuffer *  buf,
VwExample *&  ae 
)

Read an example from a file with dense vectors

Parameters
bufIOBuffer which contains input
aeparsed example
Returns
number of characters read for this example

Definition at line 212 of file VwParser.cpp.

int32_t read_features ( CIOBuffer *  buf,
VwExample *&  ex 
)

Reads input from the buffer and parses it into a VwExample

Parameters
bufIOBuffer which contains input
exparsed example
Returns
number of characters read for this example

Definition at line 54 of file VwParser.cpp.

int32_t read_svmlight_features ( CIOBuffer *  buf,
VwExample *&  ae 
)

Read an example from an SVMLight file

Parameters
bufIOBuffer which contains input
aeparsed example
Returns
number of characters read for this example

Definition at line 170 of file VwParser.cpp.

void register_param ( Tag< T > &  _tag,
const T &  value 
)
protectedinherited

Registers a class parameter which is identified by a tag. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters
_tagname and type information of parameter
valuevalue of the parameter

Definition at line 439 of file SGObject.h.

void register_param ( const std::string &  name,
const T &  value 
)
protectedinherited

Registers a class parameter which is identified by a name. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 452 of file SGObject.h.

char* safe_index ( char *  start,
char  v,
char *  max 
)
protected

Get the index of a character in a memory location taking care not to go beyond the max pointer.

Parameters
startstart memory location, char*
vcharacter to search for
maxlast location to look in
Returns
index of found location as char*

Definition at line 246 of file VwParser.h.

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 347 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 469 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 464 of file SGObject.cpp.

void set ( const Tag< T > &  _tag,
const T &  value 
)
inherited

Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
_tagname and type information of parameter
valuevalue of the parameter

Definition at line 328 of file SGObject.h.

void set ( const std::string &  name,
const T &  value 
)
inherited

Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 354 of file SGObject.h.

void set_cache_parameters ( char *  fname,
EVwCacheType  type = C_NATIVE 
)

Set the cache parameters

Parameters
fnamename of the cache file
typetype of cache as one in EVwCacheType

Definition at line 99 of file VwParser.h.

void set_env ( CVwEnvironment *  env_to_use)

Set the environment

Parameters
env_to_useenvironment as CVwEnvironment*

Definition at line 83 of file VwParser.h.

void set_generic ( )
inherited

Definition at line 74 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 79 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 84 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 89 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 94 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 99 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 104 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 109 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 114 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 119 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 124 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 129 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 134 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 139 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 144 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 261 of file SGObject.cpp.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 274 of file SGObject.cpp.

void set_global_version ( Version *  version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 316 of file SGObject.cpp.

void set_minmax ( float64_t  label)

Function which is actually called to update min and max labels Should be set to one of the functions implemented for this.

Parameters
labellabel based on which to update

Definition at line 165 of file VwParser.h.

void set_mm ( float64_t  label)

Update min and max labels seen in the environment

Parameters
labelcurrent label based on which to update

Definition at line 144 of file VwParser.h.

void set_write_cache ( bool  wr_cache)

Set whether to write cache file or not

Parameters
wr_cachewrite cache or not

Definition at line 119 of file VwParser.h.

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 225 of file SGObject.cpp.

void tokenize ( char  delim,
substring  s,
v_array< substring > &  ret 
)
protected

Split a given substring into an array of substrings based on a specified delimiter

Parameters
delimdelimiter to use
ssubstring to tokenize
retarray of substrings, returned

Definition at line 301 of file VwParser.cpp.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 336 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 281 of file SGObject.cpp.

Member Data Documentation

EVwCacheType cache_type
protected

Type of cache.

Definition at line 263 of file VwParser.h.

CVwCacheWriter* cache_writer
protected

Object which will be used for writing cache.

Definition at line 261 of file VwParser.h.

CVwEnvironment* env
protected

Environment of VW - used by parser.

Definition at line 259 of file VwParser.h.

hash_func_t hasher

Hash function to use, of type hash_func_t.

Definition at line 255 of file VwParser.h.

SGIO* io
inherited

io

Definition at line 537 of file SGObject.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 552 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 555 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 549 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 546 of file SGObject.h.

Parallel* parallel
inherited

parallel

Definition at line 540 of file SGObject.h.

Version* version
inherited

version

Definition at line 543 of file SGObject.h.

bool write_cache
protected

Whether to write cache or not.

Definition at line 265 of file VwParser.h.

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