SHOGUN  3.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CStreamingSparseFeatures< T > Class Template Reference

Detailed Description

template<class T>
class shogun::CStreamingSparseFeatures< T >

This class implements streaming features with sparse feature vectors. The vector is represented as an SGSparseVector<T>. Each entry is of type SGSparseVectorEntry<T> with members `feat_index' and `entry'.

This class expects the input from the StreamingFile object to be zero-based, i.e., a feature entered as 1:6.5 would have feat_index=0 and entry=6.5.

The current example is stored as a combination of current_vector and current_label. current_num_features stores the highest dimensionality of examples encountered upto the point of the function call. For example, if the first example is '1:6.5 7:10.0', then current_num_features would be 7 after the first function call.

Since the dimensionality of the feature space is not immediately known initially, current_num_features may increase as more examples are processed and larger dimensions are seen. For this purpose, `expand_if_required()' is provided which when called with a dynamically allocated float or double array and the length, reallocates that array to the new dimensionality (if necessary), setting the newer dimensions to zero, and updates the length parameter to equal the new length of the array.

Definition at line 48 of file StreamingSparseFeatures.h.

Inheritance diagram for CStreamingSparseFeatures< T >:
Inheritance graph
[legend]

Public Member Functions

 CStreamingSparseFeatures ()
 CStreamingSparseFeatures (CStreamingFile *file, bool is_labelled, int32_t size)
virtual ~CStreamingSparseFeatures ()
virtual void set_vector_reader ()
virtual void set_vector_and_label_reader ()
virtual void start_parser ()
virtual void end_parser ()
virtual bool get_next_example ()
get_feature (int32_t index)
SGSparseVector< T > get_vector ()
virtual float64_t get_label ()
virtual void release_example ()
virtual void reset_stream ()
int32_t set_num_features (int32_t num)
virtual int32_t get_dim_feature_space () const
virtual float32_t dot (CStreamingDotFeatures *df)
dense_dot (T alpha, T *vec, int32_t dim, T b)
virtual float64_t dense_dot (const float64_t *vec2, int32_t vec2_len)
virtual float32_t dense_dot (const float32_t *vec2, int32_t vec2_len)
virtual void add_to_dense_vec (float64_t alpha, float64_t *vec2, int32_t vec2_len, bool abs_val=false)
virtual void add_to_dense_vec (float32_t alpha, float32_t *vec2, int32_t vec2_len, bool abs_val=false)
int64_t get_num_nonzero_entries ()
float32_t compute_squared ()
void sort_features ()
virtual int32_t get_num_features ()
virtual int32_t get_nnz_features_for_vector ()
virtual EFeatureType get_feature_type () const
virtual EFeatureClass get_feature_class () const
virtual CFeaturesduplicate () const
virtual const char * get_name () const
virtual int32_t get_num_vectors () const
virtual void dense_dot_range (float32_t *output, float32_t *alphas, float32_t *vec, int32_t dim, float32_t b, int32_t num_vec=0)
virtual void expand_if_required (float32_t *&vec, int32_t &len)
virtual void expand_if_required (float64_t *&vec, int32_t &len)
virtual void * get_feature_iterator ()
virtual bool get_next_feature (int32_t &index, float32_t &value, void *iterator)
virtual void free_feature_iterator (void *iterator)
void set_read_functions ()
virtual bool get_has_labels ()
virtual bool is_seekable ()
virtual CFeaturesget_streamed_features (index_t num_elements)
virtual void add_preprocessor (CPreprocessor *p)
virtual void del_preprocessor (int32_t num)
CPreprocessorget_preprocessor (int32_t num) const
void set_preprocessed (int32_t num)
bool is_preprocessed (int32_t num) const
int32_t get_num_preprocessed () const
int32_t get_num_preprocessors () const
void clean_preprocessors ()
void list_preprocessors ()
int32_t get_cache_size () const
virtual bool reshape (int32_t num_features, int32_t num_vectors)
void list_feature_obj () const
virtual void load (CFile *loader)
virtual void save (CFile *writer)
bool check_feature_compatibility (CFeatures *f) const
bool has_property (EFeatureProperty p) const
void set_property (EFeatureProperty p)
void unset_property (EFeatureProperty p)
virtual CFeaturescreate_merged_copy (CList *others)
virtual CFeaturescreate_merged_copy (CFeatures *other)
virtual void add_subset (SGVector< index_t > subset)
virtual void add_subset_in_place (SGVector< index_t > subset)
virtual void remove_subset ()
virtual void remove_all_subsets ()
virtual CSubsetStackget_subset_stack ()
virtual void subset_changed_post ()
virtual CFeaturescopy_subset (SGVector< index_t > indices)
virtual CFeaturescopy_dimension_subset (SGVector< index_t > dims)
virtual CSGObjectshallow_copy () const
virtual CSGObjectdeep_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)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_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 CSGObjectclone ()

Static Public Member Functions

static T sparse_dot (T alpha, SGSparseVectorEntry< T > *avec, int32_t alen, SGSparseVectorEntry< T > *bvec, int32_t blen)

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
Parameterm_gradient_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

virtual TParametermigrate (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

CInputParser
< SGSparseVectorEntry< T > > 
parser
 The parser object, which reads from input and returns parsed example objects.
SGSparseVector< T > current_sgvector
 The current example's feature vector as an SGVector<T>
index_t current_vec_index
 The current vector index.
float64_t current_label
 The current example's label.
int32_t current_num_features
 Number of features in current vector (as seen so far upto the current vector)
bool has_labels
 Whether examples are labelled or not.
CStreamingFileworking_file
 The StreamingFile object to read from.
bool seekable
 Whether the stream is seekable.
CSubsetStackm_subset_stack

Constructor & Destructor Documentation

Default constructor.

Sets the reading functions to be CStreamingFile::get_*_vector and get_*_vector_and_label depending on the type T.

Definition at line 19 of file StreamingSparseFeatures.cpp.

CStreamingSparseFeatures ( CStreamingFile file,
bool  is_labelled,
int32_t  size 
)

Constructor taking args. Initializes the parser with the given args.

Parameters
fileStreamingFile object, input file.
is_labelledWhether examples are labelled or not.
sizeNumber of example objects to be stored in the parser at a time.

Definition at line 26 of file StreamingSparseFeatures.cpp.

Destructor.

Ends the parsing thread. (Waits for pthread_join to complete)

Definition at line 36 of file StreamingSparseFeatures.cpp.

Member Function Documentation

void add_preprocessor ( CPreprocessor p)
virtualinherited

add preprocessor

Parameters
ppreprocessor to set

Definition at line 82 of file Features.cpp.

void add_subset ( SGVector< index_t subset)
virtualinherited

Adds a subset of indices on top of the current subsets (possibly subset of subset). Every call causes a new active index vector to be stored. Added subsets can be removed one-by-one. If this is not needed, add_subset_in_place() should be used (does not store intermediate index vectors)

Calls subset_changed_post() afterwards

Parameters
subsetsubset of indices to add

Reimplemented in CCombinedFeatures.

Definition at line 307 of file Features.cpp.

void add_subset_in_place ( SGVector< index_t subset)
virtualinherited

Sets/changes latest added subset. This allows to add multiple subsets with in-place memory requirements. They cannot be removed one-by-one afterwards, only the latest active can. If this is needed, use add_subset(). If no subset is active, this just adds.

Calls subset_changed_post() afterwards

Parameters
subsetsubset of indices to replace the latest one with.

Definition at line 313 of file Features.cpp.

void add_to_dense_vec ( float64_t  alpha,
float64_t vec2,
int32_t  vec2_len,
bool  abs_val = false 
)
virtual

Add alpha*current_vector to another float64_t type dense vector. Takes the absolute value of current_vector if specified.

Parameters
alphaalpha
vec2vector to add to, float64_t*
vec2_lenlength of vector
abs_valtrue if abs of current_vector should be taken

Definition at line 133 of file StreamingSparseFeatures.cpp.

void add_to_dense_vec ( float32_t  alpha,
float32_t vec2,
int32_t  vec2_len,
bool  abs_val = false 
)
virtual

Add alpha*current_vector to another dense vector. Takes the absolute value of current_vector if specified.

Parameters
alphaalpha
vec2vector to add to
vec2_lenlength of vector
abs_valtrue if abs of current_vector should be taken

Implements CStreamingDotFeatures.

Definition at line 161 of file StreamingSparseFeatures.cpp.

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

bool check_feature_compatibility ( CFeatures f) const
inherited

check feature compatibility

Parameters
ffeatures to check for compatibility
Returns
if features are compatible

Definition at line 280 of file Features.cpp.

void clean_preprocessors ( )
inherited

clears all preprocs

Definition at line 113 of file Features.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 1302 of file SGObject.cpp.

float32_t compute_squared ( )

Compute sum of squares of features on current vector.

Returns
sum of squares for current vector

Definition at line 195 of file StreamingSparseFeatures.cpp.

CFeatures * copy_dimension_subset ( SGVector< index_t dims)
virtualinherited

Creates a new CFeatures instance containing only the dimensions of the feature vector which are specified by the provided indices.

This method is needed for feature selection tasks NOT IMPLEMENTED!

Parameters
dimsindices of feature dimensions to copy
Returns
new CFeatures instance with copies of specified features

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 345 of file Features.cpp.

CFeatures * copy_subset ( SGVector< index_t indices)
virtualinherited

Creates a new CFeatures instance containing copies of the elements which are specified by the provided indices.

This method is needed for a KernelMachine to store its model data. NOT IMPLEMENTED!

Parameters
indicesindices of feature elements to copy
Returns
new CFeatures instance with copies of feature data

Reimplemented in CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, CStringFeatures< uint16_t >, CSparseFeatures< ST >, CSparseFeatures< float64_t >, CSparseFeatures< T >, CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, and CCombinedFeatures.

Definition at line 337 of file Features.cpp.

virtual CFeatures* create_merged_copy ( CList others)
virtualinherited

Takes a list of feature instances and returns a new instance being a concatenation of a copy of this instace's data and the given instancess data. Note that the feature types have to be equal.

NOT IMPLEMENTED!

Parameters
otherslist of feature objects to append
Returns
new feature object which contains copy of data of this instance and given ones

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 235 of file Features.h.

virtual CFeatures* create_merged_copy ( CFeatures other)
virtualinherited

Convenience method for method with same name and list as parameter.

NOT IMPLEMENTED!

Parameters
otherfeature object to append
Returns
new feature object which contains copy of data of this instance and of given one

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, and CCombinedFeatures.

Definition at line 249 of file Features.h.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 146 of file SGObject.cpp.

void del_preprocessor ( int32_t  num)
virtualinherited

delete preprocessor from list

Parameters
numindex of preprocessor in list

Definition at line 119 of file Features.cpp.

T dense_dot ( alpha,
T *  vec,
int32_t  dim,
b 
)

compute the dot product between dense weights and a sparse feature vector alpha * sparse^T * w + b

Parameters
alphascalar to multiply with
vecdense vector to compute dot product with
dimlength of the dense vector
bbias
Returns
dot product between dense weights and a sparse feature vector

Definition at line 82 of file StreamingSparseFeatures.cpp.

float64_t dense_dot ( const float64_t vec2,
int32_t  vec2_len 
)
virtual

Dot product with another float64_t type dense vector.

Parameters
vec2The dense vector with which to take the dot product.
vec2_lenlength of vector
Returns
Dot product as a float64_t.

Definition at line 91 of file StreamingSparseFeatures.cpp.

float32_t dense_dot ( const float32_t vec2,
int32_t  vec2_len 
)
virtual

Dot product with another dense vector.

Parameters
vec2The dense vector with which to take the dot product.
vec2_lenlength of vector
Returns
Dot product as a float32_t.

Implements CStreamingDotFeatures.

Definition at line 112 of file StreamingSparseFeatures.cpp.

void dense_dot_range ( float32_t output,
float32_t alphas,
float32_t vec,
int32_t  dim,
float32_t  b,
int32_t  num_vec = 0 
)
virtualinherited

Compute the dot product for all vectors. This function makes use of dense_dot alphas[i] * sparse[i]^T * w + b

Parameters
outputresult for the given vector range
alphasscalars to multiply with, may be NULL
vecdense vector to compute dot product with
dimlength of the dense vector
bbias
num_vecnumber of vectors to operate on (indices 0 to num_vec-1)

If num_vec == 0 or left to its default value, the function attempts to return dot product for all vectors. However, the given output vector must be preallocated!

note that the result will be written to output[0...(num_vec-1)] except when num_vec = 0

Definition at line 30 of file StreamingDotFeatures.cpp.

float32_t dot ( CStreamingDotFeatures df)
virtual

Dot product taken with another StreamingDotFeatures object.

Currently only works if it is a CStreamingSparseFeatures object. It takes the dot product of the current_vectors of both objects.

Parameters
dfCStreamingDotFeatures object.
Returns
Dot product.

Implements CStreamingDotFeatures.

Definition at line 357 of file StreamingSparseFeatures.cpp.

CFeatures * duplicate ( ) const
virtual

Duplicate the object.

Returns
a duplicate object as CFeatures*

Implements CFeatures.

Definition at line 223 of file StreamingSparseFeatures.cpp.

void end_parser ( )
virtual

Ends the parsing thread.

Waits for the thread to join.

Implements CStreamingFeatures.

Definition at line 300 of file StreamingSparseFeatures.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 1206 of file SGObject.cpp.

void expand_if_required ( float32_t *&  vec,
int32_t &  len 
)
virtualinherited

Expand the vector passed so that it its length is equal to the dimensionality of the features. The previous values are kept intact through realloc, and the new ones are set to zero.

Parameters
vecfloat32_t* vector
lenlength of the vector

Reimplemented in CStreamingVwFeatures.

Definition at line 53 of file StreamingDotFeatures.cpp.

void expand_if_required ( float64_t *&  vec,
int32_t &  len 
)
virtualinherited

Expand the vector passed so that it its length is equal to the dimensionality of the features. The previous values are kept intact through realloc, and the new ones are set to zero.

Parameters
vecfloat64_t* vector
lenlength of the vector

Reimplemented in CStreamingVwFeatures.

Definition at line 64 of file StreamingDotFeatures.cpp.

void free_feature_iterator ( void *  iterator)
virtualinherited

clean up iterator call this function with the iterator returned by get_first_feature

Parameters
iteratoras returned by get_first_feature

Definition at line 93 of file StreamingDotFeatures.cpp.

int32_t get_cache_size ( ) const
inherited

get cache size

Returns
cache size

Definition at line 157 of file Features.cpp.

int32_t get_dim_feature_space ( ) const
virtual

obtain the dimensionality of the feature space

(not mix this up with the dimensionality of the input space, usually obtained via get_num_features())

Returns
dimensionality

Implements CStreamingDotFeatures.

Definition at line 351 of file StreamingSparseFeatures.cpp.

T get_feature ( int32_t  index)

get a single feature

Parameters
indexindex of feature in this vector
Returns
sum of features that match dimension index and 0 if none is found

Definition at line 43 of file StreamingSparseFeatures.cpp.

EFeatureClass get_feature_class ( ) const
virtual

Return the feature class

Returns
C_STREAMING_SPARSE

Implements CFeatures.

Definition at line 376 of file StreamingSparseFeatures.cpp.

void * get_feature_iterator ( )
virtualinherited

iterate over the non-zero features

call get_feature_iterator first, followed by get_next_feature and free_feature_iterator to cleanup

Returns
feature iterator (to be passed to get_next_feature)

Definition at line 75 of file StreamingDotFeatures.cpp.

virtual EFeatureType get_feature_type ( ) const
virtual

Return the feature type, depending on T.

Returns
Feature type as EFeatureType

Implements CFeatures.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 183 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 224 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 237 of file SGObject.cpp.

bool get_has_labels ( )
virtualinherited

Return whether the examples are labelled or not.

Returns
true if labelled, else false

Definition at line 35 of file StreamingFeatures.cpp.

float64_t get_label ( )
virtual

Return the label of the current example as a float.

Examples must be labelled, otherwise an error occurs.

Returns
The label as a float64_t.

Implements CStreamingFeatures.

Definition at line 337 of file StreamingSparseFeatures.cpp.

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

Definition at line 1077 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 1101 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 1114 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual

Return the name.

Returns
StreamingSparseFeatures

Implements CSGObject.

Definition at line 324 of file StreamingSparseFeatures.h.

bool get_next_example ( )
virtual

Instructs the parser to return the next example.

This example is stored as the current_example in this object.

Returns
True on success, false if there are no more examples, or an error occurred.

Implements CStreamingFeatures.

Definition at line 306 of file StreamingSparseFeatures.cpp.

bool get_next_feature ( int32_t &  index,
float32_t value,
void *  iterator 
)
virtualinherited

iterate over the non-zero features

call this function with the iterator returned by get_first_feature and call free_feature_iterator to cleanup

Parameters
indexis returned by reference (-1 when not available)
valueis returned by reference
iteratoras returned by get_first_feature
Returns
true if a new non-zero feature got returned

Definition at line 87 of file StreamingDotFeatures.cpp.

int32_t get_nnz_features_for_vector ( )
virtual

Return the number of non-zero features in vector

Returns
number of sparse features in vector

Reimplemented from CStreamingDotFeatures.

Definition at line 370 of file StreamingSparseFeatures.cpp.

int32_t get_num_features ( )
virtual

Return the number of features in the current example.

Returns
number of features as int

Implements CStreamingFeatures.

Definition at line 364 of file StreamingSparseFeatures.cpp.

int64_t get_num_nonzero_entries ( )

Get number of non-zero entries in current sparse vector

Returns
number of features explicity set in the sparse vector

Definition at line 189 of file StreamingSparseFeatures.cpp.

int32_t get_num_preprocessed ( ) const
inherited

get the number of applied preprocs

Returns
number of applied preprocessors

Definition at line 100 of file Features.cpp.

int32_t get_num_preprocessors ( ) const
inherited

get number of preprocessors

Returns
number of preprocessors

Definition at line 152 of file Features.cpp.

int32_t get_num_vectors ( ) const
virtual

Return the number of vectors stored in this object.

Returns
1 if current_vector exists, else 0.

Implements CFeatures.

Definition at line 229 of file StreamingSparseFeatures.cpp.

CPreprocessor * get_preprocessor ( int32_t  num) const
inherited

get specified preprocessor

Parameters
numindex of preprocessor in list

Definition at line 90 of file Features.cpp.

virtual CFeatures* get_streamed_features ( index_t  num_elements)
virtualinherited

Returns a new CFeatures instance which contains num_elements elements from the underlying stream. Not SG_REF'ed

Parameters
num_elementsnum elements to save from stream
Returns
CFeatures object of underlying type, might be smaller than requested if the stream stopped. A warning is issued in this case.

NOT IMPLEMENTED!

Reimplemented in CStreamingDenseFeatures< T >, CStreamingDenseFeatures< float64_t >, and CStreamingDenseFeatures< float32_t >.

Definition at line 191 of file StreamingFeatures.h.

CSubsetStack * get_subset_stack ( )
virtualinherited

returns subset stack

Returns
subset stack

Definition at line 331 of file Features.cpp.

SGSparseVector< T > get_vector ( )

Return the current feature vector as an SGSparseVector<T>.

Returns
The vector as SGSparseVector<T>

Definition at line 331 of file StreamingSparseFeatures.cpp.

bool has_property ( EFeatureProperty  p) const
inherited

check if features have given property

Parameters
pfeature property
Returns
if features have given property

Definition at line 292 of file Features.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 243 of file SGObject.cpp.

bool is_preprocessed ( int32_t  num) const
inherited

get whether specified preprocessor was already applied

Parameters
numindex of preprocessor in list

Definition at line 146 of file Features.cpp.

bool is_seekable ( )
virtualinherited

Whether the stream is seekable (to check if multiple epochs are possible), i.e., whether we can process examples in a batch fashion.

A stream can usually seekable when it comes from a file or when it comes from another conventional CFeatures object.

Returns
true if seekable, else false.

Definition at line 40 of file StreamingFeatures.cpp.

void list_feature_obj ( ) const
inherited

list feature object

Definition at line 168 of file Features.cpp.

void list_preprocessors ( )
inherited

print preprocessors

Definition at line 128 of file Features.cpp.

void load ( CFile loader)
virtualinherited
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_versionparameter version of the file
current_versionversion from which mapping begins (you want to use Version::get_version_parameter() for this in most cases)
filefile to load from
prefixprefix for members
Returns
(sorted) array of created TParameter instances with file data

Definition at line 648 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_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
Returns
new array with TParameter instances with the attached data

Definition at line 489 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
filewhere to load from
prefixprefix 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 320 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 occurres.

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

Definition at line 1004 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 occurres.

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

Definition at line 999 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_baseset of TParameter instances that are mapped to the provided target parameter infos
base_versionversion of the parameter base
target_param_infosset of SGParamInfo instances that specify the target parameter base

Definition at line 686 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_baseset of TParameter instances to use for migration
targetparameter 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 893 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_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
replacement(used as output) here the TParameter instance which is returned by migration is created into
to_migratethe only source that is used for migration
old_namewith this parameter, a name change may be specified

Definition at line 833 of file SGObject.cpp.

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

Definition at line 209 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1053 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 255 of file SGObject.cpp.

void release_example ( )
virtual

Release the current example, indicating to the parser that it has been processed by the learning algorithm.

The parser is then free to throw away that example.

Implements CStreamingFeatures.

Definition at line 345 of file StreamingSparseFeatures.cpp.

void remove_all_subsets ( )
virtualinherited

removes all subsets Calls subset_changed_post() afterwards

Reimplemented in CCombinedFeatures.

Definition at line 325 of file Features.cpp.

void remove_subset ( )
virtualinherited

removes that last added subset from subset stack, if existing Calls subset_changed_post() afterwards

Reimplemented in CCombinedFeatures.

Definition at line 319 of file Features.cpp.

void reset_stream ( )
virtual

Reset the file back to the first example if possible.

Reimplemented from CStreamingFeatures.

Definition at line 50 of file StreamingSparseFeatures.cpp.

bool reshape ( int32_t  num_features,
int32_t  num_vectors 
)
virtualinherited

in case there is a feature matrix allow for reshaping

NOT IMPLEMENTED!

Parameters
num_featuresnew number of features
num_vectorsnew number of vectors
Returns
if reshaping was successful

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 162 of file Features.cpp.

void save ( CFile writer)
virtualinherited
bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
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
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 261 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 occurres.

Reimplemented in CKernel.

Definition at line 1014 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 occurres.

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

Definition at line 1009 of file SGObject.cpp.

void set_generic< complex128_t > ( )
inherited

set generic type to T

Definition at line 38 of file SGObject.cpp.

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 176 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 189 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 230 of file SGObject.cpp.

int32_t set_num_features ( int32_t  num)

set number of features

Sometimes when loading sparse features not all possible dimensions are used. This may pose a problem to classifiers when being applied to higher dimensional test-data. This function allows to artificially explode the feature space

Parameters
numthe number of features, must be larger than the current number of features
Returns
previous number of features

Definition at line 56 of file StreamingSparseFeatures.cpp.

void set_preprocessed ( int32_t  num)
inherited

set applied flag for preprocessor

Parameters
numindex of preprocessor in list

Definition at line 140 of file Features.cpp.

void set_property ( EFeatureProperty  p)
inherited

set property

Parameters
pkernel property to set

Definition at line 297 of file Features.cpp.

void set_read_functions ( )
inherited

Set the vector reading functions.

The functions are implemented specific to the type in the derived class.

Definition at line 29 of file StreamingFeatures.cpp.

void set_vector_and_label_reader ( )
virtual

Sets the read function (in case the examples are labelled) to get_*_vector_and_label from CStreamingFile.

The exact function depends on type T.

The parser uses the function set by this while reading labelled examples.

Implements CStreamingFeatures.

Definition at line 241 of file StreamingSparseFeatures.cpp.

void set_vector_reader ( )
virtual

Sets the read function (in case the examples are unlabelled) to get_*_vector() from CStreamingFile.

The exact function depends on type T.

The parser uses the function set by this while reading unlabelled examples.

Implements CStreamingFeatures.

Definition at line 236 of file StreamingSparseFeatures.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 140 of file SGObject.cpp.

void sort_features ( )

Ensure features of the current vector are in ascending order. It modifies the current_sgvector in-place and does not change the reference in current_sgvector.features.

Definition at line 211 of file StreamingSparseFeatures.cpp.

T sparse_dot ( alpha,
SGSparseVectorEntry< T > *  avec,
int32_t  alen,
SGSparseVectorEntry< T > *  bvec,
int32_t  blen 
)
static

compute the dot product between two sparse feature vectors alpha * vec^T * vec

Parameters
alphascalar to multiply with
avecfirst sparse feature vector
alenavec's length
bvecsecond sparse feature vector
blenbvec's length
Returns
dot product between the two sparse feature vectors

Definition at line 65 of file StreamingSparseFeatures.cpp.

void start_parser ( )
virtual

Starts the parsing thread.

To be called before trying to use any feature vectors from this object.

Implements CStreamingFeatures.

Definition at line 293 of file StreamingSparseFeatures.cpp.

virtual void subset_changed_post ( )
virtualinherited

method may be overwritten to update things that depend on subset

Reimplemented in CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, and CStringFeatures< uint16_t >.

Definition at line 293 of file Features.h.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 250 of file SGObject.cpp.

void unset_property ( EFeatureProperty  p)
inherited

unset property

Parameters
pkernel property to unset

Definition at line 302 of file Features.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 196 of file SGObject.cpp.

Member Data Documentation

float64_t current_label
protected

The current example's label.

Definition at line 360 of file StreamingSparseFeatures.h.

int32_t current_num_features
protected

Number of features in current vector (as seen so far upto the current vector)

Definition at line 363 of file StreamingSparseFeatures.h.

SGSparseVector<T> current_sgvector
protected

The current example's feature vector as an SGVector<T>

Definition at line 354 of file StreamingSparseFeatures.h.

index_t current_vec_index
protected

The current vector index.

Definition at line 357 of file StreamingSparseFeatures.h.

bool has_labels
protectedinherited

Whether examples are labelled or not.

Definition at line 201 of file StreamingFeatures.h.

SGIO* io
inherited

io

Definition at line 461 of file SGObject.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 476 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 482 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 473 of file SGObject.h.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 479 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 470 of file SGObject.h.

CSubsetStack* m_subset_stack
protectedinherited

subset used for index transformations

Definition at line 335 of file Features.h.

Parallel* parallel
inherited

parallel

Definition at line 464 of file SGObject.h.

CInputParser< SGSparseVectorEntry<T> > parser
protected

The parser object, which reads from input and returns parsed example objects.

Definition at line 351 of file StreamingSparseFeatures.h.

bool seekable
protectedinherited

Whether the stream is seekable.

Definition at line 207 of file StreamingFeatures.h.

Version* version
inherited

version

Definition at line 467 of file SGObject.h.

CStreamingFile* working_file
protectedinherited

The StreamingFile object to read from.

Definition at line 204 of file StreamingFeatures.h.


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

SHOGUN Machine Learning Toolbox - Documentation