SHOGUN
4.0.0
|
The class CombinedFeatures is used to combine a number of of feature objects into a single CombinedFeatures object.
It keeps pointers to the added sub-features and is especially useful to combine kernels working on different domains (c.f. CCombinedKernel) and to combine kernels looking at independent features.
Subsets are supported: All actions will just be given through to all sub-features. Only once per sub-feature instance, i.e. if there are two sub-features that are the same instance, the subset action will only be performed once.
Definition at line 38 of file CombinedFeatures.h.
Public Member Functions | |
CCombinedFeatures () | |
CCombinedFeatures (const CCombinedFeatures &orig) | |
virtual CFeatures * | duplicate () const |
virtual | ~CCombinedFeatures () |
virtual EFeatureType | get_feature_type () const |
virtual EFeatureClass | get_feature_class () const |
virtual int32_t | get_num_vectors () const |
void | list_feature_objs () |
bool | check_feature_obj_compatibility (CCombinedFeatures *comb_feat) |
CFeatures * | get_first_feature_obj () |
CFeatures * | get_feature_obj (int32_t idx) |
CFeatures * | get_last_feature_obj () |
bool | insert_feature_obj (CFeatures *obj, int32_t idx) |
bool | append_feature_obj (CFeatures *obj) |
bool | delete_feature_obj (int32_t idx) |
int32_t | get_num_feature_obj () |
CFeatures * | create_merged_copy (CFeatures *other) |
virtual void | add_subset (SGVector< index_t > subset) |
virtual void | remove_subset () |
virtual void | remove_all_subsets () |
virtual CFeatures * | copy_subset (SGVector< index_t > indices) |
virtual const char * | get_name () const |
virtual void | add_preprocessor (CPreprocessor *p) |
virtual void | del_preprocessor (int32_t num) |
CPreprocessor * | get_preprocessor (int32_t num) const |
void | set_preprocessed (int32_t num) |
bool | is_preprocessed (int32_t num) const |
int32_t | get_num_preprocessed () const |
int32_t | get_num_preprocessors () const |
void | clean_preprocessors () |
void | list_preprocessors () |
int32_t | get_cache_size () const |
virtual bool | reshape (int32_t num_features, int32_t num_vectors) |
void | list_feature_obj () const |
virtual void | load (CFile *loader) |
virtual void | save (CFile *writer) |
bool | check_feature_compatibility (CFeatures *f) const |
bool | has_property (EFeatureProperty p) const |
void | set_property (EFeatureProperty p) |
void | unset_property (EFeatureProperty p) |
virtual CFeatures * | create_merged_copy (CList *others) |
virtual void | add_subset_in_place (SGVector< index_t > subset) |
virtual CSubsetStack * | get_subset_stack () |
virtual void | subset_changed_post () |
virtual CFeatures * | copy_dimension_subset (SGVector< index_t > dims) |
virtual CSGObject * | shallow_copy () const |
virtual CSGObject * | deep_copy () const |
virtual bool | is_generic (EPrimitiveType *generic) const |
template<class T > | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
void | unset_generic () |
virtual void | print_serializable (const char *prefix="") |
virtual bool | save_serializable (CSerializableFile *file, const char *prefix="", 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) |
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_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 CSGObject * | clone () |
Public Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
Parameter * | m_gradient_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) |
Protected Attributes | |
CDynamicObjectArray * | feature_array |
int32_t | num_vec |
CSubsetStack * | m_subset_stack |
default constructor
Definition at line 20 of file CombinedFeatures.cpp.
CCombinedFeatures | ( | const CCombinedFeatures & | orig | ) |
copy constructor
Definition at line 29 of file CombinedFeatures.cpp.
|
virtual |
destructor
Definition at line 44 of file CombinedFeatures.cpp.
|
virtualinherited |
adds a subset of indices on top of the current subsets (possibly subset o subset. Calls subset_changed_post() afterwards. Adds the subset to all sub-features
subset | subset of indices to add |
Reimplemented from CFeatures.
Definition at line 222 of file CombinedFeatures.cpp.
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
subset | subset of indices to replace the latest one with. |
Definition at line 316 of file Features.cpp.
bool append_feature_obj | ( | CFeatures * | obj | ) |
append feature object to the end of this CombinedFeatures object array
obj | feature object to append |
Definition at line 141 of file CombinedFeatures.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 1243 of file SGObject.cpp.
|
inherited |
check feature compatibility
f | features to check for compatibility |
Definition at line 283 of file Features.cpp.
bool check_feature_obj_compatibility | ( | CCombinedFeatures * | comb_feat | ) |
check feature object compatibility
comb_feat | feature to check for compatibility |
Definition at line 69 of file CombinedFeatures.cpp.
|
inherited |
clears all preprocs
Definition at line 116 of file Features.cpp.
|
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.
Definition at line 1360 of file SGObject.cpp.
Creates a new CFeatures instance containing only the dimensions of the feature vector which are specified by the provided indices.
This method is needed for feature selection tasks NOT IMPLEMENTED!
dims | indices of feature dimensions to copy |
Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.
Definition at line 348 of file Features.cpp.
Creates a new CFeatures instance containing copies of the elements which are specified by the provided indices. Simply creates a combined features instance where all sub-features are the results of their copy_subset calls
indices | indices of feature elements to copy |
Reimplemented from CFeatures.
Definition at line 304 of file CombinedFeatures.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.
In this case, all sub features are merged
other | feature object to append |
Reimplemented from CFeatures.
Definition at line 177 of file CombinedFeatures.cpp.
Takes a list of feature instances and returns a new instance being a concatenation of a copy of this instace's data and the given instancess data. Note that the feature types have to be equal.
NOT IMPLEMENTED!
others | list of feature objects to append |
Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.
Definition at line 235 of file Features.h.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 200 of file SGObject.cpp.
|
virtualinherited |
delete preprocessor from list
num | index of preprocessor in list |
Definition at line 122 of file Features.cpp.
bool delete_feature_obj | ( | int32_t | idx | ) |
delete feature object at position idx
idx | the index of the feature object to delete |
Definition at line 159 of file CombinedFeatures.cpp.
|
virtual |
duplicate feature object
Implements CFeatures.
Definition at line 39 of file CombinedFeatures.cpp.
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.
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
tolerant | allows linient check on float equality (within accuracy) |
Definition at line 1264 of file SGObject.cpp.
|
inherited |
|
virtual |
get feature class
Implements CFeatures.
Definition at line 68 of file CombinedFeatures.h.
CFeatures * get_feature_obj | ( | int32_t | idx | ) |
get feature object at index idx
idx | index of feature object |
Definition at line 49 of file CombinedFeatures.cpp.
|
virtual |
get feature type
Implements CFeatures.
Definition at line 59 of file CombinedFeatures.h.
CFeatures * get_first_feature_obj | ( | ) |
get first feature object
Definition at line 116 of file CombinedFeatures.cpp.
|
inherited |
|
inherited |
|
inherited |
CFeatures * get_last_feature_obj | ( | ) |
get last feature object
Definition at line 121 of file CombinedFeatures.cpp.
|
inherited |
Definition at line 1135 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 1159 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1172 of file SGObject.cpp.
|
virtual |
int32_t get_num_feature_obj | ( | ) |
get number of feature objects
Definition at line 164 of file CombinedFeatures.cpp.
|
inherited |
get the number of applied preprocs
Definition at line 103 of file Features.cpp.
|
inherited |
get number of preprocessors
Definition at line 155 of file Features.cpp.
|
virtual |
get number of feature vectors
Implements CFeatures.
Definition at line 77 of file CombinedFeatures.h.
|
inherited |
get specified preprocessor
num | index of preprocessor in list |
Definition at line 93 of file Features.cpp.
|
virtualinherited |
|
inherited |
check if features have given property
p | feature property |
Definition at line 295 of file Features.cpp.
bool insert_feature_obj | ( | CFeatures * | obj, |
int32_t | idx | ||
) |
insert feature object at index idx Important, idx must be < num_feature_obj
obj | feature object to insert |
idx | the index where to insert the feature object |
Definition at line 126 of file CombinedFeatures.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 297 of file SGObject.cpp.
|
inherited |
get whether specified preprocessor was already applied
num | index of preprocessor in list |
Definition at line 149 of file Features.cpp.
|
inherited |
list feature object
Definition at line 171 of file Features.cpp.
void list_feature_objs | ( | ) |
list feature objects
Definition at line 54 of file CombinedFeatures.cpp.
|
inherited |
print preprocessors
Definition at line 131 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 269 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::get_version_parameter() for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 704 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 545 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) |
Definition at line 374 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 occurs. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 1062 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 occurs. |
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 1057 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 742 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 949 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 889 of file SGObject.cpp.
|
virtualinherited |
Definition at line 263 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1111 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 309 of file SGObject.cpp.
|
virtual |
removes all subsets Calls subset_changed_post() afterwards
Removes all subsets of all sub-features
Reimplemented from CFeatures.
Definition at line 277 of file CombinedFeatures.cpp.
|
virtual |
removes that last added subset from subset stack, if existing Calls subset_changed_post() afterwards
Removes the subset from all sub-features
Reimplemented from CFeatures.
Definition at line 250 of file CombinedFeatures.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 165 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 276 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) |
Definition at line 315 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 occurs. |
Reimplemented in CKernel.
Definition at line 1072 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 occurs. |
Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 1067 of file SGObject.cpp.
|
inherited |
Definition at line 42 of file SGObject.cpp.
|
inherited |
Definition at line 47 of file SGObject.cpp.
|
inherited |
Definition at line 52 of file SGObject.cpp.
|
inherited |
Definition at line 57 of file SGObject.cpp.
|
inherited |
Definition at line 62 of file SGObject.cpp.
|
inherited |
Definition at line 67 of file SGObject.cpp.
|
inherited |
Definition at line 72 of file SGObject.cpp.
|
inherited |
Definition at line 77 of file SGObject.cpp.
|
inherited |
Definition at line 82 of file SGObject.cpp.
|
inherited |
Definition at line 87 of file SGObject.cpp.
|
inherited |
Definition at line 92 of file SGObject.cpp.
|
inherited |
Definition at line 97 of file SGObject.cpp.
|
inherited |
Definition at line 102 of file SGObject.cpp.
|
inherited |
Definition at line 107 of file SGObject.cpp.
|
inherited |
Definition at line 112 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 243 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 284 of file SGObject.cpp.
|
inherited |
set applied flag for preprocessor
num | index of preprocessor in list |
Definition at line 143 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 194 of file SGObject.cpp.
|
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.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 304 of file SGObject.cpp.
|
inherited |
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 250 of file SGObject.cpp.
|
protected |
feature array
Definition at line 193 of file CombinedFeatures.h.
|
inherited |
io
Definition at line 496 of file SGObject.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 511 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 517 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 508 of file SGObject.h.
|
inherited |
map for different parameter versions
Definition at line 514 of file SGObject.h.
|
inherited |
parameters
Definition at line 505 of file SGObject.h.
|
protectedinherited |
subset used for index transformations
Definition at line 335 of file Features.h.
|
protected |
number of vectors must match between sub features
Definition at line 198 of file CombinedFeatures.h.
|
inherited |
parallel
Definition at line 499 of file SGObject.h.
|
inherited |
version
Definition at line 502 of file SGObject.h.