CPreProc Class Reference

Inheritance diagram for CPreProc:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 CPreProc (const char *name, const char *id)
virtual ~CPreProc ()
virtual bool init (CFeatures *f)=0
 initialize preprocessor from features
virtual bool load_init_data (FILE *src)=0
 initialize preprocessor from file
virtual bool save_init_data (FILE *dst)=0
 save init-data (like transforamtion matrices etc) to file
virtual void cleanup ()=0
 cleanup
virtual EFeatureType get_feature_type ()=0
virtual EFeatureClass get_feature_class ()=0
const char * get_name () const
 return the name of the preprocessor
const char * get_id () const
 return a FOUR letter id of the preprocessor

Protected Attributes

const char * preproc_name
const char * preproc_id


Detailed Description

Class PreProc defines a preprocessor interface. Preprocessors are transformation functions that don'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 change.

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

Definition at line 48 of file PreProc.h.


Constructor & Destructor Documentation

CPreProc::CPreProc ( const char *  name,
const char *  id 
)

constructor

Parameters:
name preprocessor's name
id preprocessor's id

Definition at line 15 of file PreProc.cpp.

CPreProc::~CPreProc (  )  [virtual]

Definition at line 21 of file PreProc.cpp.


Member Function Documentation

virtual void CPreProc::cleanup (  )  [pure virtual]

virtual EFeatureClass CPreProc::get_feature_class (  )  [pure virtual]

virtual EFeatureType CPreProc::get_feature_type (  )  [pure virtual]

const char* CPreProc::get_id (  )  const

return a FOUR letter id of the preprocessor

Definition at line 84 of file PreProc.h.

const char* CPreProc::get_name (  )  const

return the name of the preprocessor

Definition at line 81 of file PreProc.h.

virtual bool CPreProc::init ( CFeatures f  )  [pure virtual]

initialize preprocessor from features

Implemented in CLogPlusOne, CNormDerivativeLem3, CNormOne, CPCACut, CPruneVarSubMean, CSortUlongString, and CSortWordString.

virtual bool CPreProc::load_init_data ( FILE *  src  )  [pure virtual]

initialize preprocessor from file

Implemented in CLogPlusOne, CNormOne, CPCACut, CPruneVarSubMean, CSortUlongString, and CSortWordString.

virtual bool CPreProc::save_init_data ( FILE *  dst  )  [pure virtual]

save init-data (like transforamtion matrices etc) to file

Implemented in CLogPlusOne, CNormOne, CPCACut, CPruneVarSubMean, CSortUlongString, and CSortWordString.


Member Data Documentation

const char* CPreProc::preproc_id [protected]

preprocessor id

Definition at line 90 of file PreProc.h.

const char* CPreProc::preproc_name [protected]

preprocessor name

Definition at line 88 of file PreProc.h.


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

SHOGUN Machine Learning Toolbox - Documentation