SHOGUN
v2.0.0
|
Class CMatrixFeatures used to represent data whose feature vectors are better represented with matrices rather than with unidimensional arrays or vectors. Optionally, it can be restricted that all the feature vectors have the same number of features. Set the attribute num_features different to zero to use this restriction. Allow feature vectors with different number of features by setting num_features equal to zero (default behaviour).
Definition at line 29 of file MatrixFeatures.h.
Public Member Functions | |
CMatrixFeatures () | |
CMatrixFeatures (int32_t num_vecs, int32_t num_feats=0) | |
CMatrixFeatures (SGMatrixList< ST > feats, int32_t num_feats=0) | |
CMatrixFeatures (SGMatrix< ST > feats, int32_t feat_length, int32_t num_vecs) | |
virtual CFeatures * | duplicate () const |
virtual | ~CMatrixFeatures () |
virtual EFeatureType | get_feature_type () const |
virtual EFeatureClass | get_feature_class () const |
virtual int32_t | get_num_vectors () const |
virtual int32_t | get_size () const |
SGMatrix< ST > | get_feature_vector (int32_t num) const |
void | get_feature_vector_col (SGVector< ST > out, int32_t num, int32_t col) const |
void | set_feature_vector (SGMatrix< ST > const &vec, int32_t num) |
SGMatrixList< ST > | get_features () const |
void | set_features (SGMatrixList< ST > features, int32_t num_feats) |
virtual const char * | get_name () const |
int32_t | get_num_features () const |
virtual int32_t | add_preprocessor (CPreprocessor *p) |
set preprocessor | |
virtual CPreprocessor * | del_preprocessor (int32_t num) |
del current preprocessor | |
CPreprocessor * | get_preprocessor (int32_t num) const |
get current preprocessor | |
void | set_preprocessed (int32_t num) |
bool | is_preprocessed (int32_t num) const |
int32_t | get_num_preprocessed () const |
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 () 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 CFeatures * | create_merged_copy (CFeatures *other) |
virtual void | add_subset (SGVector< index_t > subset) |
virtual void | remove_subset () |
virtual void | remove_all_subsets () |
virtual CSubsetStack * | get_subset_stack () |
virtual void | subset_changed_post () |
virtual CFeatures * | copy_subset (SGVector< index_t > indices) |
virtual CSGObject * | shallow_copy () const |
virtual CSGObject * | deep_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_PARAMETER) |
virtual bool | load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=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) |
SGIO * | get_global_io () |
void | set_global_parallel (Parallel *parallel) |
Parallel * | get_global_parallel () |
void | set_global_version (Version *version) |
Version * | get_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_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict) |
Public Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
ParameterMap * | m_parameter_map |
uint32_t | m_hash |
Protected Member Functions | |
virtual TParameter * | migrate (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) |
virtual bool | update_parameter_hash () |
Protected Attributes | |
CSubsetStack * | m_subset_stack |
CMatrixFeatures | ( | ) |
default constructor
Definition at line 15 of file MatrixFeatures.cpp.
CMatrixFeatures | ( | int32_t | num_vecs, |
int32_t | num_feats = 0 |
||
) |
standard constructor
num_vecs | number of vectors |
num_feats | number of features per vector |
Definition at line 21 of file MatrixFeatures.cpp.
CMatrixFeatures | ( | SGMatrixList< ST > | feats, |
int32_t | num_feats = 0 |
||
) |
constructor
feats | list of feature matrices |
num_feats | number of features per vector |
Definition at line 32 of file MatrixFeatures.cpp.
CMatrixFeatures | ( | SGMatrix< ST > | feats, |
int32_t | feat_length, | ||
int32_t | num_vecs | ||
) |
constructor using the data of all the features concatenated in a matrix. All the features are assumed to have the same length. The number of colums of feats must be equal to feat_length times num_vecs. The number of features per vector is equal to the number of rows of feats.
feats | concatenation of the features |
feat_length | length of each feature |
num_vecs | number of feature vectors |
Definition at line 40 of file MatrixFeatures.cpp.
|
virtual |
destructor
Definition at line 57 of file MatrixFeatures.cpp.
|
virtualinherited |
set preprocessor
add preprocessor
p | preprocessor to set |
Definition at line 81 of file Features.cpp.
adds a subset of indices on top of the current subsets (possibly subset o subset. Calls subset_changed_post() afterwards
subset | subset of indices to add |
Reimplemented in CCombinedFeatures.
Definition at line 351 of file Features.cpp.
|
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.
dict | dictionary of parameters to be built. |
Definition at line 1204 of file SGObject.cpp.
|
inherited |
check feature compatibility
f | features to check for compatibility |
Definition at line 326 of file Features.cpp.
|
inherited |
clears all preprocs
Definition at line 137 of file Features.cpp.
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!
indices | indices of feature elements to copy |
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 374 of file Features.cpp.
Takes another feature instance and returns a new instance which is a concatenation of a copy if this instace's data and the given instance's data. Note that the feature types have to be equal.
NOT IMPLEMENTED!
other | feature object to append |
Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, and CCombinedFeatures.
Definition at line 234 of file Features.h.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 131 of file SGObject.h.
|
virtualinherited |
del current preprocessor
delete preprocessor from list caller has to clean up returned preproc
num | index of preprocessor in list |
Definition at line 143 of file Features.cpp.
|
virtual |
duplicate feature object
Implements CFeatures.
Definition at line 52 of file MatrixFeatures.cpp.
|
inherited |
|
virtual |
get feature class
Implements CFeatures.
Definition at line 69 of file MatrixFeatures.cpp.
|
virtual |
get feature type
Implements CFeatures.
Definition at line 63 of file MatrixFeatures.cpp.
SGMatrix< ST > get_feature_vector | ( | int32_t | num | ) | const |
get feature vector num
num | feature vector index |
Definition at line 80 of file MatrixFeatures.cpp.
void get_feature_vector_col | ( | SGVector< ST > | out, |
int32_t | num, | ||
int32_t | col | ||
) | const |
get a column of a feature vector
out | where the column will be copied |
num | index of the feature vector |
col | index of the column to get |
Definition at line 92 of file MatrixFeatures.cpp.
SGMatrixList< ST > get_features | ( | ) | const |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Definition at line 1108 of file SGObject.cpp.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
Definition at line 1132 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1145 of file SGObject.cpp.
|
virtual |
int32_t get_num_features | ( | ) | const |
Definition at line 137 of file MatrixFeatures.h.
|
inherited |
get whether specified preprocessor (or all if num=1) was/were already applied
get the number of applied preprocs
Definition at line 123 of file Features.cpp.
|
inherited |
get number of preprocessors
Definition at line 198 of file Features.cpp.
|
virtual |
get number of examples/vectors, possibly corresponding to the current subset
Implements CFeatures.
Definition at line 89 of file MatrixFeatures.h.
|
inherited |
get current preprocessor
get specified preprocessor
num | index of preprocessor in list |
Definition at line 111 of file Features.cpp.
|
virtual |
get memory footprint of one feature
Implements CFeatures.
Definition at line 75 of file MatrixFeatures.cpp.
|
virtualinherited |
|
inherited |
check if features have given property
p | feature property |
Definition at line 336 of file Features.cpp.
|
virtualinherited |
If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.
generic | set to the type of the generic if returning TRUE |
Definition at line 278 of file SGObject.cpp.
|
inherited |
get whether specified preprocessor was already applied
num | index of preprocessor in list |
Definition at line 193 of file Features.cpp.
|
inherited |
list feature object
Definition at line 214 of file Features.cpp.
|
virtualinherited |
load features from file
loader | File object via which data shall be loaded |
Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, CSparseFeatures< ST >, CSparseFeatures< float64_t >, CSparseFeatures< T >, CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, and CStringFeatures< uint16_t >.
Definition at line 312 of file Features.cpp.
|
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)
file_version | parameter version of the file |
current_version | version from which mapping begins (you want to use VERSION_PARAMETER for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 679 of file SGObject.cpp.
|
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
param_info | information of parameter |
file_version | parameter version of the file, must be <= provided parameter version |
file | file to load from |
prefix | prefix for members |
Definition at line 523 of file SGObject.cpp.
|
virtualinherited |
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
file | where to load from |
prefix | prefix for members |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Reimplemented in CModelSelectionParameters.
Definition at line 354 of file SGObject.cpp.
|
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.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CANOVAKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 1033 of file SGObject.cpp.
|
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.
ShogunException | Will be thrown if an error occurres. |
Definition at line 1028 of file SGObject.cpp.
|
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
param_base | set of TParameter instances that are mapped to the provided target parameter infos |
base_version | version of the parameter base |
target_param_infos | set of SGParamInfo instances that specify the target parameter base |
Definition at line 717 of file SGObject.cpp.
|
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
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
Definition at line 923 of file SGObject.cpp.
|
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)
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
replacement | (used as output) here the TParameter instance which is returned by migration is created into |
to_migrate | the only source that is used for migration |
old_name | with this parameter, a name change may be specified |
Definition at line 864 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1084 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 290 of file SGObject.cpp.
|
virtualinherited |
removes all subsets Calls subset_changed_post() afterwards
Reimplemented in CCombinedFeatures.
Definition at line 363 of file Features.cpp.
|
virtualinherited |
removes that last added subset from subset stack, if existing Calls subset_changed_post() afterwards
Reimplemented in CCombinedFeatures.
Definition at line 357 of file Features.cpp.
|
virtualinherited |
in case there is a feature matrix allow for reshaping
NOT IMPLEMENTED!
num_features | new number of features |
num_vectors | new number of vectors |
Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.
Definition at line 208 of file Features.cpp.
|
virtualinherited |
save features to file
writer | File object via which data shall be saved |
Reimplemented in CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, CStringFeatures< uint16_t >, CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, CSparseFeatures< ST >, CSparseFeatures< float64_t >, and CSparseFeatures< T >.
Definition at line 319 of file Features.cpp.
|
virtualinherited |
Save this object to file.
file | where to save the object; will be closed during returning if PREFIX is an empty string. |
prefix | prefix for members |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Reimplemented in CModelSelectionParameters.
Definition at line 296 of file SGObject.cpp.
|
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.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel.
Definition at line 1043 of file SGObject.cpp.
|
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.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel.
Definition at line 1038 of file SGObject.cpp.
void set_feature_vector | ( | SGMatrix< ST > const & | vec, |
int32_t | num | ||
) |
set feature vector num
vec | feature vector |
num | index of vector to set |
Definition at line 126 of file MatrixFeatures.cpp.
void set_features | ( | SGMatrixList< ST > | features, |
int32_t | num_feats | ||
) |
set features
features | to set |
num_feats | number of features per vector |
Definition at line 146 of file MatrixFeatures.cpp.
|
inherited |
set generic type to T
Definition at line 41 of file SGObject.cpp.
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 230 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 265 of file SGObject.cpp.
|
inherited |
set applied flag for preprocessor
num | index of preprocessor in list |
Definition at line 188 of file Features.cpp.
|
inherited |
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 122 of file SGObject.h.
|
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 262 of file Features.h.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 285 of file SGObject.cpp.
|
inherited |
|
protectedvirtualinherited |
Updates the hash of current parameter combination.
Definition at line 237 of file SGObject.cpp.
|
inherited |
io
Definition at line 462 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 480 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 474 of file SGObject.h.
|
inherited |
map for different parameter versions
Definition at line 477 of file SGObject.h.
|
inherited |
parameters
Definition at line 471 of file SGObject.h.
|
protectedinherited |
subset used for index transformations
Definition at line 296 of file Features.h.
|
inherited |
parallel
Definition at line 465 of file SGObject.h.
|
inherited |
version
Definition at line 468 of file SGObject.h.