SHOGUN  6.1.3
List of all members | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CMeanShiftDataGenerator Class Reference

Detailed Description

Class to generate dense features data via the streaming features interface. The core are pairs of methods to a) set the data model and parameters, and b) to generate a data vector using these model parameters Both methods are automatically called when calling get_next_example() This allows to treat generated data as a stream via the standard streaming features interface.

Streaming based data generator that samples from a distribution that is a multivariate isotropic Gaussian in a certain dimensions, where one selected dimension has its mean shifted by some value.

Definition at line 34 of file MeanShiftDataGenerator.h.

Inheritance diagram for CMeanShiftDataGenerator:
[legend]

Public Types

typedef rxcpp::subjects::subject< ObservedValueSGSubject
 
typedef rxcpp::observable< ObservedValue, rxcpp::dynamic_observable< ObservedValue > > SGObservable
 
typedef rxcpp::subscriber< ObservedValue, rxcpp::observer< ObservedValue, void, void, void, void > > SGSubscriber
 

Public Member Functions

 CMeanShiftDataGenerator ()
 
 CMeanShiftDataGenerator (float64_t mean_shift, index_t dimension, index_t m_dimension_shift=0)
 
virtual ~CMeanShiftDataGenerator ()
 
virtual const char * get_name () const
 
void set_mean_shift_model (float64_t mean_shift, index_t dimension, index_t m_dimension_shift=0)
 
bool get_next_example ()
 
void release_example ()
 
virtual void set_vector_reader ()
 
virtual void set_vector_and_label_reader ()
 
virtual void start_parser ()
 
virtual void end_parser ()
 
virtual void reset_stream ()
 
SGVector< float64_tget_vector ()
 
virtual float64_t get_label ()
 
virtual int32_t get_dim_feature_space () const
 
virtual float32_t dot (SGVector< float64_t > vec)
 
virtual float32_t dot (CStreamingDotFeatures *df)
 
virtual float32_t dense_dot (const float32_t *vec2, int32_t vec2_len)
 
virtual float64_t dense_dot (const float64_t *vec2, int32_t vec2_len)
 
virtual void add_to_dense_vec (float32_t alpha, float32_t *vec2, int32_t vec2_len, bool abs_val=false)
 
virtual void add_to_dense_vec (float64_t alpha, float64_t *vec2, int32_t vec2_len, bool abs_val=false)
 
virtual int32_t get_nnz_features_for_vector ()
 
int32_t get_num_features ()
 
virtual EFeatureType get_feature_type () const
 
virtual EFeatureClass get_feature_class () const
 
virtual int32_t get_num_vectors () const
 
virtual CFeaturesget_streamed_features (index_t num_elements)
 
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 CFeaturesduplicate () const
 
virtual Range< int32_t > index_iterator () const
 
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 bool support_compatible_class () const
 
virtual bool get_feature_class_compatibility (EFeatureClass rhs) const
 
virtual CFeaturesshallow_subset_copy ()
 
int32_t ref ()
 
int32_t ref_count ()
 
int32_t unref ()
 
virtual CSGObjectshallow_copy () const
 
virtual CSGObjectdeep_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)
 
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)
 
bool has (const std::string &name) const
 
template<typename T >
bool has (const Tag< T > &tag) const
 
template<typename T , typename U = void>
bool has (const std::string &name) const
 
template<typename T >
void set (const Tag< T > &_tag, const T &value)
 
template<typename T , typename U = void>
void set (const std::string &name, const T &value)
 
template<typename T >
get (const Tag< T > &_tag) const
 
template<typename T , typename U = void>
get (const std::string &name) const
 
SGObservableget_parameters_observable ()
 
void subscribe_to_parameters (ParameterObserverInterface *obs)
 
void list_observable_parameters ()
 
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 ()
 

Public Attributes

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
uint32_t m_hash
 

Protected Member Functions

virtual void load_serializable_pre () throw (ShogunException)
 
virtual void load_serializable_post () throw (ShogunException)
 
virtual void save_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_post () throw (ShogunException)
 
template<typename T >
void register_param (Tag< T > &_tag, const T &value)
 
template<typename T >
void register_param (const std::string &name, const T &value)
 
bool clone_parameters (CSGObject *other)
 
void observe (const ObservedValue value)
 
void register_observable_param (const std::string &name, const SG_OBS_VALUE_TYPE type, const std::string &description)
 

Protected Attributes

float64_t m_mean_shift
 
index_t m_dimension
 
index_t m_dimension_shift
 
float32_t combined_weight
 feature weighting in combined dot features More...
 
CInputParser< float64_tparser
 The parser object, which reads from input and returns parsed example objects. More...
 
SGVector< float64_tcurrent_vector
 The current example's feature vector as an SGVector<T> More...
 
float64_t current_label
 The current example's label. More...
 
bool has_labels
 Whether examples are labelled or not. More...
 
CStreamingFileworking_file
 The StreamingFile object to read from. More...
 
bool seekable
 Whether the stream is seekable. More...
 
CSubsetStackm_subset_stack
 

Member Typedef Documentation

◆ SGObservable

Definition at line 130 of file SGObject.h.

◆ SGSubject

Definition at line 127 of file SGObject.h.

◆ SGSubscriber

typedef rxcpp::subscriber< ObservedValue, rxcpp::observer<ObservedValue, void, void, void, void> > SGSubscriber
inherited

Definition at line 133 of file SGObject.h.

Constructor & Destructor Documentation

◆ CMeanShiftDataGenerator() [1/2]

Constructor

Definition at line 15 of file MeanShiftDataGenerator.cpp.

◆ CMeanShiftDataGenerator() [2/2]

CMeanShiftDataGenerator ( float64_t  mean_shift,
index_t  dimension,
index_t  m_dimension_shift = 0 
)

Constructor

Parameters
mean_shiftSelected dimension is shifted by this amount
dimensionNumber of dimensions
m_dimension_shiftDimension that gets shifted

Definition at line 21 of file MeanShiftDataGenerator.cpp.

◆ ~CMeanShiftDataGenerator()

Destructor

Definition at line 29 of file MeanShiftDataGenerator.cpp.

Member Function Documentation

◆ add_preprocessor()

void add_preprocessor ( CPreprocessor p)
virtualinherited

add preprocessor

Parameters
ppreprocessor to set

Definition at line 85 of file Features.cpp.

◆ add_subset()

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 310 of file Features.cpp.

◆ add_subset_in_place()

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 316 of file Features.cpp.

◆ add_to_dense_vec() [1/2]

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

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 105 of file StreamingDenseFeatures.cpp.

◆ add_to_dense_vec() [2/2]

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

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
vec2_lenlength of vector
abs_valtrue if abs of current_vector should be taken

Definition at line 122 of file StreamingDenseFeatures.cpp.

◆ build_gradient_parameter_dictionary()

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

◆ check_feature_compatibility()

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 283 of file Features.cpp.

◆ clean_preprocessors()

void clean_preprocessors ( )
inherited

clears all preprocs

Definition at line 116 of file Features.cpp.

◆ clone()

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

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

Definition at line 734 of file SGObject.cpp.

◆ clone_parameters()

bool clone_parameters ( CSGObject other)
protectedinherited

Definition at line 759 of file SGObject.cpp.

◆ copy_dimension_subset()

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 348 of file Features.cpp.

◆ copy_subset()

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 340 of file Features.cpp.

◆ create_merged_copy() [1/2]

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 252 of file Features.h.

◆ create_merged_copy() [2/2]

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 266 of file Features.h.

◆ deep_copy()

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 232 of file SGObject.cpp.

◆ del_preprocessor()

void del_preprocessor ( int32_t  num)
virtualinherited

delete preprocessor from list

Parameters
numindex of preprocessor in list

Definition at line 122 of file Features.cpp.

◆ dense_dot() [1/2]

float32_t dense_dot ( const float32_t vec2,
int32_t  vec2_len 
)
virtualinherited

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 81 of file StreamingDenseFeatures.cpp.

◆ dense_dot() [2/2]

float64_t dense_dot ( const float64_t vec2,
int32_t  vec2_len 
)
virtualinherited

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 93 of file StreamingDenseFeatures.cpp.

◆ dense_dot_range()

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.

◆ dot() [1/2]

float32_t dot ( SGVector< float64_t vec)
virtualinherited

Dot product using the current vector and another vector, passed as arg.

Parameters
vecThe vector with which to calculate the dot product.
Returns
Dot product as a float32_t

Definition at line 272 of file StreamingDenseFeatures.cpp.

◆ dot() [2/2]

float32_t dot ( CStreamingDotFeatures df)
virtualinherited

Dot product taken with another StreamingDotFeatures object.

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

Parameters
dfCStreamingDotFeatures object.
Returns
Dot product.

Implements CStreamingDotFeatures.

Definition at line 259 of file StreamingDenseFeatures.cpp.

◆ duplicate()

virtual CFeatures* duplicate ( ) const
virtualinherited

Duplicate the object.

Returns
a duplicate object as CFeatures*

Implements CFeatures.

Definition at line 205 of file StreamingFeatures.h.

◆ end_parser()

void end_parser ( )
virtualinherited

Ends the parsing thread.

Waits for the thread to join.

Implements CStreamingFeatures.

Definition at line 215 of file StreamingDenseFeatures.cpp.

◆ equals()

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

◆ expand_if_required() [1/2]

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.

◆ expand_if_required() [2/2]

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.

◆ free_feature_iterator()

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.

◆ get() [1/2]

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

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

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

Definition at line 381 of file SGObject.h.

◆ get() [2/2]

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

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

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

Definition at line 404 of file SGObject.h.

◆ get_cache_size()

int32_t get_cache_size ( ) const
inherited

get cache size

Returns
cache size

Definition at line 160 of file Features.cpp.

◆ get_dim_feature_space()

int32_t get_dim_feature_space ( ) const
virtualinherited

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 253 of file StreamingDenseFeatures.cpp.

◆ get_feature_class()

EFeatureClass get_feature_class ( ) const
virtualinherited

Return the feature class

Returns
C_STREAMING_DENSE

Implements CFeatures.

Definition at line 291 of file StreamingDenseFeatures.cpp.

◆ get_feature_class_compatibility()

bool get_feature_class_compatibility ( EFeatureClass  rhs) const
virtualinherited

Given a class in right hand side, does this class support compatible computation?

for example, is this->dot(rhs_prt) valid, where rhs_prt is the class in right hand side

Parameters
rhsthe class in right hand side
Returns
whether this class supports compatible computation

Reimplemented in CDenseSubSamplesFeatures< ST >.

Definition at line 355 of file Features.cpp.

◆ get_feature_iterator()

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.

◆ get_feature_type()

virtual EFeatureType get_feature_type ( ) const
virtualinherited

Return the feature type, depending on T.

Returns
Feature type as EFeatureType

Implements CFeatures.

◆ get_global_io()

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 269 of file SGObject.cpp.

◆ get_global_parallel()

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 311 of file SGObject.cpp.

◆ get_global_version()

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 324 of file SGObject.cpp.

◆ get_has_labels()

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.

◆ get_label()

float64_t get_label ( )
virtualinherited

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 239 of file StreamingDenseFeatures.cpp.

◆ get_modelsel_names()

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

Definition at line 536 of file SGObject.cpp.

◆ get_modsel_param_descr()

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

◆ get_modsel_param_index()

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

◆ get_name()

virtual const char* get_name ( ) const
virtual
Returns
name of SG_SERIALIZABLE

Reimplemented from CStreamingDenseFeatures< float64_t >.

Definition at line 53 of file MeanShiftDataGenerator.h.

◆ get_next_example()

bool get_next_example ( )
virtual

get the next example from stream

Reimplemented from CStreamingDenseFeatures< float64_t >.

Definition at line 60 of file MeanShiftDataGenerator.cpp.

◆ get_next_feature()

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.

◆ get_nnz_features_for_vector()

int32_t get_nnz_features_for_vector ( )
virtualinherited

get number of non-zero features in vector

Returns
number of non-zero features in vector

Reimplemented from CStreamingDotFeatures.

Definition at line 139 of file StreamingDenseFeatures.cpp.

◆ get_num_features()

int32_t get_num_features ( )
virtualinherited

Return the number of features in the current example.

Returns
number of features as int

Implements CStreamingFeatures.

Definition at line 285 of file StreamingDenseFeatures.cpp.

◆ get_num_preprocessed()

int32_t get_num_preprocessed ( ) const
inherited

get the number of applied preprocs

Returns
number of applied preprocessors

Definition at line 103 of file Features.cpp.

◆ get_num_preprocessors()

int32_t get_num_preprocessors ( ) const
inherited

get number of preprocessors

Returns
number of preprocessors

Definition at line 155 of file Features.cpp.

◆ get_num_vectors()

int32_t get_num_vectors ( ) const
virtualinherited

Return the number of vectors stored in this object.

Returns
1 if current_vector exists, else 0.

Implements CFeatures.

Definition at line 144 of file StreamingDenseFeatures.cpp.

◆ get_parameters_observable()

SGObservable* get_parameters_observable ( )
inherited

Get parameters observable

Returns
RxCpp observable

Definition at line 415 of file SGObject.h.

◆ get_preprocessor()

CPreprocessor * get_preprocessor ( int32_t  num) const
inherited

get specified preprocessor

Parameters
numindex of preprocessor in list

Definition at line 93 of file Features.cpp.

◆ get_streamed_features()

CFeatures * get_streamed_features ( index_t  num_elements)
virtualinherited

Returns a new CDebseFeatures instance which contains num_elements elements from the underlying stream. The object is not SG_REF'ed.

Parameters
num_elementsnum elements to save from stream
Returns
CFeatures object of underlying type, might contain less data if the stream did end (warning is written)

Reimplemented from CStreamingFeatures.

Definition at line 297 of file StreamingDenseFeatures.cpp.

◆ get_subset_stack()

CSubsetStack * get_subset_stack ( )
virtualinherited

returns subset stack

Returns
subset stack

Definition at line 334 of file Features.cpp.

◆ get_vector()

SGVector< float64_t > get_vector ( )
inherited

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

Returns
The vector as SGVector<T>

Definition at line 233 of file StreamingDenseFeatures.cpp.

◆ has() [1/3]

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

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

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

Definition at line 304 of file SGObject.h.

◆ has() [2/3]

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

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

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

Definition at line 315 of file SGObject.h.

◆ has() [3/3]

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

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

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

Definition at line 326 of file SGObject.h.

◆ has_property()

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 295 of file Features.cpp.

◆ index_iterator()

virtual Range<int32_t> index_iterator ( ) const
virtualinherited

returns an iterator of indices from 0 to CFeatures::get_num_vectors

Should be used in algorithms in the following way:

for (auto idx : features->index_iterator()) { ... }

Definition at line 123 of file Features.h.

◆ is_generic()

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

◆ is_preprocessed()

bool is_preprocessed ( int32_t  num) const
inherited

get whether specified preprocessor was already applied

Parameters
numindex of preprocessor in list

Definition at line 149 of file Features.cpp.

◆ is_seekable()

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.

◆ list_feature_obj()

void list_feature_obj ( ) const
inherited

list feature object

Definition at line 171 of file Features.cpp.

◆ list_observable_parameters()

void list_observable_parameters ( )
inherited

Print to stdout a list of observable parameters

Definition at line 878 of file SGObject.cpp.

◆ list_preprocessors()

void list_preprocessors ( )
inherited

print preprocessors

Definition at line 131 of file Features.cpp.

◆ load()

void load ( CFile loader)
virtualinherited

◆ load_serializable()

bool load_serializable ( CSerializableFile file,
const char *  prefix = "" 
)
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

Parameters
filewhere to load from
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 403 of file SGObject.cpp.

◆ load_serializable_post()

void load_serializable_post ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

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

Definition at line 460 of file SGObject.cpp.

◆ load_serializable_pre()

void load_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

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

Definition at line 455 of file SGObject.cpp.

◆ observe()

void observe ( const ObservedValue  value)
protectedinherited

Observe a parameter value and emit them to observer.

Parameters
valueObserved parameter's value

Definition at line 828 of file SGObject.cpp.

◆ parameter_hash_changed()

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

Definition at line 296 of file SGObject.cpp.

◆ print_modsel_params()

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 512 of file SGObject.cpp.

◆ print_serializable()

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 342 of file SGObject.cpp.

◆ ref()

int32_t ref ( )
inherited

increase reference counter

Returns
reference count

Definition at line 186 of file SGObject.cpp.

◆ ref_count()

int32_t ref_count ( )
inherited

display reference counter

Returns
reference count

Definition at line 193 of file SGObject.cpp.

◆ register_observable_param()

void register_observable_param ( const std::string &  name,
const SG_OBS_VALUE_TYPE  type,
const std::string &  description 
)
protectedinherited

Register which params this object can emit.

Parameters
namethe param name
typethe param type
descriptiona user oriented description

Definition at line 871 of file SGObject.cpp.

◆ register_param() [1/2]

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

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

Parameters
_tagname and type information of parameter
valuevalue of the parameter

Definition at line 472 of file SGObject.h.

◆ register_param() [2/2]

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

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

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

Definition at line 485 of file SGObject.h.

◆ release_example()

void release_example ( )
virtual

release the example when done w/ processing

Reimplemented from CStreamingDenseFeatures< float64_t >.

Definition at line 81 of file MeanShiftDataGenerator.cpp.

◆ remove_all_subsets()

void remove_all_subsets ( )
virtualinherited

removes all subsets Calls subset_changed_post() afterwards

Reimplemented in CCombinedFeatures.

Definition at line 328 of file Features.cpp.

◆ remove_subset()

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 322 of file Features.cpp.

◆ reset_stream()

void reset_stream ( )
virtualinherited

Reset a file back to the first example if possible.

Reimplemented from CStreamingFeatures.

Definition at line 66 of file StreamingDenseFeatures.cpp.

◆ reshape()

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 165 of file Features.cpp.

◆ save()

void save ( CFile writer)
virtualinherited

◆ save_serializable()

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

Save this object to file.

Parameters
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 348 of file SGObject.cpp.

◆ save_serializable_post()

void save_serializable_post ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 470 of file SGObject.cpp.

◆ save_serializable_pre()

void save_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

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

Definition at line 465 of file SGObject.cpp.

◆ set() [1/2]

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

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

Parameters
_tagname and type information of parameter
valuevalue of the parameter

Definition at line 342 of file SGObject.h.

◆ set() [2/2]

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

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

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

Definition at line 368 of file SGObject.h.

◆ set_generic() [1/16]

void set_generic ( )
inherited

Definition at line 73 of file SGObject.cpp.

◆ set_generic() [2/16]

void set_generic ( )
inherited

Definition at line 78 of file SGObject.cpp.

◆ set_generic() [3/16]

void set_generic ( )
inherited

Definition at line 83 of file SGObject.cpp.

◆ set_generic() [4/16]

void set_generic ( )
inherited

Definition at line 88 of file SGObject.cpp.

◆ set_generic() [5/16]

void set_generic ( )
inherited

Definition at line 93 of file SGObject.cpp.

◆ set_generic() [6/16]

void set_generic ( )
inherited

Definition at line 98 of file SGObject.cpp.

◆ set_generic() [7/16]

void set_generic ( )
inherited

Definition at line 103 of file SGObject.cpp.

◆ set_generic() [8/16]

void set_generic ( )
inherited

Definition at line 108 of file SGObject.cpp.

◆ set_generic() [9/16]

void set_generic ( )
inherited

Definition at line 113 of file SGObject.cpp.

◆ set_generic() [10/16]

void set_generic ( )
inherited

Definition at line 118 of file SGObject.cpp.

◆ set_generic() [11/16]

void set_generic ( )
inherited

Definition at line 123 of file SGObject.cpp.

◆ set_generic() [12/16]

void set_generic ( )
inherited

Definition at line 128 of file SGObject.cpp.

◆ set_generic() [13/16]

void set_generic ( )
inherited

Definition at line 133 of file SGObject.cpp.

◆ set_generic() [14/16]

void set_generic ( )
inherited

Definition at line 138 of file SGObject.cpp.

◆ set_generic() [15/16]

void set_generic ( )
inherited

Definition at line 143 of file SGObject.cpp.

◆ set_generic() [16/16]

void set_generic ( )
inherited

set generic type to T

◆ set_global_io()

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 262 of file SGObject.cpp.

◆ set_global_parallel()

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 275 of file SGObject.cpp.

◆ set_global_version()

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 317 of file SGObject.cpp.

◆ set_mean_shift_model()

void set_mean_shift_model ( float64_t  mean_shift,
index_t  dimension,
index_t  m_dimension_shift = 0 
)

Set the mean shift model

Parameters
mean_shiftSelected dimension is shifted by this amount
dimensionNumber of dimensions
m_dimension_shiftDimension that gets shifted

Definition at line 33 of file MeanShiftDataGenerator.cpp.

◆ set_preprocessed()

void set_preprocessed ( int32_t  num)
inherited

set applied flag for preprocessor

Parameters
numindex of preprocessor in list

Definition at line 143 of file Features.cpp.

◆ set_property()

void set_property ( EFeatureProperty  p)
inherited

set property

Parameters
pkernel property to set

Definition at line 300 of file Features.cpp.

◆ set_read_functions()

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.

◆ set_vector_and_label_reader()

void set_vector_and_label_reader ( )
virtualinherited

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 156 of file StreamingDenseFeatures.cpp.

◆ set_vector_reader()

void set_vector_reader ( )
virtualinherited

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 150 of file StreamingDenseFeatures.cpp.

◆ shallow_copy()

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

◆ shallow_subset_copy()

virtual CFeatures* shallow_subset_copy ( )
virtualinherited

◆ start_parser()

void start_parser ( )
virtualinherited

Starts the parsing thread.

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

Implements CStreamingFeatures.

Definition at line 208 of file StreamingDenseFeatures.cpp.

◆ subscribe_to_parameters()

void subscribe_to_parameters ( ParameterObserverInterface obs)
inherited

Subscribe a parameter observer to watch over params

Definition at line 811 of file SGObject.cpp.

◆ subset_changed_post()

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 310 of file Features.h.

◆ support_compatible_class()

virtual bool support_compatible_class ( ) const
virtualinherited

does this class support compatible computation bewteen difference classes? for example, this->dot(rhs_prt), can rhs_prt be an instance of a difference class?

Returns
whether this class supports compatible computation

Reimplemented in CDenseSubSamplesFeatures< ST >.

Definition at line 340 of file Features.h.

◆ unref()

int32_t unref ( )
inherited

decrement reference counter and deallocate object if refcount is zero before or after decrementing it

Returns
reference count

Definition at line 200 of file SGObject.cpp.

◆ unset_generic()

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 337 of file SGObject.cpp.

◆ unset_property()

void unset_property ( EFeatureProperty  p)
inherited

unset property

Parameters
pkernel property to unset

Definition at line 305 of file Features.cpp.

◆ update_parameter_hash()

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 282 of file SGObject.cpp.

Member Data Documentation

◆ combined_weight

float32_t combined_weight
protectedinherited

feature weighting in combined dot features

Definition at line 292 of file StreamingDenseFeatures.h.

◆ current_label

float64_t current_label
protectedinherited

The current example's label.

Definition at line 301 of file StreamingDenseFeatures.h.

◆ current_vector

SGVector<float64_t > current_vector
protectedinherited

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

Definition at line 298 of file StreamingDenseFeatures.h.

◆ has_labels

bool has_labels
protectedinherited

Whether examples are labelled or not.

Definition at line 214 of file StreamingFeatures.h.

◆ io

SGIO* io
inherited

io

Definition at line 600 of file SGObject.h.

◆ m_dimension

index_t m_dimension
protected

dimension

Definition at line 82 of file MeanShiftDataGenerator.h.

◆ m_dimension_shift

index_t m_dimension_shift
protected

Dimension that is shifted

Definition at line 85 of file MeanShiftDataGenerator.h.

◆ m_gradient_parameters

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 615 of file SGObject.h.

◆ m_hash

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 618 of file SGObject.h.

◆ m_mean_shift

float64_t m_mean_shift
protected

model of data to generate

Definition at line 79 of file MeanShiftDataGenerator.h.

◆ m_model_selection_parameters

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 612 of file SGObject.h.

◆ m_parameters

Parameter* m_parameters
inherited

parameters

Definition at line 609 of file SGObject.h.

◆ m_subset_stack

CSubsetStack* m_subset_stack
protectedinherited

subset used for index transformations

Definition at line 378 of file Features.h.

◆ parallel

Parallel* parallel
inherited

parallel

Definition at line 603 of file SGObject.h.

◆ parser

CInputParser<float64_t > parser
protectedinherited

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

Definition at line 295 of file StreamingDenseFeatures.h.

◆ seekable

bool seekable
protectedinherited

Whether the stream is seekable.

Definition at line 220 of file StreamingFeatures.h.

◆ version

Version* version
inherited

version

Definition at line 606 of file SGObject.h.

◆ working_file

CStreamingFile* working_file
protectedinherited

The StreamingFile object to read from.

Definition at line 217 of file StreamingFeatures.h.


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

SHOGUN Machine Learning Toolbox - Documentation