SHOGUN
4.1.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 Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
Parameter * | m_gradient_parameters |
uint32_t | m_hash |
Protected Member Functions | |
virtual void | load_serializable_pre () throw (ShogunException) |
virtual void | load_serializable_post () throw (ShogunException) |
virtual void | save_serializable_pre () throw (ShogunException) |
virtual void | save_serializable_post () throw (ShogunException) |
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 597 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 714 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 198 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 618 of file SGObject.cpp.
|
inherited |
|
virtual |
get feature class
Implements CFeatures.
Definition at line 68 of file CombinedFeatures.h.
|
virtualinherited |
Given a class in right hand side, does this class support compatible computation?
for example, is this->dot(rhs_prt) valid, where rhs_prt is the class in right hand side
rhs | the class in right hand side |
Reimplemented in CDenseSubSamplesFeatures< ST >.
Definition at line 355 of file Features.cpp.
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 498 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 522 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 535 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 296 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.
|
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 |
Definition at line 369 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 426 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 421 of file SGObject.cpp.
|
virtualinherited |
Definition at line 262 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 474 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 308 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 |
Definition at line 314 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 436 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 431 of file SGObject.cpp.
|
inherited |
Definition at line 41 of file SGObject.cpp.
|
inherited |
Definition at line 46 of file SGObject.cpp.
|
inherited |
Definition at line 51 of file SGObject.cpp.
|
inherited |
Definition at line 56 of file SGObject.cpp.
|
inherited |
Definition at line 61 of file SGObject.cpp.
|
inherited |
Definition at line 66 of file SGObject.cpp.
|
inherited |
Definition at line 71 of file SGObject.cpp.
|
inherited |
Definition at line 76 of file SGObject.cpp.
|
inherited |
Definition at line 81 of file SGObject.cpp.
|
inherited |
Definition at line 86 of file SGObject.cpp.
|
inherited |
Definition at line 91 of file SGObject.cpp.
|
inherited |
Definition at line 96 of file SGObject.cpp.
|
inherited |
Definition at line 101 of file SGObject.cpp.
|
inherited |
Definition at line 106 of file SGObject.cpp.
|
inherited |
Definition at line 111 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 241 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 283 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 192 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.
|
virtualinherited |
does this class support compatible computation bewteen difference classes? for example, this->dot(rhs_prt), can rhs_prt be an instance of a difference class?
Reimplemented in CDenseSubSamplesFeatures< ST >.
Definition at line 323 of file Features.h.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 303 of file SGObject.cpp.
|
inherited |
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 248 of file SGObject.cpp.
|
protected |
feature array
Definition at line 193 of file CombinedFeatures.h.
|
inherited |
io
Definition at line 369 of file SGObject.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 384 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 387 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 381 of file SGObject.h.
|
inherited |
parameters
Definition at line 378 of file SGObject.h.
|
protectedinherited |
subset used for index transformations
Definition at line 352 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 372 of file SGObject.h.
|
inherited |
version
Definition at line 375 of file SGObject.h.