SHOGUN  v1.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Member Functions | Protected Attributes
CVwNativeCacheReader Class Reference

Detailed Description

Class CVwNativeCacheReader reads from a cache exactly as that which has been produced by VW's default cache format.

It is compatible with VW version 5.1.

Definition at line 39 of file VwNativeCacheReader.h.

Inheritance diagram for CVwNativeCacheReader:
Inheritance graph
[legend]

Public Member Functions

 CVwNativeCacheReader ()
 CVwNativeCacheReader (char *fname, CVwEnvironment *env_to_use)
 CVwNativeCacheReader (int32_t f, CVwEnvironment *env_to_use)
virtual ~CVwNativeCacheReader ()
virtual void set_file (int32_t f)
virtual bool read_cached_example (VwExample *const ae)
void check_cache_metadata ()
virtual const char * get_name () const
- Public Member Functions inherited from CVwCacheReader
 CVwCacheReader ()
 CVwCacheReader (char *fname, CVwEnvironment *env_to_use)
 CVwCacheReader (int32_t f, CVwEnvironment *env_to_use)
virtual ~CVwCacheReader ()
virtual void set_env (CVwEnvironment *env_to_use)
virtual CVwEnvironmentget_env ()
virtual void set_mm (float64_t label)
virtual void noop_mm (float64_t label)
virtual void set_minmax (float64_t label)
- Public Member Functions inherited from CSGObject
 CSGObject ()
 CSGObject (const CSGObject &orig)
virtual ~CSGObject ()
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="")
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
void set_global_io (SGIO *io)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_global_version ()
SGVector< char * > get_modelsel_names ()
char * get_modsel_param_descr (const char *param_name)
index_t get_modsel_param_index (const char *param_name)

Protected Attributes

CIOBuffer buf
 Buffer to read from.
- Protected Attributes inherited from CVwCacheReader
int32_t fd
 File descriptor.
CVwEnvironmentenv
 Environment.

Additional Inherited Members

- Public Attributes inherited from CSGObject
SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
- Protected Member Functions inherited from CSGObject
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)

Constructor & Destructor Documentation

Default constructor

Definition at line 20 of file VwNativeCacheReader.cpp.

CVwNativeCacheReader ( char *  fname,
CVwEnvironment env_to_use 
)

Constructor, opens a file whose name is specified

Parameters
fnamefile name
env_to_useEnvironment to use

Definition at line 26 of file VwNativeCacheReader.cpp.

CVwNativeCacheReader ( int32_t  f,
CVwEnvironment env_to_use 
)

Constructor, passed a file descriptor

Parameters
fdescriptor of opened file
env_to_useEnvironment to use

Definition at line 34 of file VwNativeCacheReader.cpp.

~CVwNativeCacheReader ( )
virtual

Destructor

Definition at line 42 of file VwNativeCacheReader.cpp.

Member Function Documentation

void check_cache_metadata ( )

Check whether cache is readable

Definition at line 63 of file VwNativeCacheReader.cpp.

virtual const char* get_name ( ) const
virtual

Return the name of the object.

Returns
VwNativeCacheReader

Reimplemented from CVwCacheReader.

Definition at line 92 of file VwNativeCacheReader.h.

bool read_cached_example ( VwExample *const  ae)
virtual

Read one cached example

Returns
example as VwExample*

Implements CVwCacheReader.

Definition at line 143 of file VwNativeCacheReader.cpp.

void set_file ( int32_t  f)
virtual

Set the file descriptor to use

Parameters
fdescriptor of cache file

Reimplemented from CVwCacheReader.

Definition at line 47 of file VwNativeCacheReader.cpp.

Member Data Documentation

CIOBuffer buf
protected

Buffer to read from.

Definition at line 153 of file VwNativeCacheReader.h.


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

SHOGUN Machine Learning Toolbox - Documentation