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

Detailed Description

Class Evaluation, a base class for other classes used to evaluate labels, e.g. accuracy of classification or mean squared error of regression.

This class provides only interface for evaluation measures.

Definition at line 36 of file Evaluation.h.

Inheritance diagram for CEvaluation:
Inheritance graph
[legend]

Public Member Functions

 CEvaluation ()
virtual ~CEvaluation ()
virtual float64_t evaluate (CLabels *predicted, CLabels *ground_truth)=0
virtual EEvaluationDirection get_evaluation_direction ()=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)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_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)

Additional Inherited Members

- Public Attributes inherited from CSGObject
SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_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

constructor

Definition at line 40 of file Evaluation.h.

virtual ~CEvaluation ( )
virtual

destructor

Definition at line 43 of file Evaluation.h.

Member Function Documentation

virtual float64_t evaluate ( CLabels predicted,
CLabels ground_truth 
)
pure virtual

evaluate labels

Parameters
predictedlabels for evaluating
ground_truthlabels assumed to be correct
Returns
evaluation result

Implemented in CContingencyTableEvaluation, CROCEvaluation, CMulticlassAccuracy, CMeanSquaredError, CMeanAbsoluteError, CPRCEvaluation, and CBinaryClassEvaluation.

virtual EEvaluationDirection get_evaluation_direction ( )
pure virtual
Returns
whether criterium has to be maximized or minimized

Implemented in CContingencyTableEvaluation, CROCEvaluation, CMulticlassAccuracy, CMeanSquaredError, CMeanAbsoluteError, and CPRCEvaluation.


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

SHOGUN Machine Learning Toolbox - Documentation