Public Member Functions | Protected Attributes

CROCEvaluation Class Reference


Detailed Description

The class ROCEvalution used to evaluate ROC (Receiver Operator Characteristic) graph of binary classifier. This class also has an capability of calculating auROC (area under ROC).

Implementation is based on the efficient ROC algorithm described in

Fawcett, Tom (2004) ROC Graphs: Notes and Practical Considerations for Researchers; Machine Learning, 2004

Definition at line 31 of file ROCEvaluation.h.

Inheritance diagram for CROCEvaluation:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CROCEvaluation ()
virtual ~CROCEvaluation ()
virtual const char * get_name () const
virtual float64_t evaluate (CLabels *predicted, CLabels *ground_truth)
EEvaluationDirection get_evaluation_direction ()
float64_t get_auROC ()
SGMatrix< float64_tget_ROC ()

Protected Attributes

float64_tm_ROC_graph
float64_t m_auROC
int32_t m_ROC_length
bool m_computed

Constructor & Destructor Documentation

CROCEvaluation (  ) 

constructor

Definition at line 35 of file ROCEvaluation.h.

~CROCEvaluation (  )  [virtual]

destructor

Definition at line 16 of file ROCEvaluation.cpp.


Member Function Documentation

float64_t evaluate ( CLabels predicted,
CLabels ground_truth 
) [virtual]

evaluate ROC and auROC

Parameters:
predicted labels
ground_truth labels assumed to be correct
Returns:
auROC

Implements CBinaryClassEvaluation.

Definition at line 21 of file ROCEvaluation.cpp.

float64_t get_auROC (  ) 

get auROC

Returns:
area under ROC (auROC)

Definition at line 128 of file ROCEvaluation.cpp.

EEvaluationDirection get_evaluation_direction (  )  [virtual]
Returns:
whether criterium has to be maximised or minimised

Implements CEvaluation.

Definition at line 52 of file ROCEvaluation.h.

virtual const char* get_name ( void   )  const [virtual]

get name

Implements CSGObject.

Definition at line 43 of file ROCEvaluation.h.

SGMatrix< float64_t > get_ROC (  ) 

get ROC

Returns:
ROC graph matrix

Definition at line 118 of file ROCEvaluation.cpp.


Member Data Documentation

float64_t m_auROC [protected]

area under ROC graph

Definition at line 73 of file ROCEvaluation.h.

bool m_computed [protected]

indicator of ROC and auROC being computed already

Definition at line 79 of file ROCEvaluation.h.

float64_t* m_ROC_graph [protected]

2-d array used to store ROC graph

Definition at line 70 of file ROCEvaluation.h.

int32_t m_ROC_length [protected]

number of points in ROC graph

Definition at line 76 of file ROCEvaluation.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

SHOGUN Machine Learning Toolbox - Documentation