详细描述

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.

在文件 VwParser.h 第 48 行定义.

类 CVwParser 继承关系图:

[图例]

Public 成员函数
	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)

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 属性
hash_func_t	hasher
	Hash function to use, of type hash_func_t. 更多...

SGIO *	io

Parallel *	parallel

Version *	version

Parameter *	m_parameters

Parameter *	m_model_selection_parameters

Parameter *	m_gradient_parameters

uint32_t	m_hash

Protected 成员函数
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)

Protected 属性
CVwEnvironment *	env
	Environment of VW - used by parser. 更多...

CVwCacheWriter *	cache_writer
	Object which will be used for writing cache. 更多...

EVwCacheType	cache_type
	Type of cache. 更多...

bool	write_cache
	Whether to write cache or not. 更多...

构造及析构函数说明

CVwParser ( )

Default constructor

在文件 VwParser.cpp 第 21 行定义.

CVwParser ( CVwEnvironment * env_to_use )

Constructor taking environment as parameter.

参数

env_to_use CVwEnvironment to use

在文件 VwParser.cpp 第 30 行定义.

~CVwParser ( )

virtual

Destructor

在文件 VwParser.cpp 第 42 行定义.

成员函数说明

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.

参数

dict	dictionary of parameters to be built.

在文件 SGObject.cpp 第 597 行定义.

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.

返回: 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

在文件 SGObject.cpp 第 714 行定义.

CSGObject * deep_copy ( ) const

virtualinherited

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

在文件 SGObject.cpp 第 198 行定义.

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.

参数

other	object to compare with
accuracy	accuracy to use for comparison (optional)
tolerant	allows linient check on float equality (within accuracy)

返回: true if all parameters were equal, false if not

在文件 SGObject.cpp 第 618 行定义.

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.

参数

s	substring, usually a feature:value string
name	returned array of substrings, split into name and value
v	value of feature, set by reference

在文件 VwParser.cpp 第 271 行定义.

EVwCacheType get_cache_type ( )

Return the type of cache

返回: cache type as EVwCacheType

在文件 VwParser.h 第 106 行定义.

CVwEnvironment* get_env ( )

Get the environment

返回: environment as CVwEnvironment*

在文件 VwParser.h 第 73 行定义.

SGIO * get_global_io ( )

inherited

get the io object

返回: io object

在文件 SGObject.cpp 第 235 行定义.

Parallel * get_global_parallel ( )

inherited

get the parallel object

返回: parallel object

在文件 SGObject.cpp 第 277 行定义.

Version * get_global_version ( )

inherited

get the version object

返回: version object

在文件 SGObject.cpp 第 290 行定义.

SGStringList< char > get_modelsel_names ( )

inherited

返回: vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp 第 498 行定义.

char * get_modsel_param_descr ( const char * param_name )

inherited

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

参数

param_name name of the parameter

返回: description of the parameter

在文件 SGObject.cpp 第 522 行定义.

index_t get_modsel_param_index ( const char * param_name )

inherited

Returns index of model selection parameter with provided index

参数

param_name name of model selection parameter

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

在文件 SGObject.cpp 第 535 行定义.

virtual const char* get_name ( ) const

virtual

Return the name of the object

返回: VwParser

实现了 CSGObject.

在文件 VwParser.h 第 202 行定义.

bool get_write_cache ( )

Return whether cache will be written or not

返回: will cache be written?

在文件 VwParser.h 第 131 行定义.

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

protected

Initialize the cache writer

参数

fname	cache file name
type	cache type as EVwCacheType, default is C_NATIVE

在文件 VwParser.cpp 第 248 行定义.

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.

参数

generic set to the type of the generic if returning TRUE

返回: TRUE if a class template.

在文件 SGObject.cpp 第 296 行定义.

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!

参数

file	where to load from
prefix	prefix for members

返回: TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 369 行定义.

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.

异常

ShogunException will be thrown if an error occurs.

被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp 第 426 行定义.

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.

异常

ShogunException will be thrown if an error occurs.

被 CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 421 行定义.

void noop_mm ( float64_t label )

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

参数

label label

在文件 VwParser.h 第 154 行定义.

bool parameter_hash_changed ( )

virtualinherited

返回: whether parameter combination has changed since last update

在文件 SGObject.cpp 第 262 行定义.

void print_modsel_params ( )

inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp 第 474 行定义.

void print_serializable ( const char * prefix = "" )

virtualinherited

prints registered parameters out

参数

prefix prefix for members

在文件 SGObject.cpp 第 308 行定义.

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

Read an example from a file with dense vectors

参数

buf	IOBuffer which contains input
ae	parsed example

返回: number of characters read for this example

在文件 VwParser.cpp 第 206 行定义.

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

Reads input from the buffer and parses it into a VwExample

参数

buf	IOBuffer which contains input
ex	parsed example

返回: number of characters read for this example

在文件 VwParser.cpp 第 48 行定义.

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

Read an example from an SVMLight file

参数

buf	IOBuffer which contains input
ae	parsed example

返回: number of characters read for this example

在文件 VwParser.cpp 第 164 行定义.

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.

参数

start	start memory location, char*
v	character to search for
max	last location to look in

返回: index of found location as char*

在文件 VwParser.h 第 243 行定义.

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

virtualinherited

Save this object to file.

参数

file	where to save the object; will be closed during returning if PREFIX is an empty string.
prefix	prefix for members

返回: TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 314 行定义.

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.

异常

ShogunException will be thrown if an error occurs.

被 CKernel 重载.

在文件 SGObject.cpp 第 436 行定义.

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.

异常

ShogunException will be thrown if an error occurs.

被 CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 431 行定义.

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

Set the cache parameters

参数

fname	name of the cache file
type	type of cache as one in EVwCacheType

在文件 VwParser.h 第 96 行定义.

void set_env ( CVwEnvironment * env_to_use )

Set the environment

参数

env_to_use environment as CVwEnvironment*

在文件 VwParser.h 第 84 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 41 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 46 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 51 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 56 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 61 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 66 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 71 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 76 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 81 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 86 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 91 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 96 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 101 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 106 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 111 行定义.

void set_generic ( )

inherited

set generic type to T

void set_global_io ( SGIO * io )

inherited

set the io object

参数

io	io object to use

在文件 SGObject.cpp 第 228 行定义.

void set_global_parallel ( Parallel * parallel )

inherited

set the parallel object

参数

parallel parallel object to use

在文件 SGObject.cpp 第 241 行定义.

void set_global_version ( Version * version )

inherited

set the version object

参数

version version object to use

在文件 SGObject.cpp 第 283 行定义.

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.

参数

label label based on which to update

在文件 VwParser.h 第 162 行定义.

void set_mm ( float64_t label )

Update min and max labels seen in the environment

参数

label current label based on which to update

在文件 VwParser.h 第 141 行定义.

void set_write_cache ( bool wr_cache )

Set whether to write cache file or not

参数

wr_cache write cache or not

在文件 VwParser.h 第 116 行定义.

CSGObject * shallow_copy ( ) const

virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

被 CGaussianKernel 重载.

在文件 SGObject.cpp 第 192 行定义.

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

参数

delim	delimiter to use
s	substring to tokenize
ret	array of substrings, returned

在文件 VwParser.cpp 第 295 行定义.

void unset_generic ( )

inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp 第 303 行定义.

void update_parameter_hash ( )

virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp 第 248 行定义.

类成员变量说明

EVwCacheType cache_type

protected

Type of cache.

在文件 VwParser.h 第 260 行定义.

CVwCacheWriter* cache_writer

protected

Object which will be used for writing cache.

在文件 VwParser.h 第 258 行定义.

CVwEnvironment* env

protected

Environment of VW - used by parser.

在文件 VwParser.h 第 256 行定义.

hash_func_t hasher

Hash function to use, of type hash_func_t.

在文件 VwParser.h 第 252 行定义.

SGIO* io

inherited

io

在文件 SGObject.h 第 369 行定义.

Parameter* m_gradient_parameters

inherited

parameters wrt which we can compute gradients

在文件 SGObject.h 第 384 行定义.

uint32_t m_hash

inherited

Hash of parameter values

在文件 SGObject.h 第 387 行定义.

Parameter* m_model_selection_parameters

inherited

model selection parameters

在文件 SGObject.h 第 381 行定义.

Parameter* m_parameters

inherited

parameters

在文件 SGObject.h 第 378 行定义.

Parallel* parallel

inherited

parallel

在文件 SGObject.h 第 372 行定义.

Version* version

inherited

version

在文件 SGObject.h 第 375 行定义.

bool write_cache

protected

Whether to write cache or not.

在文件 VwParser.h 第 262 行定义.

该类的文档由以下文件生成:

详细描述

Public 成员函数

Public 属性

Protected 成员函数

Protected 属性

构造及析构函数说明

成员函数说明

类成员变量说明