Detailed Description

Class StreamingVwFile to read vector-by-vector from Vowpal Wabbit data files. It reads the example and label into one object of VwExample type.

Definition at line 26 of file StreamingVwFile.h.

Inheritance diagram for CStreamingVwFile:

[legend]

Public Member Functions
	CStreamingVwFile ()
	CStreamingVwFile (const char *fname, char rw='r')
virtual	~CStreamingVwFile ()
void	set_parser_type (E_VW_PARSER_TYPE type=T_VW)
virtual void	get_vector (VwExample *&ex, int32_t &len)
virtual void	get_vector_and_label (VwExample *&ex, int32_t &len, float64_t &label)
void	set_env (CVwEnvironment *env_to_use)
CVwEnvironment *	get_env ()
void	set_write_to_cache (bool write_cache)
bool	get_write_to_cache ()
virtual bool	is_seekable ()
virtual const char *	get_name () const
void	close ()
virtual void	reset_stream ()
virtual CSGObject *	shallow_copy () const
virtual CSGObject *	deep_copy () const
virtual bool	is_generic (EPrimitiveType *generic) const
template<class T >
void	set_generic ()
void	unset_generic ()
virtual void	print_serializable (const char *prefix="")
virtual bool	save_serializable (CSerializableFile file, const char prefix="", int32_t param_version=Version::get_version_parameter())
virtual bool	load_serializable (CSerializableFile file, const char prefix="", int32_t param_version=Version::get_version_parameter())
DynArray< TParameter * > *	load_file_parameters (const SGParamInfo param_info, int32_t file_version, CSerializableFile file, const char *prefix="")
DynArray< TParameter * > *	load_all_file_parameters (int32_t file_version, int32_t current_version, CSerializableFile file, const char prefix="")
void	map_parameters (DynArray< TParameter * > param_base, int32_t &base_version, DynArray< const SGParamInfo > *target_param_infos)
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 bool	update_parameter_hash ()
virtual bool	equals (CSGObject *other, float64_t accuracy=0.0)
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
parse_func	parse_example
	The function which will be called for parsing.
SGIO *	io
Parallel *	parallel
Version *	version
Parameter *	m_parameters
Parameter *	m_model_selection_parameters
Parameter *	m_gradient_parameters
ParameterMap *	m_parameter_map
uint32_t	m_hash

Protected Member Functions
virtual TParameter *	migrate (DynArray< TParameter * > param_base, const SGParamInfo target)
virtual void	one_to_one_migration_prepare (DynArray< TParameter * > param_base, const SGParamInfo target, TParameter &replacement, TParameter &to_migrate, char *old_name=NULL)
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
CVwParser *	parser
	Parser for vw format.
E_VW_PARSER_TYPE	parser_type
	Parser type.
CVwEnvironment *	env
	Environment used for vw - used by parser.
bool	write_to_cache
	Write data to a binary cache file.
CIOBuffer *	buf
	Buffer to hold stuff in memory.
char	task
	Task.
char *	filename
	Name of the handled file.

Constructor & Destructor Documentation

CStreamingVwFile ( )

Default constructor

Definition at line 15 of file StreamingVwFile.cpp.

CStreamingVwFile	(	const char *	fname,
		char	rw = `'r'`
	)

Constructor taking file name argument

Parameters

fname	file name
rw	read/write mode

Definition at line 21 of file StreamingVwFile.cpp.

~CStreamingVwFile ( )

virtual

Destructor

Definition at line 27 of file StreamingVwFile.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

dict	dictionary of parameters to be built.

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

void close ( )

inherited

Closes the file

Definition at line 58 of file StreamingFile.h.

virtual CSGObject* deep_copy ( ) const

virtualinherited

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

Definition at line 160 of file SGObject.h.

bool equals	(	CSGObject *	other,
		float64_t	accuracy = `0.0`
	)

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

other	object to compare with
accuracy	accuracy to use for comparison (optional)

Returns: true if all parameters were equal, false if not

Definition at line 1217 of file SGObject.cpp.

CVwEnvironment* get_env ( )

Return the environment

Returns: environment as CVwEnvironment*

Definition at line 94 of file StreamingVwFile.h.

SGIO * get_global_io ( )

inherited

get the io object

Returns: io object

Definition at line 214 of file SGObject.cpp.

Parallel * get_global_parallel ( )

inherited

get the parallel object

Returns: parallel object

Definition at line 249 of file SGObject.cpp.

Version * get_global_version ( )

inherited

get the version object

Returns: version object

Definition at line 262 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 1100 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_name name of the parameter

Returns: description of the parameter

Definition at line 1124 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_name name of model selection parameter

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

Definition at line 1137 of file SGObject.cpp.

virtual const char* get_name ( ) const

virtual

Returns: object name

Reimplemented from CStreamingFile.

Definition at line 121 of file StreamingVwFile.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 are redundant.

Parameters

ex	examples as VwExample*, set by reference
len	length of vector, untouched

Reimplemented from CStreamingFile.

Definition at line 54 of file StreamingVwFile.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

ex	example as VwExample*, set by reference
len	length of vector, untouched
label	label, untouched

Reimplemented from CStreamingFile.

Definition at line 61 of file StreamingVwFile.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 get_write_to_cache ( )

Get whether cache will be written

Returns: whether to write to cache

Definition at line 116 of file StreamingVwFile.h.

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

generic set to the type of the generic if returning TRUE

Returns: TRUE if a class template.

Definition at line 268 of file SGObject.cpp.

virtual bool is_seekable ( )

virtual

Whether the stream is seekable/resettable

Returns: false by default, unless overloaded

Reimplemented from CStreamingFile.

Definition at line 118 of file StreamingVwFile.h.

DynArray< TParameter * > * load_all_file_parameters	(	int32_t	file_version,
		int32_t	current_version,
		CSerializableFile *	file,
		const char *	prefix = `""`
	)

inherited

maps all parameters of this instance to the provided file version and loads all parameter data from the file into an array, which is sorted (basically calls load_file_parameter(...) for all parameters and puts all results into a sorted array)

Parameters

file_version	parameter version of the file
current_version	version from which mapping begins (you want to use Version::get_version_parameter() for this in most cases)
file	file to load from
prefix	prefix for members

Returns: (sorted) array of created TParameter instances with file data

Definition at line 673 of file SGObject.cpp.

DynArray< TParameter * > * load_file_parameters	(	const SGParamInfo *	param_info,
		int32_t	file_version,
		CSerializableFile *	file,
		const char *	prefix = `""`
	)

inherited

loads some specified parameters from a file with a specified version The provided parameter info has a version which is recursively mapped until the file parameter version is reached. Note that there may be possibly multiple parameters in the mapping, therefore, a set of TParameter instances is returned

Parameters

param_info	information of parameter
file_version	parameter version of the file, must be <= provided parameter version
file	file to load from
prefix	prefix for members

Returns: new array with TParameter instances with the attached data

Definition at line 514 of file SGObject.cpp.

bool load_serializable	(	CSerializableFile *	file,
		const char *	prefix = `""`,
		int32_t	param_version = `Version::get_version_parameter()`
	)

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

file	where to load from
prefix	prefix for members
param_version	(optional) a parameter version different to (this is mainly for testing, better do not use)

Returns: TRUE if done, otherwise FALSE

Definition at line 345 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

ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 1029 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

ShogunException Will be thrown if an error occurres.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicArray< uint64_t >, and CDynamicObjectArray.

Definition at line 1024 of file SGObject.cpp.

void map_parameters	(	DynArray< TParameter * > *	param_base,
		int32_t &	base_version,
		DynArray< const SGParamInfo * > *	target_param_infos
	)

inherited

Takes a set of TParameter instances (base) with a certain version and a set of target parameter infos and recursively maps the base level wise to the current version using CSGObject::migrate(...). The base is replaced. After this call, the base version containing parameters should be of same version/type as the initial target parameter infos. Note for this to work, the migrate methods and all the internal parameter mappings have to match

Parameters

param_base	set of TParameter instances that are mapped to the provided target parameter infos
base_version	version of the parameter base
target_param_infos	set of SGParamInfo instances that specify the target parameter base

Definition at line 711 of file SGObject.cpp.

TParameter * migrate	(	DynArray< TParameter * > *	param_base,
		const SGParamInfo *	target
	)

protectedvirtualinherited

creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.

If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass

Parameters

param_base	set of TParameter instances to use for migration
target	parameter info for the resulting TParameter

Returns: a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 918 of file SGObject.cpp.

void one_to_one_migration_prepare	(	DynArray< TParameter * > *	param_base,
		const SGParamInfo *	target,
		TParameter *&	replacement,
		TParameter *&	to_migrate,
		char *	old_name = `NULL`
	)

protectedvirtualinherited

This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)

Parameters

param_base	set of TParameter instances to use for migration
target	parameter info for the resulting TParameter
replacement	(used as output) here the TParameter instance which is returned by migration is created into
to_migrate	the only source that is used for migration
old_name	with this parameter, a name change may be specified

Definition at line 858 of file SGObject.cpp.

void print_modsel_params ( )

inherited

prints all parameter registered for model selection and their type

Definition at line 1076 of file SGObject.cpp.

void print_serializable ( const char * prefix = "" )

virtualinherited

prints registered parameters out

Parameters

prefix prefix for members

Definition at line 280 of file SGObject.cpp.

virtual void reset_stream ( )

virtualinherited

Reset the stream, should be overloaded if possible

Reimplemented in CStreamingVwCacheFile, CStreamingFileFromDenseFeatures< T >, CStreamingFileFromSparseFeatures< T >, and CStreamingFileFromStringFeatures< T >.

Definition at line 73 of file StreamingFile.h.

bool save_serializable	(	CSerializableFile *	file,
		const char *	prefix = `""`,
		int32_t	param_version = `Version::get_version_parameter()`
	)

virtualinherited

Save this object to file.

Parameters

file	where to save the object; will be closed during returning if PREFIX is an empty string.
prefix	prefix for members
param_version	(optional) a parameter version different to (this is mainly for testing, better do not use)

Returns: TRUE if done, otherwise FALSE

Definition at line 286 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

ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 1039 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

ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicArray< uint64_t >, and CDynamicObjectArray.

Definition at line 1034 of file SGObject.cpp.

void set_env ( CVwEnvironment * env_to_use )

Set environment for vw

Parameters

env_to_use CVwEnvironment* environment

Definition at line 84 of file StreamingVwFile.h.

void set_generic< complex128_t > ( )

inherited

set generic type to T

Definition at line 41 of file SGObject.cpp.

void set_global_io ( SGIO * io )

inherited

set the io object

Parameters

io	io object to use

Definition at line 207 of file SGObject.cpp.

void set_global_parallel ( Parallel * parallel )

inherited

set the parallel object

Parameters

parallel parallel object to use

Definition at line 220 of file SGObject.cpp.

void set_global_version ( Version * version )

inherited

set the version object

Parameters

version version object to use

Definition at line 255 of file SGObject.cpp.

void set_parser_type ( E_VW_PARSER_TYPE type = T_VW )

Set the type of parser, i.e., T_VW, T_SVMLIGHT or T_DENSE.

Parameters

type	parser type as enum

Definition at line 33 of file StreamingVwFile.cpp.

void set_write_to_cache ( bool write_cache )

Set whether cache will be written

Parameters

write_cache whether to write to cache

Definition at line 105 of file StreamingVwFile.h.

virtual 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 151 of file SGObject.h.

void unset_generic ( )

inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 275 of file SGObject.cpp.

bool update_parameter_hash ( )

virtualinherited

Updates the hash of current parameter combination.

Returns: bool if parameter combination has changed since last update.

Definition at line 227 of file SGObject.cpp.

Member Data Documentation

CIOBuffer* buf

protectedinherited

Buffer to hold stuff in memory.

Definition at line 295 of file StreamingFile.h.

CVwEnvironment* env

protected

Environment used for vw - used by parser.

Definition at line 144 of file StreamingVwFile.h.

char* filename

protectedinherited

Name of the handled file.

Definition at line 299 of file StreamingFile.h.

SGIO* io

inherited

io

Definition at line 514 of file SGObject.h.

Parameter* m_gradient_parameters

inherited

parameters wrt which we can compute gradients

Definition at line 529 of file SGObject.h.

uint32_t m_hash

inherited

Hash of parameter values

Definition at line 535 of file SGObject.h.

Parameter* m_model_selection_parameters

inherited

model selection parameters

Definition at line 526 of file SGObject.h.

ParameterMap* m_parameter_map

inherited

map for different parameter versions

Definition at line 532 of file SGObject.h.

Parameter* m_parameters

inherited

parameters

Definition at line 523 of file SGObject.h.

Parallel* parallel

inherited

parallel

Definition at line 517 of file SGObject.h.

parse_func parse_example

The function which will be called for parsing.

Definition at line 128 of file StreamingVwFile.h.

CVwParser* parser

protected

Parser for vw format.

Definition at line 138 of file StreamingVwFile.h.

E_VW_PARSER_TYPE parser_type

protected

Parser type.

Definition at line 141 of file StreamingVwFile.h.

char task

protectedinherited

Task.

Definition at line 297 of file StreamingFile.h.

Version* version

inherited

version

Definition at line 520 of file SGObject.h.

bool write_to_cache

protected

Write data to a binary cache file.

Definition at line 147 of file StreamingVwFile.h.

The documentation for this class was generated from the following files:

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation