SHOGUN  6.1.3
List of all members | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CDependenceMaximization Class Referenceabstract

Detailed Description

Class CDependenceMaximization, base class for all feature selection preprocessors which select a subset of features that shows maximum dependence between the features and the labels. This is done via an implementation of CIndependenceTest, m_estimator inside compute_measures() (see class documentation of CFeatureSelection), which performs a statistical test for a given feature \(\mathbf{X}_i\) from the set of features \(\mathbf{X}\), and the labels \(\mathbf{Y}\). The test checks

\[ \textbf{H}_0 : P\left(\mathbf{X}\setminus \mathbf{X}_i, \mathbf{Y}\right) =P\left(\mathbf{X}\setminus \mathbf{X}_i\right)P\left(\mathbf{Y}\right) \]

The test statistic is then used as a measure which signifies the independence between the rest of the features and the labels - higher the value of the test statistic, greater the dependency between the rest of the features and the class labels, and therefore lesser significant the current feature becomes. Therefore, highest scoring features are removed. The removal policy thus can only be shogun::N_LARGEST and shogun::PERCENTILE_LARGEST and it can be set via set_policy() call. remove_feats() method handles the removal of features based on the specified policy.

The estimator cannot be set via user interface, rather its subclasses initialize this estimator with appropriate instances internally.

This class also overrides set_labels() method to create a feature object from the labels and sets this as features \(\mathbf{Y}\sim q\) to the estimator which is required to compute the measure.

Definition at line 70 of file DependenceMaximization.h.

Inheritance diagram for CDependenceMaximization:
[legend]

Public Types

typedef rxcpp::subjects::subject< ObservedValueSGSubject
 
typedef rxcpp::observable< ObservedValue, rxcpp::dynamic_observable< ObservedValue > > SGObservable
 
typedef rxcpp::subscriber< ObservedValue, rxcpp::observer< ObservedValue, void, void, void, void > > SGSubscriber
 

Public Member Functions

 CDependenceMaximization ()
 
virtual ~CDependenceMaximization ()
 
virtual float64_t compute_measures (CFeatures *features, index_t idx)
 
virtual CFeaturesremove_feats (CFeatures *features, SGVector< index_t > ranks)
 
virtual void set_policy (EFeatureRemovalPolicy policy)
 
virtual void set_algorithm (EFeatureSelectionAlgorithm algorithm)=0
 
virtual bool init (CFeatures *features)
 
virtual void set_labels (CLabels *labels)
 
virtual const char * get_name () const
 
virtual CFeaturesapply (CFeatures *features)
 
SGVector< index_tget_selected_feats ()
 
virtual EFeatureClass get_feature_class ()
 
virtual EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
EFeatureType get_feature_type ()
 
virtual EPreprocessorType get_type () const
 
void set_target_dim (index_t target_dim)
 
index_t get_target_dim () const
 
EFeatureSelectionAlgorithm get_algorithm () const
 
EFeatureRemovalPolicy get_policy () const
 
void set_num_remove (index_t num_remove)
 
index_t get_num_remove () const
 
CLabelsget_labels () const
 
virtual void cleanup ()
 
int32_t ref ()
 
int32_t ref_count ()
 
int32_t unref ()
 
virtual CSGObjectshallow_copy () const
 
virtual CSGObjectdeep_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="")
 
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 ()
 
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)
 
bool has (const std::string &name) const
 
template<typename T >
bool has (const Tag< T > &tag) const
 
template<typename T , typename U = void>
bool has (const std::string &name) const
 
template<typename T >
void set (const Tag< T > &_tag, const T &value)
 
template<typename T , typename U = void>
void set (const std::string &name, const T &value)
 
template<typename T >
get (const Tag< T > &_tag) const
 
template<typename T , typename U = void>
get (const std::string &name) const
 
SGObservableget_parameters_observable ()
 
void subscribe_to_parameters (ParameterObserverInterface *obs)
 
void list_observable_parameters ()
 
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 ()
 

Public Attributes

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
uint32_t m_hash
 

Protected Member Functions

virtual CFeaturescreate_transformed_copy (CFeatures *features, index_t idx)
 
virtual CFeaturesapply_backward_elimination (CFeatures *features)
 
virtual void precompute ()
 
virtual void adapt_params (CFeatures *features)
 
index_t get_num_features (CFeatures *features) const
 
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)
 
template<typename T >
void register_param (Tag< T > &_tag, const T &value)
 
template<typename T >
void register_param (const std::string &name, const T &value)
 
bool clone_parameters (CSGObject *other)
 
void observe (const ObservedValue value)
 
void register_observable_param (const std::string &name, const SG_OBS_VALUE_TYPE type, const std::string &description)
 

Protected Attributes

CIndependenceTestm_estimator
 
CFeaturesm_labels_feats
 
index_t m_target_dim
 
EFeatureSelectionAlgorithm m_algorithm
 
EFeatureRemovalPolicy m_policy
 
index_t m_num_remove
 
CLabelsm_labels
 
CSubsetStackm_subset
 

Member Typedef Documentation

◆ SGObservable

Definition at line 130 of file SGObject.h.

◆ SGSubject

Definition at line 127 of file SGObject.h.

◆ SGSubscriber

typedef rxcpp::subscriber< ObservedValue, rxcpp::observer<ObservedValue, void, void, void, void> > SGSubscriber
inherited

Definition at line 133 of file SGObject.h.

Constructor & Destructor Documentation

◆ CDependenceMaximization()

Default constructor

Definition at line 40 of file DependenceMaximization.cpp.

◆ ~CDependenceMaximization()

Destructor

Definition at line 57 of file DependenceMaximization.cpp.

Member Function Documentation

◆ adapt_params()

void adapt_params ( CFeatures features)
protectedvirtualinherited

Tunes the parameters which are required to compute the measure based on current features. Overridden in the subclasses. Here it does nothing.

Parameters
featuresthe features based on which parameters are needed to be tuned for computing measures

Definition at line 219 of file FeatureSelection.cpp.

◆ apply()

CFeatures * apply ( CFeatures features)
virtualinherited

Generic interface for applying the feature selection preprocessor. Acts as a wrapper which decides which actual method to call based on the algorithm specified.

Parameters
featuresthe input features
Returns
the result feature object after applying the preprocessor

Implements CPreprocessor.

Definition at line 173 of file FeatureSelection.cpp.

◆ apply_backward_elimination()

CFeatures * apply_backward_elimination ( CFeatures features)
protectedvirtualinherited

Applies backward elimination algorithm for performing feature selection. After performing necessary precomputing (defined by subclasses), it iteratively eliminates a number of features based on a measure until target dimension is reached.

Parameters
featuresthe input features
Returns
the result feature object after applying the preprocessor

Definition at line 87 of file FeatureSelection.cpp.

◆ build_gradient_parameter_dictionary()

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 635 of file SGObject.cpp.

◆ cleanup()

void cleanup ( )
virtualinherited

performs cleanup

Implements CPreprocessor.

Definition at line 81 of file FeatureSelection.cpp.

◆ clone()

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

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicObjectArray, CAlphabet, and CMKL.

Definition at line 734 of file SGObject.cpp.

◆ clone_parameters()

bool clone_parameters ( CSGObject other)
protectedinherited

Definition at line 759 of file SGObject.cpp.

◆ compute_measures()

float64_t compute_measures ( CFeatures features,
index_t  idx 
)
virtual

Method that computes the measures using test statistic computed by an instance of CIndependenceTest wiht the provided features and the labels

Parameters
featuresthe features on which the measure has to be computed
idxthe index that decides which features should we compute the measure on
Returns
the measure based on which features are selected

Implements CFeatureSelection< float64_t >.

Definition at line 106 of file DependenceMaximization.cpp.

◆ create_transformed_copy()

CFeatures * create_transformed_copy ( CFeatures features,
index_t  idx 
)
protectedvirtual

Helper method which removes the dimension specified via the index. It copies the rest of the features into a separate object via copy_dimension_subset() call.

Parameters
featuresthe features
idxindex of the dimension which is required to be removed
Returns
a new feature object with the specified dimension removed

Definition at line 78 of file DependenceMaximization.cpp.

◆ deep_copy()

CSGObject * deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

Definition at line 232 of file SGObject.cpp.

◆ equals()

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 656 of file SGObject.cpp.

◆ get() [1/2]

T get ( const Tag< T > &  _tag) const
inherited

Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
_tagname and type information of parameter
Returns
value of the parameter identified by the input tag

Definition at line 381 of file SGObject.h.

◆ get() [2/2]

T get ( const std::string &  name) const
inherited

Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
namename of the parameter
Returns
value of the parameter corresponding to the input name and type

Definition at line 404 of file SGObject.h.

◆ get_algorithm()

EFeatureSelectionAlgorithm get_algorithm ( ) const
inherited
Returns
the feature removal algorithm being used

Definition at line 283 of file FeatureSelection.cpp.

◆ get_feature_class()

EFeatureClass get_feature_class ( )
virtualinherited
Returns
the feature class, shogun::C_ANY

Implements CPreprocessor.

Definition at line 322 of file FeatureSelection.cpp.

◆ get_feature_type() [1/14]

virtual EFeatureType get_feature_type ( )
virtualinherited
Returns
feature type

Implements CPreprocessor.

◆ get_feature_type() [2/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 334 of file FeatureSelection.cpp.

◆ get_feature_type() [3/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 340 of file FeatureSelection.cpp.

◆ get_feature_type() [4/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 346 of file FeatureSelection.cpp.

◆ get_feature_type() [5/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 352 of file FeatureSelection.cpp.

◆ get_feature_type() [6/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 358 of file FeatureSelection.cpp.

◆ get_feature_type() [7/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 364 of file FeatureSelection.cpp.

◆ get_feature_type() [8/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 370 of file FeatureSelection.cpp.

◆ get_feature_type() [9/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 376 of file FeatureSelection.cpp.

◆ get_feature_type() [10/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 382 of file FeatureSelection.cpp.

◆ get_feature_type() [11/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 388 of file FeatureSelection.cpp.

◆ get_feature_type() [12/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 394 of file FeatureSelection.cpp.

◆ get_feature_type() [13/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 400 of file FeatureSelection.cpp.

◆ get_feature_type() [14/14]

EFeatureType get_feature_type ( )
virtualinherited
Returns
type of objects preprocessor can deal with

Implements CPreprocessor.

Definition at line 406 of file FeatureSelection.cpp.

◆ get_global_io()

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 269 of file SGObject.cpp.

◆ get_global_parallel()

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 311 of file SGObject.cpp.

◆ get_global_version()

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 324 of file SGObject.cpp.

◆ get_labels()

CLabels * get_labels ( ) const
inherited
Returns
the labels

Definition at line 315 of file FeatureSelection.cpp.

◆ get_modelsel_names()

SGStringList< char > get_modelsel_names ( )
inherited
Returns
vector of names of all parameters which are registered for model selection

Definition at line 536 of file SGObject.cpp.

◆ get_modsel_param_descr()

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 560 of file SGObject.cpp.

◆ get_modsel_param_index()

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 573 of file SGObject.cpp.

◆ get_name()

virtual const char* get_name ( ) const
virtual
Returns
the class name

Reimplemented from CFeatureSelection< float64_t >.

Definition at line 136 of file DependenceMaximization.h.

◆ get_num_features()

index_t get_num_features ( CFeatures features) const
protectedinherited

Returns the number of features of the provided feature object. Since the number of features doesn't make sense for all types of features, this helper method checks whether obtaining a num_features is possible and then calls get_num_features() on those features after proper type-cast

Parameters
featuresthe feature object
Returns
the number of features

Definition at line 241 of file FeatureSelection.cpp.

◆ get_num_remove()

index_t get_num_remove ( ) const
inherited
Returns
number or percentage of features removed in each iteration

Definition at line 301 of file FeatureSelection.cpp.

◆ get_parameters_observable()

SGObservable* get_parameters_observable ( )
inherited

Get parameters observable

Returns
RxCpp observable

Definition at line 415 of file SGObject.h.

◆ get_policy()

EFeatureRemovalPolicy get_policy ( ) const
inherited
Returns
the feature removal policy being used

Definition at line 289 of file FeatureSelection.cpp.

◆ get_selected_feats()

SGVector< index_t > get_selected_feats ( )
inherited
Returns
indices of selected features

Definition at line 224 of file FeatureSelection.cpp.

◆ get_target_dim()

index_t get_target_dim ( ) const
inherited
Returns
the target dimension

Definition at line 277 of file FeatureSelection.cpp.

◆ get_type()

EPreprocessorType get_type ( ) const
virtualinherited
Returns
the preprocessor type

Implements CPreprocessor.

Definition at line 328 of file FeatureSelection.cpp.

◆ has() [1/3]

bool has ( const std::string &  name) const
inherited

Checks if object has a class parameter identified by a name.

Parameters
namename of the parameter
Returns
true if the parameter exists with the input name

Definition at line 304 of file SGObject.h.

◆ has() [2/3]

bool has ( const Tag< T > &  tag) const
inherited

Checks if object has a class parameter identified by a Tag.

Parameters
tagtag of the parameter containing name and type information
Returns
true if the parameter exists with the input tag

Definition at line 315 of file SGObject.h.

◆ has() [3/3]

bool has ( const std::string &  name) const
inherited

Checks if a type exists for a class parameter identified by a name.

Parameters
namename of the parameter
Returns
true if the parameter exists with the input name and type

Definition at line 326 of file SGObject.h.

◆ init()

bool init ( CFeatures features)
virtual

Initialize preprocessor from features

Parameters
featuresthe features
Returns
true if init was successful

Implements CPreprocessor.

Definition at line 63 of file DependenceMaximization.cpp.

◆ is_generic()

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 330 of file SGObject.cpp.

◆ list_observable_parameters()

void list_observable_parameters ( )
inherited

Print to stdout a list of observable parameters

Definition at line 878 of file SGObject.cpp.

◆ load_serializable()

bool load_serializable ( CSerializableFile file,
const char *  prefix = "" 
)
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
Returns
TRUE if done, otherwise FALSE

Definition at line 403 of file SGObject.cpp.

◆ load_serializable_post()

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 occurs.

Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 460 of file SGObject.cpp.

◆ load_serializable_pre()

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 occurs.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 455 of file SGObject.cpp.

◆ observe()

void observe ( const ObservedValue  value)
protectedinherited

Observe a parameter value and emit them to observer.

Parameters
valueObserved parameter's value

Definition at line 828 of file SGObject.cpp.

◆ parameter_hash_changed()

bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 296 of file SGObject.cpp.

◆ precompute()

void precompute ( )
protectedvirtualinherited

Performs the tasks which can be computed beforehand before the actual algorithm begins. This method is overridden in the subclasses. Here it does nothing.

Definition at line 214 of file FeatureSelection.cpp.

◆ print_modsel_params()

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 512 of file SGObject.cpp.

◆ print_serializable()

void print_serializable ( const char *  prefix = "")
virtualinherited

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 342 of file SGObject.cpp.

◆ ref()

int32_t ref ( )
inherited

increase reference counter

Returns
reference count

Definition at line 186 of file SGObject.cpp.

◆ ref_count()

int32_t ref_count ( )
inherited

display reference counter

Returns
reference count

Definition at line 193 of file SGObject.cpp.

◆ register_observable_param()

void register_observable_param ( const std::string &  name,
const SG_OBS_VALUE_TYPE  type,
const std::string &  description 
)
protectedinherited

Register which params this object can emit.

Parameters
namethe param name
typethe param type
descriptiona user oriented description

Definition at line 871 of file SGObject.cpp.

◆ register_param() [1/2]

void register_param ( Tag< T > &  _tag,
const T &  value 
)
protectedinherited

Registers a class parameter which is identified by a tag. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters
_tagname and type information of parameter
valuevalue of the parameter

Definition at line 472 of file SGObject.h.

◆ register_param() [2/2]

void register_param ( const std::string &  name,
const T &  value 
)
protectedinherited

Registers a class parameter which is identified by a name. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 485 of file SGObject.h.

◆ remove_feats()

CFeatures * remove_feats ( CFeatures features,
SGVector< index_t ranks 
)
virtual

Method which handles the removal of features based on removal policy. see documentation of CFeatureSelection. For dependence maximization approach, the highest scoring features are removed. Therefore, only m_policy can only be shogun::N_LARGEST, shogun::PERCENTILE_LARGEST. See set_policy() method for specifying the exact policy

Parameters
featuresthe features object from which specific features has to be removed
ranksthe ranks of the features based on their measures, 0 being the lowest rank which corresponds to smallest measure.
Returns
the feature object after removal of features based on the policy

Implements CFeatureSelection< float64_t >.

Definition at line 130 of file DependenceMaximization.cpp.

◆ save_serializable()

bool save_serializable ( CSerializableFile file,
const char *  prefix = "" 
)
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
Returns
TRUE if done, otherwise FALSE

Definition at line 348 of file SGObject.cpp.

◆ save_serializable_post()

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 occurs.

Reimplemented in CKernel.

Definition at line 470 of file SGObject.cpp.

◆ save_serializable_pre()

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 occurs.

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 465 of file SGObject.cpp.

◆ set() [1/2]

void set ( const Tag< T > &  _tag,
const T &  value 
)
inherited

Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
_tagname and type information of parameter
valuevalue of the parameter

Definition at line 342 of file SGObject.h.

◆ set() [2/2]

void set ( const std::string &  name,
const T &  value 
)
inherited

Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 368 of file SGObject.h.

◆ set_algorithm()

virtual void set_algorithm ( EFeatureSelectionAlgorithm  algorithm)
pure virtual

Abstract method which is overridden in the subclasses to set accepted feature selection algorithm

Parameters
algorithmthe feature selection algorithm to use

Implements CFeatureSelection< float64_t >.

◆ set_generic() [1/16]

void set_generic ( )
inherited

Definition at line 73 of file SGObject.cpp.

◆ set_generic() [2/16]

void set_generic ( )
inherited

Definition at line 78 of file SGObject.cpp.

◆ set_generic() [3/16]

void set_generic ( )
inherited

Definition at line 83 of file SGObject.cpp.

◆ set_generic() [4/16]

void set_generic ( )
inherited

Definition at line 88 of file SGObject.cpp.

◆ set_generic() [5/16]

void set_generic ( )
inherited

Definition at line 93 of file SGObject.cpp.

◆ set_generic() [6/16]

void set_generic ( )
inherited

Definition at line 98 of file SGObject.cpp.

◆ set_generic() [7/16]

void set_generic ( )
inherited

Definition at line 103 of file SGObject.cpp.

◆ set_generic() [8/16]

void set_generic ( )
inherited

Definition at line 108 of file SGObject.cpp.

◆ set_generic() [9/16]

void set_generic ( )
inherited

Definition at line 113 of file SGObject.cpp.

◆ set_generic() [10/16]

void set_generic ( )
inherited

Definition at line 118 of file SGObject.cpp.

◆ set_generic() [11/16]

void set_generic ( )
inherited

Definition at line 123 of file SGObject.cpp.

◆ set_generic() [12/16]

void set_generic ( )
inherited

Definition at line 128 of file SGObject.cpp.

◆ set_generic() [13/16]

void set_generic ( )
inherited

Definition at line 133 of file SGObject.cpp.

◆ set_generic() [14/16]

void set_generic ( )
inherited

Definition at line 138 of file SGObject.cpp.

◆ set_generic() [15/16]

void set_generic ( )
inherited

Definition at line 143 of file SGObject.cpp.

◆ set_generic() [16/16]

void set_generic ( )
inherited

set generic type to T

◆ set_global_io()

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 262 of file SGObject.cpp.

◆ set_global_parallel()

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 275 of file SGObject.cpp.

◆ set_global_version()

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 317 of file SGObject.cpp.

◆ set_labels()

void set_labels ( CLabels labels)
virtual

Setter for labels. This method is overridden to internally convert the labels to a dense feature object and set this feature in the independence test estimator. These labels serve as samples \(\mathbf{Y}\sim q\) in the independence test

Parameters
labelsthe labels

Reimplemented from CFeatureSelection< float64_t >.

Definition at line 187 of file DependenceMaximization.cpp.

◆ set_num_remove()

void set_num_remove ( index_t  num_remove)
inherited

Use this method to set the number or percentile of features to be removed in each iteration.

Parameters
num_removenumber or percentage of features to be removed in each iteration

Definition at line 295 of file FeatureSelection.cpp.

◆ set_policy()

void set_policy ( EFeatureRemovalPolicy  policy)
virtual
Parameters
policyfeature removal policy

Implements CFeatureSelection< float64_t >.

Definition at line 179 of file DependenceMaximization.cpp.

◆ set_target_dim()

void set_target_dim ( index_t  target_dim)
inherited
Parameters
target_dimthe target dimension to achieve

Definition at line 271 of file FeatureSelection.cpp.

◆ shallow_copy()

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 226 of file SGObject.cpp.

◆ subscribe_to_parameters()

void subscribe_to_parameters ( ParameterObserverInterface obs)
inherited

Subscribe a parameter observer to watch over params

Definition at line 811 of file SGObject.cpp.

◆ unref()

int32_t unref ( )
inherited

decrement reference counter and deallocate object if refcount is zero before or after decrementing it

Returns
reference count

Definition at line 200 of file SGObject.cpp.

◆ unset_generic()

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 337 of file SGObject.cpp.

◆ update_parameter_hash()

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 282 of file SGObject.cpp.

Member Data Documentation

◆ io

SGIO* io
inherited

io

Definition at line 600 of file SGObject.h.

◆ m_algorithm

EFeatureSelectionAlgorithm m_algorithm
protectedinherited

Wrapper algorithm for feature selection

Definition at line 302 of file FeatureSelection.h.

◆ m_estimator

CIndependenceTest* m_estimator
protected

The estimator for performing statistical tests for independence which is used for computing measures

Definition at line 157 of file DependenceMaximization.h.

◆ m_gradient_parameters

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 615 of file SGObject.h.

◆ m_hash

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 618 of file SGObject.h.

◆ m_labels

CLabels* m_labels
protectedinherited

The labels for the feature vectors

Definition at line 316 of file FeatureSelection.h.

◆ m_labels_feats

CFeatures* m_labels_feats
protected

The feature for the labels

Definition at line 160 of file DependenceMaximization.h.

◆ m_model_selection_parameters

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 612 of file SGObject.h.

◆ m_num_remove

index_t m_num_remove
protectedinherited

Number or percentage of features to be removed. When the policy is set as shogun::N_SMALLEST or shogun::N_LARGEST, this number decides how many features in an iteration. For shogun::PERCENTILE_SMALLEST or shogun::PERCENTILE_LARGEST, this decides the percentage of current number of features to be removed in each iteration

Definition at line 313 of file FeatureSelection.h.

◆ m_parameters

Parameter* m_parameters
inherited

parameters

Definition at line 609 of file SGObject.h.

◆ m_policy

EFeatureRemovalPolicy m_policy
protectedinherited

Feature removal policy

Definition at line 305 of file FeatureSelection.h.

◆ m_subset

CSubsetStack* m_subset
protectedinherited

The indices of features that are selected

Definition at line 319 of file FeatureSelection.h.

◆ m_target_dim

index_t m_target_dim
protectedinherited

Target dimension

Definition at line 299 of file FeatureSelection.h.

◆ parallel

Parallel* parallel
inherited

parallel

Definition at line 603 of file SGObject.h.

◆ version

Version* version
inherited

version

Definition at line 606 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation