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
CDenseFeatures< ST > Class Template Reference

Detailed Description

template<class ST>
class shogun::CDenseFeatures< ST >

The class DenseFeatures implements dense feature matrices.

The feature matrices are stored en-block in memory in fortran order, i.e. column-by-column, where a column denotes a feature vector.

There are get_num_vectors() many feature vectors, of dimension get_num_features(). To access a feature vector call get_feature_vector() and when you are done treating it call free_feature_vector(). While free_feature_vector() is a NOP in most cases feature vectors might have been generated on the fly (due to a number preprocessors being attached to them).

From this template class a number the following dense feature matrix types are used and supported:

Partly) subset access is supported for this feature type. Dense use the (inherited) add_subset(), remove_subset() functions. If done, all calls that work with features are translated to the subset. See comments to find out whether it is supported for that method. See also CFeatures class documentation

Definition at line 69 of file DenseFeatures.h.

Inheritance diagram for CDenseFeatures< ST >:
Inheritance graph
[legend]

Public Member Functions

 CDenseFeatures (int32_t size=0)
 CDenseFeatures (const CDenseFeatures &orig)
 CDenseFeatures (SGMatrix< ST > matrix)
 CDenseFeatures (ST *src, int32_t num_feat, int32_t num_vec)
 CDenseFeatures (CFile *loader)
virtual CFeaturesduplicate () const
virtual ~CDenseFeatures ()
void free_feature_matrix ()
void free_features ()
ST * get_feature_vector (int32_t num, int32_t &len, bool &dofree)
void set_feature_vector (SGVector< ST > vector, int32_t num)
SGVector< ST > get_feature_vector (int32_t num)
void free_feature_vector (ST *feat_vec, int32_t num, bool dofree)
void free_feature_vector (SGVector< ST > vec, int32_t num)
void vector_subset (int32_t *idx, int32_t idx_len)
void feature_subset (int32_t *idx, int32_t idx_len)
SGMatrix< ST > get_feature_matrix ()
SGMatrix< ST > steal_feature_matrix ()
void set_feature_matrix (SGMatrix< ST > matrix)
ST * get_feature_matrix (int32_t &num_feat, int32_t &num_vec)
CDenseFeatures< ST > * get_transposed ()
ST * get_transposed (int32_t &num_feat, int32_t &num_vec)
virtual void copy_feature_matrix (SGMatrix< ST > src)
void obtain_from_dot (CDotFeatures *df)
virtual bool apply_preprocessor (bool force_preprocessing=false)
virtual int32_t get_num_vectors () const
int32_t get_num_features () const
void set_num_features (int32_t num)
void set_num_vectors (int32_t num)
void initialize_cache ()
virtual EFeatureClass get_feature_class () const
virtual EFeatureType get_feature_type () const
virtual bool reshape (int32_t p_num_features, int32_t p_num_vectors)
virtual int32_t get_dim_feature_space () const
virtual float64_t dot (int32_t vec_idx1, CDotFeatures *df, int32_t vec_idx2)
virtual float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
virtual void add_to_dense_vec (float64_t alpha, int32_t vec_idx1, float64_t *vec2, int32_t vec2_len, bool abs_val=false)
virtual int32_t get_nnz_features_for_vector (int32_t num)
virtual void load (CFile *loader)
virtual void save (CFile *saver)
virtual void * get_feature_iterator (int32_t vector_index)
virtual bool get_next_feature (int32_t &index, float64_t &value, void *iterator)
virtual void free_feature_iterator (void *iterator)
virtual CFeaturescopy_subset (SGVector< index_t > indices)
virtual CFeaturescopy_dimension_subset (SGVector< index_t > dims)
virtual bool is_equal (CDenseFeatures *rhs)
CFeaturescreate_merged_copy (CList *other)
CFeaturescreate_merged_copy (CFeatures *other)
virtual const char * get_name () const
template<>
void add_to_dense_vec (float64_t alpha, int32_t vec_idx1, float64_t *vec2, int32_t vec2_len, bool abs_val)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
template<>
float64_t dense_dot (int32_t vec_idx1, const float64_t *vec2, int32_t vec2_len)
virtual float64_t dense_dot_sgvec (int32_t vec_idx1, const SGVector< float64_t > vec2)
virtual void dense_dot_range (float64_t *output, int32_t start, int32_t stop, float64_t *alphas, float64_t *vec, int32_t dim, float64_t b)
virtual void dense_dot_range_subset (int32_t *sub_index, int32_t num, float64_t *output, float64_t *alphas, float64_t *vec, int32_t dim, float64_t b)
float64_t get_combined_feature_weight ()
void set_combined_feature_weight (float64_t nw)
SGMatrix< float64_tget_computed_dot_feature_matrix ()
SGVector< float64_tget_computed_dot_feature_vector (int32_t num)
void benchmark_add_to_dense_vector (int32_t repeats=5)
void benchmark_dense_dot_range (int32_t repeats=5)
virtual SGVector< float64_tget_mean ()
virtual SGMatrix< float64_tget_cov ()
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
void list_feature_obj () const
bool check_feature_compatibility (CFeatures *f) const
bool has_property (EFeatureProperty p) const
void set_property (EFeatureProperty p)
void unset_property (EFeatureProperty p)
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 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 CDenseFeaturesobtain_from_generic (CFeatures *const base_features)
static void * dense_dot_range_helper (void *p)
static SGVector< float64_tget_mean (CDotFeatures *lhs, CDotFeatures *rhs)
static SGMatrix< float64_tcompute_cov (CDotFeatures *lhs, CDotFeatures *rhs)

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 ST * compute_feature_vector (int32_t num, int32_t &len, ST *target=NULL)
void display_progress (int32_t start, int32_t stop, int32_t v)
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

int32_t num_vectors
 number of vectors in cache
int32_t num_features
 number of features in cache
SGMatrix< ST > feature_matrix
CCache< ST > * feature_cache
float64_t combined_weight
 feature weighting in combined dot features
CSubsetStackm_subset_stack

Constructor & Destructor Documentation

CDenseFeatures ( int32_t  size = 0)

constructor

Parameters
sizecache size

Definition at line 24 of file DenseFeatures.cpp.

CDenseFeatures ( const CDenseFeatures< ST > &  orig)

copy constructor

Definition at line 29 of file DenseFeatures.cpp.

CDenseFeatures ( SGMatrix< ST >  matrix)

constructor

Parameters
matrixfeature matrix

Definition at line 44 of file DenseFeatures.cpp.

CDenseFeatures ( ST *  src,
int32_t  num_feat,
int32_t  num_vec 
)

constructor

Parameters
srcfeature matrix
num_featnumber of features in matrix
num_vecnumber of vectors in matrix

Definition at line 51 of file DenseFeatures.cpp.

CDenseFeatures ( CFile loader)

constructor loading features from file

Parameters
loaderFile object via which to load data

Definition at line 57 of file DenseFeatures.cpp.

~CDenseFeatures ( )
virtual

Definition at line 69 of file DenseFeatures.cpp.

Member Function Documentation

void add_preprocessor ( CPreprocessor p)
virtualinherited

add preprocessor

Parameters
ppreprocessor to set

Definition at line 85 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 310 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 316 of file Features.cpp.

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

add vector 1 multiplied with alpha to dense vector2

possible with subset

Parameters
alphascalar alpha
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector
abs_valif true add the absolute value

Implements CDotFeatures.

Definition at line 498 of file DenseFeatures.cpp.

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

add vector 1 multiplied with alpha to dense vector2

Parameters
alphascalar alpha
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector
abs_valif true add the absolute value

Implements CDotFeatures.

Definition at line 524 of file DenseFeatures.cpp.

bool apply_preprocessor ( bool  force_preprocessing = false)
virtual

apply preprocessor

applies preprocessors to ALL features (subset removed before and restored afterwards)

not possible with subset

Parameters
force_preprocessingif preprocssing shall be forced
Returns
if applying was successful

Definition at line 379 of file DenseFeatures.cpp.

void benchmark_add_to_dense_vector ( int32_t  repeats = 5)
inherited

run benchmark for add_to_dense_vec

Definition at line 318 of file DotFeatures.cpp.

void benchmark_dense_dot_range ( int32_t  repeats = 5)
inherited

run benchmark for dense_dot_range

Definition at line 341 of file DotFeatures.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 283 of file Features.cpp.

void clean_preprocessors ( )
inherited

clears all preprocs

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

SGMatrix< float64_t > compute_cov ( CDotFeatures lhs,
CDotFeatures rhs 
)
staticinherited

compute the covariance of two CDotFeatures together

Returns
covariance

Definition at line 469 of file DotFeatures.cpp.

ST * compute_feature_vector ( int32_t  num,
int32_t &  len,
ST *  target = NULL 
)
protectedvirtual

compute feature vector for sample num if target is set the vector is written to target len is returned by reference

NOT IMPLEMENTED!

Parameters
numnum
lenlen
target
Returns
feature vector

Reimplemented in CTOPFeatures, CFKFeatures, and CRealFileFeatures.

Definition at line 639 of file DenseFeatures.cpp.

CFeatures * copy_dimension_subset ( SGVector< index_t dims)
virtual

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

possible with subset

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

Reimplemented from CFeatures.

Definition at line 610 of file DenseFeatures.cpp.

void copy_feature_matrix ( SGMatrix< ST >  src)
virtual

copy feature matrix store copy of feature_matrix, where num_features is the column offset, and columns are linear in memory see below for definition of feature_matrix

not possible with subset

Parameters
srcfeature matrix to copy

Definition at line 343 of file DenseFeatures.cpp.

CFeatures * copy_subset ( SGVector< index_t indices)
virtual

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

possible with subset

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

Reimplemented from CFeatures.

Definition at line 592 of file DenseFeatures.cpp.

CFeatures * create_merged_copy ( CList other)
virtual

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

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

Reimplemented from CFeatures.

Definition at line 976 of file DenseFeatures.cpp.

CFeatures * create_merged_copy ( CFeatures other)
virtual

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

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

Reimplemented from CFeatures.

Definition at line 1058 of file DenseFeatures.cpp.

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

virtual float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

possible with subset

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 685 of file DenseFeatures.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 705 of file DenseFeatures.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 725 of file DenseFeatures.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 745 of file DenseFeatures.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 765 of file DenseFeatures.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 785 of file DenseFeatures.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 805 of file DenseFeatures.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 825 of file DenseFeatures.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 845 of file DenseFeatures.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 865 of file DenseFeatures.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 885 of file DenseFeatures.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 905 of file DenseFeatures.cpp.

float64_t dense_dot ( int32_t  vec_idx1,
const float64_t vec2,
int32_t  vec2_len 
)
virtual

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2pointer to real valued vector
vec2_lenlength of real valued vector

Implements CDotFeatures.

Definition at line 922 of file DenseFeatures.cpp.

void dense_dot_range ( float64_t output,
int32_t  start,
int32_t  stop,
float64_t alphas,
float64_t vec,
int32_t  dim,
float64_t  b 
)
virtualinherited

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

Parameters
outputresult for the given vector range
startstart vector range from this idx
stopstop vector range at this idx
alphasscalars to multiply with, may be NULL
vecdense vector to compute dot product with
dimlength of the dense vector
bbias

note that the result will be written to output[0...(stop-start-1)]

Reimplemented in CCombinedDotFeatures, and CHashedWDFeaturesTransposed.

Definition at line 67 of file DotFeatures.cpp.

void * dense_dot_range_helper ( void *  p)
staticinherited

Compute the dot product for a range of vectors. This function is called by the threads created in dense_dot_range

Reimplemented in CHashedWDFeaturesTransposed.

Definition at line 231 of file DotFeatures.cpp.

void dense_dot_range_subset ( int32_t *  sub_index,
int32_t  num,
float64_t output,
float64_t alphas,
float64_t vec,
int32_t  dim,
float64_t  b 
)
virtualinherited

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

Parameters
sub_indexindex for which to compute outputs
numlength of index
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

Reimplemented in CCombinedDotFeatures, and CHashedWDFeaturesTransposed.

Definition at line 153 of file DotFeatures.cpp.

float64_t dense_dot_sgvec ( int32_t  vec_idx1,
const SGVector< float64_t vec2 
)
virtualinherited

compute dot product between vector1 and a dense vector

Parameters
vec_idx1index of first vector
vec2dense vector

Reimplemented in CHashedDocDotFeatures.

Definition at line 62 of file DotFeatures.cpp.

void display_progress ( int32_t  start,
int32_t  stop,
int32_t  v 
)
protectedinherited

display progress output

Parameters
startminimum value
stopmaximum value
vcurrent value

Definition at line 528 of file DotFeatures.cpp.

float64_t dot ( int32_t  vec_idx1,
CDotFeatures df,
int32_t  vec_idx2 
)
virtual

compute dot product between vector1 and vector2, appointed by their indices

possible with subset

Parameters
vec_idx1index of first vector
dfDotFeatures (of same kind) to compute dot product with
vec_idx2index of second vector

Implements CDotFeatures.

Definition at line 476 of file DenseFeatures.cpp.

CFeatures * duplicate ( ) const
virtual

duplicate feature object

Returns
feature object

Implements CFeatures.

Definition at line 64 of file DenseFeatures.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 feature_subset ( int32_t *  idx,
int32_t  idx_len 
)

Extracts the features mentioned in idx and replaces them in feature matrix in place.

It does not resize the allocated memory block.

Not possible with subset.

Parameters
idxindex with features that shall remain in the feature matrix
idx_lenlength of the index

Note: assumes idx is sorted

Definition at line 237 of file DenseFeatures.cpp.

void free_feature_iterator ( void *  iterator)
virtual

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

Parameters
iteratoras returned by get_first_feature

Implements CDotFeatures.

Definition at line 582 of file DenseFeatures.cpp.

void free_feature_matrix ( )

free feature matrix

Any subset is removed

Definition at line 81 of file DenseFeatures.cpp.

void free_feature_vector ( ST *  feat_vec,
int32_t  num,
bool  dofree 
)

free feature vector

possible with subset

Parameters
feat_vecfeature vector to free
numindex in feature cache
dofreeif vector should be really deleted

Definition at line 191 of file DenseFeatures.cpp.

void free_feature_vector ( SGVector< ST >  vec,
int32_t  num 
)

free feature vector

possible with subset

Parameters
vecfeature vector to free
numindex in feature cache

Definition at line 200 of file DenseFeatures.cpp.

void free_features ( )

free feature matrix and cache

Any subset is removed

Definition at line 74 of file DenseFeatures.cpp.

int32_t get_cache_size ( ) const
inherited

get cache size

Returns
cache size

Definition at line 160 of file Features.cpp.

float64_t get_combined_feature_weight ( )
inherited

get combined feature weight

Returns
combined feature weight

Definition at line 154 of file DotFeatures.h.

SGMatrix< float64_t > get_computed_dot_feature_matrix ( )
inherited

compute the feature matrix in feature space

Returns
computed feature matrix

Definition at line 284 of file DotFeatures.cpp.

SGVector< float64_t > get_computed_dot_feature_vector ( int32_t  num)
inherited

compute the feature vector in feature space

Returns
computed feature vector

Definition at line 305 of file DotFeatures.cpp.

SGMatrix< float64_t > get_cov ( )
virtualinherited

get covariance

Returns
covariance

Definition at line 427 of file DotFeatures.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 CDotFeatures.

Definition at line 474 of file DenseFeatures.cpp.

EFeatureClass get_feature_class ( ) const
virtual

get feature class

Returns
feature class DENSE

Implements CFeatures.

Definition at line 457 of file DenseFeatures.cpp.

void * get_feature_iterator ( int32_t  vector_index)
virtual

iterate over the non-zero features

call get_feature_iterator first, followed by get_next_feature and free_feature_iterator to cleanup

possible with subset

Parameters
vector_indexthe index of the vector over whose components to iterate over
Returns
feature iterator (to be passed to get_next_feature)

Implements CDotFeatures.

Definition at line 553 of file DenseFeatures.cpp.

SGMatrix< ST > get_feature_matrix ( )

Getter the feature matrix

in-place without subset a copy with subset

Returns
matrix feature matrix

Definition at line 267 of file DenseFeatures.cpp.

ST * get_feature_matrix ( int32_t &  num_feat,
int32_t &  num_vec 
)

get the pointer to the feature matrix num_feat,num_vectors are returned by reference

subset is ignored

Parameters
num_featnumber of features in matrix
num_vecnumber of vectors in matrix
Returns
feature matrix

Definition at line 305 of file DenseFeatures.cpp.

virtual EFeatureType get_feature_type ( ) const
virtual

get feature type

Returns
templated feature type

Implements CFeatures.

ST * get_feature_vector ( int32_t  num,
int32_t &  len,
bool &  dofree 
)

get feature vector for sample num from the matrix as it is if matrix is initialized, else return preprocessed compute_feature_vector (not implemented)

Parameters
numindex of feature vector
lenlength is returned by reference
dofreewhether returned vector must be freed by caller via free_feature_vector
Returns
feature vector

Definition at line 89 of file DenseFeatures.cpp.

SGVector< ST > get_feature_vector ( int32_t  num)

get feature vector num

possible with subset

Parameters
numindex of vector
Returns
feature vector

Definition at line 174 of file DenseFeatures.cpp.

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.

SGVector< float64_t > get_mean ( )
virtualinherited

get mean

Returns
mean returned

Definition at line 384 of file DotFeatures.cpp.

SGVector< float64_t > get_mean ( CDotFeatures lhs,
CDotFeatures rhs 
)
staticinherited

get mean of two CDotFeature objects

Returns
mean returned

Definition at line 402 of file DotFeatures.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
Returns
object name

Implements CSGObject.

Reimplemented in CTOPFeatures, CFKFeatures, and CRealFileFeatures.

Definition at line 519 of file DenseFeatures.h.

bool get_next_feature ( int32_t &  index,
float64_t value,
void *  iterator 
)
virtual

iterate over the non-zero features

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

possible with subset

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

Implements CDotFeatures.

Definition at line 569 of file DenseFeatures.cpp.

int32_t get_nnz_features_for_vector ( int32_t  num)
virtual

get number of non-zero features in vector

Parameters
numwhich vector
Returns
number of non-zero features in vector

Implements CDotFeatures.

Definition at line 548 of file DenseFeatures.cpp.

int32_t get_num_features ( ) const

get number of features (of possible subset)

Returns
number of features

Definition at line 426 of file DenseFeatures.cpp.

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.

int32_t get_num_preprocessors ( ) const
inherited

get number of preprocessors

Returns
number of preprocessors

Definition at line 155 of file Features.cpp.

int32_t get_num_vectors ( ) const
virtual

get number of feature vectors

Returns
number of feature vectors

Implements CFeatures.

Definition at line 421 of file DenseFeatures.cpp.

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.

CSubsetStack * get_subset_stack ( )
virtualinherited

returns subset stack

Returns
subset stack

Definition at line 334 of file Features.cpp.

CDenseFeatures< ST > * get_transposed ( )

get a transposed copy of the features

possible with subset

Returns
transposed copy

Definition at line 312 of file DenseFeatures.cpp.

ST * get_transposed ( int32_t &  num_feat,
int32_t &  num_vec 
)

compute and return the transpose of the feature matrix which will be prepocessed. num_feat, num_vectors are returned by reference caller has to clean up

possible with subset

Parameters
num_featnumber of features in matrix
num_vecnumber of vectors in matrix
Returns
transposed sparse feature matrix

Definition at line 321 of file DenseFeatures.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 295 of file Features.cpp.

void initialize_cache ( )

Initialize cache

not possible with subset

Definition at line 443 of file DenseFeatures.cpp.

bool is_equal ( CDenseFeatures< ST > *  rhs)
virtual

checks if the contents of this CDenseFeatures object are the same to the contents of rhs

Parameters
rhsother CDenseFeatures object to compare to this one
Returns
whether they represent the same information

Definition at line 942 of file DenseFeatures.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 149 of file Features.cpp.

void list_feature_obj ( ) const
inherited

list feature object

Definition at line 171 of file Features.cpp.

void list_preprocessors ( )
inherited

print preprocessors

Definition at line 131 of file Features.cpp.

void load ( CFile loader)
virtual

load features from file

Parameters
loaderFile object via which to load data

Reimplemented from CFeatures.

Definition at line 1074 of file DenseFeatures.cpp.

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 obtain_from_dot ( CDotFeatures df)

obtain dense features from other dotfeatures

removes any subset before

Parameters
dfdotfeatures to obtain features from

Definition at line 355 of file DenseFeatures.cpp.

CDenseFeatures< ST > * obtain_from_generic ( CFeatures *const  base_features)
static

helper method used to specialize a base class instance

Definition at line 1087 of file DenseFeatures.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 remove_all_subsets ( )
virtualinherited

removes all subsets Calls subset_changed_post() afterwards

Reimplemented in CCombinedFeatures.

Definition at line 328 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 322 of file Features.cpp.

bool reshape ( int32_t  p_num_features,
int32_t  p_num_vectors 
)
virtual

reshape

not possible with subset

Parameters
p_num_featuresnew number of features
p_num_vectorsnew number of vectors
Returns
if reshaping was successful

Reimplemented from CFeatures.

Definition at line 459 of file DenseFeatures.cpp.

void save ( CFile saver)
virtual

save features to file

Parameters
saverFile object via which to save data

Reimplemented from CFeatures.

Definition at line 1082 of file DenseFeatures.cpp.

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_combined_feature_weight ( float64_t  nw)
inherited

set combined kernel weight

Parameters
nwnew combined feature weight

Definition at line 160 of file DotFeatures.h.

void set_feature_matrix ( SGMatrix< ST >  matrix)

Setter for feature matrix

any subset is removed

num_cols is number of feature vectors num_rows is number of dims of vectors see below for definition of feature_matrix

Parameters
matrixfeature matrix to set

Definition at line 296 of file DenseFeatures.cpp.

void set_feature_vector ( SGVector< ST >  vector,
int32_t  num 
)

set feature vector num

possible with subset

Parameters
vectorvector
numindex if vector to set

Definition at line 152 of file DenseFeatures.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.

void set_num_features ( int32_t  num)

set number of features

Parameters
numnumber to set

Definition at line 428 of file DenseFeatures.cpp.

void set_num_vectors ( int32_t  num)

set number of vectors

not possible with subset

Parameters
numnumber to set

Definition at line 434 of file DenseFeatures.cpp.

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.

void set_property ( EFeatureProperty  p)
inherited

set property

Parameters
pkernel property to set

Definition at line 300 of file Features.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.

SGMatrix< ST > steal_feature_matrix ( )

steals feature matrix, i.e. returns matrix and forget about it subset is ignored

Returns
matrix feature matrix

Definition at line 286 of file DenseFeatures.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 305 of file Features.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 196 of file SGObject.cpp.

void vector_subset ( int32_t *  idx,
int32_t  idx_len 
)

Extracts the feature vectors mentioned in idx and replaces them in feature matrix in place.

It does not resize the allocated memory block.

not possible with subset

Parameters
idxindex with examples that shall remain in the feature matrix
idx_lenlength of the index

Note: assumes idx is sorted

Definition at line 206 of file DenseFeatures.cpp.

Member Data Documentation

float64_t combined_weight
protectedinherited

feature weighting in combined dot features

Definition at line 249 of file DotFeatures.h.

CCache<ST>* feature_cache
protected

feature cache

Definition at line 553 of file DenseFeatures.h.

SGMatrix<ST> feature_matrix
protected

Feature matrix and its associated number of vectors and features. Note that num_vectors / num_features above match matrix sizes if feature_matrix.matrix != NULL

Definition at line 550 of file DenseFeatures.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.

int32_t num_features
protected

number of features in cache

Definition at line 544 of file DenseFeatures.h.

int32_t num_vectors
protected

number of vectors in cache

Definition at line 541 of file DenseFeatures.h.

Parallel* parallel
inherited

parallel

Definition at line 464 of file SGObject.h.

Version* version
inherited

version

Definition at line 467 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation