SHOGUN  v1.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Member Functions
CPreprocessor Class Referenceabstract

Detailed Description

Class Preprocessor defines a preprocessor interface.

Preprocessors are transformation functions that doesn't change the domain of the input features. These functions can be applied in-place if the input features fit in memory or can be applied on-the-fly when (depending on features) a feature caching strategy is applied. However, if the individual features are in $\bf{R}$ they have to stay in $\bf{R}$ although the dimensionality of the feature vectors is allowed to be changed.

As preprocessors might need a certain initialization they may expect that the init() function is called before anything else. The actual preprocessing is feature type dependent and thus coordinated in the sub-classes, cf. e.g. CSimplePreprocessor.

Definition at line 74 of file Preprocessor.h.

Inheritance diagram for CPreprocessor:
Inheritance graph
[legend]

Public Member Functions

 CPreprocessor ()
 
virtual ~CPreprocessor ()
 
virtual bool init (CFeatures *features)=0
 
virtual void cleanup ()=0
 
virtual EFeatureType get_feature_type ()=0
 
virtual EFeatureClass get_feature_class ()=0
 
virtual EPreprocessorType get_type () const =0
 
- Public Member Functions inherited from CSGObject
 CSGObject ()
 
 CSGObject (const CSGObject &orig)
 
virtual ~CSGObject ()
 
virtual const char * get_name () const =0
 
virtual bool is_generic (EPrimitiveType *generic) const
 
template<class T >
void set_generic ()
 
void unset_generic ()
 
virtual void print_serializable (const char *prefix="")
 
virtual bool save_serializable (CSerializableFile *file, const char *prefix="")
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
 
void set_global_io (SGIO *io)
 
SGIO * get_global_io ()
 
void set_global_parallel (Parallel *parallel)
 
Parallel * get_global_parallel ()
 
void set_global_version (Version *version)
 
Version * get_global_version ()
 
SGVector< char * > get_modelsel_names ()
 
char * get_modsel_param_descr (const char *param_name)
 
index_t get_modsel_param_index (const char *param_name)
 
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 ()
 

Additional Inherited Members

- Public Attributes inherited from CSGObject
SGIO * io
 
Parallel * parallel
 
Version * version
 
Parameter * m_parameters
 
Parameter * m_model_selection_parameters
 
- Protected Member Functions inherited from CSGObject
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)
 

Constructor & Destructor Documentation

CPreprocessor ( )

constructor

Definition at line 78 of file Preprocessor.h.

virtual ~CPreprocessor ( )
virtual

destructor

Definition at line 83 of file Preprocessor.h.

Member Function Documentation

virtual void cleanup ( )
pure virtual

clean-up. should be called (if necessary) after processing

Implemented in CRandomFourierGaussPreproc, CPCA, CDimensionReductionPreprocessor, CDecompressString< ST >, CKernelPCA, CLogPlusOne, CPruneVarSubMean, CNormOne, CSortWordString, and CSortUlongString.

virtual EFeatureClass get_feature_class ( )
pure virtual
Returns
class of features preprocessor deals with

Implemented in CRandomFourierGaussPreproc, CSparsePreprocessor< ST >, CSimplePreprocessor< ST >, CSimplePreprocessor< float64_t >, CStringPreprocessor< ST >, CStringPreprocessor< uint16_t >, and CStringPreprocessor< uint64_t >.

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

Implemented in CStringPreprocessor< ST >, CStringPreprocessor< ST >, CStringPreprocessor< ST >, CStringPreprocessor< ST >, CStringPreprocessor< ST >, CStringPreprocessor< ST >, CStringPreprocessor< ST >, CStringPreprocessor< ST >, CRandomFourierGaussPreproc, CStringPreprocessor< ST >, CStringPreprocessor< ST >, CSimplePreprocessor< ST >, CStringPreprocessor< ST >, CSimplePreprocessor< ST >, CStringPreprocessor< ST >, CSimplePreprocessor< ST >, CStringPreprocessor< ST >, CSimplePreprocessor< ST >, CSimplePreprocessor< ST >, CSimplePreprocessor< float64_t >, CSimplePreprocessor< ST >, CStringPreprocessor< ST >, CStringPreprocessor< uint16_t >, CStringPreprocessor< uint64_t >, CSimplePreprocessor< ST >, CSimplePreprocessor< ST >, CSimplePreprocessor< ST >, CSimplePreprocessor< ST >, CSimplePreprocessor< ST >, CSimplePreprocessor< ST >, CSimplePreprocessor< ST >, and CSimplePreprocessor< ST >.

virtual EPreprocessorType get_type ( ) const
pure virtual
Returns
the actual type of the preprocessor

Implemented in CRandomFourierGaussPreproc, CPCA, CKernelPCA, CDimensionReductionPreprocessor, CDecompressString< ST >, CLogPlusOne, CNormOne, CPruneVarSubMean, CSortWordString, CSortUlongString, CSparsePreprocessor< ST >, CStringPreprocessor< ST >, CStringPreprocessor< uint16_t >, CStringPreprocessor< uint64_t >, CSimplePreprocessor< ST >, and CSimplePreprocessor< float64_t >.

virtual bool init ( CFeatures *  features)
pure virtual

initialize preprocessor with features

Implemented in CRandomFourierGaussPreproc, CPCA, CDimensionReductionPreprocessor, CKernelPCA, CDecompressString< ST >, CLogPlusOne, CNormOne, CPruneVarSubMean, CSortWordString, and CSortUlongString.

The documentation for this class was generated from the following file:
SHOGUN Machine Learning Toolbox - Documentation