CClassifier Class Reference


Detailed Description

A generic classifier interface.

A classifier takes as input CLabels. Later subclasses may specialize the classifier to require labels and a kernel or labels and (real-valued) features.

A classifier needs to override the train() function for training, the function classify_example() (optionally classify() to predict on the whole set of examples) and the load and save routines.

Definition at line 73 of file Classifier.h.

Inheritance diagram for CClassifier:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CClassifier ()
virtual ~CClassifier ()
virtual bool train ()
virtual CLabelsclassify (CLabels *output=NULL)
virtual float64_t classify_example (int32_t num)
virtual bool load (FILE *srcfile)
virtual bool save (FILE *dstfile)
virtual void set_labels (CLabels *lab)
virtual CLabelsget_labels ()
virtual float64_t get_label (int32_t i)
void set_max_train_time (float64_t t)
float64_t get_max_train_time ()
virtual EClassifierType get_classifier_type ()
void set_solver_type (ESolverType st)
ESolverType get_solver_type ()

Protected Attributes

float64_t max_train_time
CLabelslabels
ESolverType solver_type

Constructor & Destructor Documentation

CClassifier::CClassifier (  ) 

constructor

Definition at line 13 of file Classifier.cpp.

CClassifier::~CClassifier (  )  [virtual]

Definition at line 18 of file Classifier.cpp.


Member Function Documentation

CLabels * CClassifier::classify ( CLabels output = NULL  )  [virtual]

classify object

Parameters:
output classified labels
Returns:
classified labels

Reimplemented in CKNN, CLinearClassifier, CPluginEstimate, CMultiClassSVM, CSVM, CWDSVMOcas, CKernelMachine, and CKRR.

Definition at line 23 of file Classifier.cpp.

virtual float64_t CClassifier::classify_example ( int32_t  num  )  [virtual]

classify one example

abstract base method

Parameters:
num which example to classify
Returns:
infinite float value

Reimplemented in CKernelPerceptron, CKNN, CLinearClassifier, CPluginEstimate, CMultiClassSVM, CSVM, CWDSVMOcas, and CKRR.

Definition at line 100 of file Classifier.h.

virtual EClassifierType CClassifier::get_classifier_type (  )  [virtual]
virtual float64_t CClassifier::get_label ( int32_t  i  )  [virtual]

get one specific label

Parameters:
i index of label to get
Returns:
value of label at index i

Definition at line 142 of file Classifier.h.

virtual CLabels* CClassifier::get_labels (  )  [virtual]

get labels

Returns:
labels

Definition at line 135 of file Classifier.h.

float64_t CClassifier::get_max_train_time (  ) 

get maximum training time

Returns:
maximum training time

Definition at line 154 of file Classifier.h.

ESolverType CClassifier::get_solver_type (  ) 

get solver type

Returns:
solver

Definition at line 172 of file Classifier.h.

virtual bool CClassifier::load ( FILE *  srcfile  )  [virtual]

load Classifier from file

abstract base method

Parameters:
srcfile file to load from
Returns:
failure

Reimplemented in CKernelPerceptron, CKNN, CLinearClassifier, CMultiClassSVM, CSVM, CHierarchical, CKMeans, and CKRR.

Definition at line 109 of file Classifier.h.

virtual bool CClassifier::save ( FILE *  dstfile  )  [virtual]

save Classifier to file

abstract base method

Parameters:
dstfile file to save to
Returns:
failure

Reimplemented in CKernelPerceptron, CKNN, CLinearClassifier, CMultiClassSVM, CSVM, CHierarchical, CKMeans, and CKRR.

Definition at line 118 of file Classifier.h.

virtual void CClassifier::set_labels ( CLabels lab  )  [virtual]

set labels

Parameters:
lab labels

Definition at line 124 of file Classifier.h.

void CClassifier::set_max_train_time ( float64_t  t  ) 

set maximum training time

Parameters:
t maximimum training time

Definition at line 148 of file Classifier.h.

void CClassifier::set_solver_type ( ESolverType  st  ) 

set solver type

Parameters:
st solver type

Definition at line 166 of file Classifier.h.

virtual bool CClassifier::train (  )  [virtual]

Member Data Documentation

labels

Definition at line 179 of file Classifier.h.

maximum training time

Definition at line 176 of file Classifier.h.

solver type

Definition at line 182 of file Classifier.h.


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

SHOGUN Machine Learning Toolbox - Documentation