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

Detailed Description

template<class ST>
class shogun::CSimpleFeatures< ST >

The class SimpleFeatures 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:

Definition at line 58 of file SimpleFeatures.h.

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

Public Member Functions

 CSimpleFeatures (int32_t size=0)
 CSimpleFeatures (const CSimpleFeatures &orig)
 CSimpleFeatures (SGMatrix< ST > matrix)
 CSimpleFeatures (ST *src, int32_t num_feat, int32_t num_vec)
 CSimpleFeatures (CFile *loader)
virtual CFeaturesduplicate () const
virtual ~CSimpleFeatures ()
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)
void get_feature_matrix (ST **dst, int32_t *num_feat, int32_t *num_vec)
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)
CSimpleFeatures< ST > * get_transposed ()
ST * get_transposed (int32_t &num_feat, int32_t &num_vec)
virtual void set_feature_matrix (ST *fm, 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_size ()
virtual int32_t get_num_vectors () const
int32_t get_num_features ()
void set_num_features (int32_t num)
void set_num_vectors (int32_t num)
void initialize_cache ()
virtual EFeatureClass get_feature_class ()
virtual EFeatureType get_feature_type ()
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 bool Align_char_features (CStringFeatures< char > *cf, CStringFeatures< char > *Ref, float64_t gapCost)
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 const char * get_name () const
template<>
bool Align_char_features (CStringFeatures< char > *cf, CStringFeatures< char > *Ref, float64_t gapCost)
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)
- Public Member Functions inherited from CDotFeatures
 CDotFeatures (int32_t size=0)
 CDotFeatures (const CDotFeatures &orig)
 CDotFeatures (CFile *loader)
virtual ~CDotFeatures ()
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 ()
- Public Member Functions inherited from CFeatures
 CFeatures (int32_t size=0)
 CFeatures (const CFeatures &orig)
 CFeatures (CFile *loader)
virtual ~CFeatures ()
virtual int32_t add_preprocessor (CPreprocessor *p)
 set preprocessor
virtual CPreprocessordel_preprocessor (int32_t num)
 del current preprocessor
CPreprocessorget_preprocessor (int32_t num)
 get current preprocessor
void set_preprocessed (int32_t num)
bool is_preprocessed (int32_t num)
int32_t get_num_preprocessed ()
 get whether specified preprocessor (or all if num=1) was/were already applied
int32_t get_num_preprocessors () const
void clean_preprocessors ()
int32_t get_cache_size ()
void list_feature_obj ()
bool check_feature_compatibility (CFeatures *f)
bool has_property (EFeatureProperty p)
void set_property (EFeatureProperty p)
void unset_property (EFeatureProperty p)
virtual void set_subset (CSubset *subset)
virtual void remove_subset ()
virtual void subset_changed_post ()
index_t subset_idx_conversion (index_t idx) const
bool has_subset () const
- Public Member Functions inherited from CSGObject
 CSGObject ()
 CSGObject (const CSGObject &orig)
virtual ~CSGObject ()
virtual bool is_generic (EPrimitiveType *generic) const
template<class T >
void set_generic ()
void unset_generic ()
virtual void print_serializable (const char *prefix="")
virtual bool save_serializable (CSerializableFile *file, const char *prefix="")
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
void set_global_io (SGIO *io)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_global_version ()
SGVector< char * > get_modelsel_names ()
char * get_modsel_param_descr (const char *param_name)
index_t get_modsel_param_index (const char *param_name)

Protected Member Functions

virtual ST * compute_feature_vector (int32_t num, int32_t &len, ST *target=NULL)
- Protected Member Functions inherited from CDotFeatures
void display_progress (int32_t start, int32_t stop, int32_t v)

Protected Attributes

int32_t num_vectors
 number of vectors in cache
int32_t num_features
 number of features in cache
ST * feature_matrix
int32_t feature_matrix_num_vectors
int32_t feature_matrix_num_features
CCache< ST > * feature_cache
- Protected Attributes inherited from CDotFeatures
float64_t combined_weight
 feature weighting in combined dot features
- Protected Attributes inherited from CFeatures
CSubsetm_subset

Additional Inherited Members

- Static Public Member Functions inherited from CDotFeatures
static void * dense_dot_range_helper (void *p)
- Public Attributes inherited from CSGObject
SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters

Constructor & Destructor Documentation

CSimpleFeatures ( int32_t  size = 0)

constructor

Parameters
sizecache size

Definition at line 11 of file SimpleFeatures.cpp.

CSimpleFeatures ( const CSimpleFeatures< ST > &  orig)

copy constructor

Definition at line 16 of file SimpleFeatures.cpp.

CSimpleFeatures ( SGMatrix< ST >  matrix)

constructor

Parameters
matrixfeature matrix

Definition at line 26 of file SimpleFeatures.cpp.

CSimpleFeatures ( 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 32 of file SimpleFeatures.cpp.

CSimpleFeatures ( CFile loader)

constructor loading features from file

Parameters
loaderFile object via which to load data

Definition at line 38 of file SimpleFeatures.cpp.

~CSimpleFeatures ( )
virtual

Definition at line 49 of file SimpleFeatures.cpp.

Member Function Documentation

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 520 of file SimpleFeatures.cpp.

bool Align_char_features ( CStringFeatures< char > *  cf,
CStringFeatures< char > *  Ref,
float64_t  gapCost 
)
virtual

align char features

Parameters
cfchar features
Refother char features
gapCostgap cost
Returns
if aligning was successful

Definition at line 551 of file SimpleFeatures.cpp.

bool Align_char_features ( CStringFeatures< char > *  cf,
CStringFeatures< char > *  Ref,
float64_t  gapCost 
)

align strings and compute emperical kernel map based on alignment scores

non functional code - needs updating

Parameters
cfstrings to be aligned to reference
Refreference strings to be aligned to
gapCostcosts for a gap

Definition at line 669 of file SimpleFeatures.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 400 of file SimpleFeatures.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 611 of file SimpleFeatures.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 352 of file SimpleFeatures.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 596 of file SimpleFeatures.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 TODO: where?

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 702 of file SimpleFeatures.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 722 of file SimpleFeatures.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 742 of file SimpleFeatures.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 762 of file SimpleFeatures.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 782 of file SimpleFeatures.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 802 of file SimpleFeatures.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 822 of file SimpleFeatures.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 842 of file SimpleFeatures.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 862 of file SimpleFeatures.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 882 of file SimpleFeatures.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 902 of file SimpleFeatures.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 SimpleFeatures.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 939 of file SimpleFeatures.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 498 of file SimpleFeatures.cpp.

CFeatures * duplicate ( ) const
virtual

duplicate feature object

Returns
feature object

Implements CFeatures.

Definition at line 44 of file SimpleFeatures.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 211 of file SimpleFeatures.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 586 of file SimpleFeatures.cpp.

void free_feature_matrix ( )

free feature matrix

Any subset is removed

Definition at line 58 of file SimpleFeatures.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 166 of file SimpleFeatures.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 175 of file SimpleFeatures.cpp.

void free_features ( )

free feature matrix and cache

Any subset is removed

Definition at line 51 of file SimpleFeatures.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 496 of file SimpleFeatures.cpp.

EFeatureClass get_feature_class ( )
virtual

get feature class

Returns
feature class SIMPLE

Implements CFeatures.

Definition at line 479 of file SimpleFeatures.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 557 of file SimpleFeatures.cpp.

void get_feature_matrix ( ST **  dst,
int32_t *  num_feat,
int32_t *  num_vec 
)

get a copy of the feature matrix num_feat,num_vectors are returned by reference

possible with subset

Parameters
dstdestination to store matrix in
num_featnumber of features (rows of matrix)
num_vecnumber of vectors (columns of matrix)

Definition at line 241 of file SimpleFeatures.cpp.

SGMatrix< ST > get_feature_matrix ( )

Getter for feature matrix

subset is ignored

Returns
matrix feature matrix

Definition at line 268 of file SimpleFeatures.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 299 of file SimpleFeatures.cpp.

virtual EFeatureType get_feature_type ( )
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 69 of file SimpleFeatures.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 150 of file SimpleFeatures.cpp.

virtual const char* get_name ( ) const
virtual
Returns
object name

Implements CSGObject.

Reimplemented in CTOPFeatures, CFKFeatures, and CRealFileFeatures.

Definition at line 500 of file SimpleFeatures.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 573 of file SimpleFeatures.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 545 of file SimpleFeatures.cpp.

int32_t get_num_features ( )

get number of features (of possible subset)

Returns
number of features

Definition at line 448 of file SimpleFeatures.cpp.

int32_t get_num_vectors ( ) const
virtual

get number of feature vectors

Returns
number of feature vectors

Implements CFeatures.

Definition at line 443 of file SimpleFeatures.cpp.

int32_t get_size ( )
virtual

get memory footprint of one feature

Returns
memory footprint of one feature

Implements CFeatures.

Definition at line 441 of file SimpleFeatures.cpp.

CSimpleFeatures< ST > * get_transposed ( )

get a transposed copy of the features

possible with subset

Returns
transposed copy

Definition at line 306 of file SimpleFeatures.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 315 of file SimpleFeatures.cpp.

void initialize_cache ( )

Initialize cache

not possible with subset

Definition at line 465 of file SimpleFeatures.cpp.

virtual void load ( CFile loader)
virtual

load features from file

Parameters
loaderFile object via which to load data

Reimplemented from CFeatures.

void obtain_from_dot ( CDotFeatures df)

obtain simple features from other dotfeatures

removes any subset before

Parameters
dfdotfeatures to obtain features from

Definition at line 372 of file SimpleFeatures.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 481 of file SimpleFeatures.cpp.

virtual void save ( CFile saver)
virtual

save features to file

Parameters
saverFile object via which to save data

Reimplemented from CFeatures.

void set_feature_matrix ( SGMatrix< ST >  matrix)

Setter for feature matrix

any subset is removed

Parameters
matrixfeature matrix to set

Definition at line 288 of file SimpleFeatures.cpp.

void set_feature_matrix ( ST *  fm,
int32_t  num_feat,
int32_t  num_vec 
)
virtual

set feature matrix necessary to set feature_matrix, num_features, num_vectors, 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
fmfeature matrix to se
num_featnumber of features in matrix
num_vecnumber of vectors in matrix

Definition at line 337 of file SimpleFeatures.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 128 of file SimpleFeatures.cpp.

void set_num_features ( int32_t  num)

set number of features

Parameters
numnumber to set

Definition at line 450 of file SimpleFeatures.cpp.

void set_num_vectors ( int32_t  num)

set number of vectors

not possible with subset

Parameters
numnumber to set

Definition at line 456 of file SimpleFeatures.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 273 of file SimpleFeatures.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 180 of file SimpleFeatures.cpp.

Member Data Documentation

CCache<ST>* feature_cache
protected

feature cache

Definition at line 540 of file SimpleFeatures.h.

ST* feature_matrix
protected

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

Definition at line 531 of file SimpleFeatures.h.

int32_t feature_matrix_num_features
protected

number of features in feature matrix

Definition at line 537 of file SimpleFeatures.h.

int32_t feature_matrix_num_vectors
protected

number of vectors in feature matrix

Definition at line 534 of file SimpleFeatures.h.

int32_t num_features
protected

number of features in cache

Definition at line 525 of file SimpleFeatures.h.

int32_t num_vectors
protected

number of vectors in cache

Definition at line 522 of file SimpleFeatures.h.


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

SHOGUN Machine Learning Toolbox - Documentation