SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CContingencyTableEvaluation Class Reference

Detailed Description

The class ContingencyTableEvaluation a base class used to evaluate 2-class classification with TP, FP, TN, FN rates.

This class has implementations of the measures listed below:

Accuracy (ACCURACY): \( \frac{TP+TN}{N} \)

Error rate (ERROR_RATE): \( \frac{FP+FN}{N} \)

Balanced error (BAL): \( \frac{1}{2} \left( \frac{FN}{FN+TP} + \frac{FP}{FP+TN} \right) \)

Weighted relative accuracy (WRACC): \( \frac{TP}{TP+FN} - \frac{FP}{FP+TN} \)

F1 score (F1): \( \frac{2\cdot FP}{2\cdot TP + FP + FN} \)

Cross correlation coefficient (CROSS_CORRELATION): \( \frac{TP\cdot TN - FP \cdot FN}{\sqrt{(TP+FP)(TP+FN)(TN+FP)(TN+FN)}} \)

Recall (RECALL): \( \frac{TP}{TP+FN} \)

Precision (PRECISION): \( \frac{TP}{TP+FP} \)

Specificity (SPECIFICITY): \( \frac{TN}{TN+FP} \)

Note that objects of this class should be used only if computing of many different measures is required. In other case, using helper classes (CAccuracyMeasure, ...) could be more convenient.

Definition at line 72 of file ContingencyTableEvaluation.h.

Inheritance diagram for CContingencyTableEvaluation:
Inheritance graph
[legend]

Public Member Functions

 CContingencyTableEvaluation ()
 
 CContingencyTableEvaluation (EContingencyTableMeasureType type)
 
virtual ~CContingencyTableEvaluation ()
 
virtual float64_t evaluate (CLabels *predicted, CLabels *ground_truth)
 
virtual EEvaluationDirection get_evaluation_direction () const
 
virtual const char * get_name () const
 
float64_t get_accuracy () const
 
float64_t get_error_rate () const
 
float64_t get_BAL () const
 
float64_t get_WRACC () const
 
float64_t get_F1 () const
 
float64_t get_cross_correlation () const
 
float64_t get_recall () const
 
float64_t get_precision () const
 
float64_t get_specificity () const
 
float64_t get_TP () const
 
float64_t get_FP () const
 
float64_t get_TN () const
 
float64_t get_FN () const
 
virtual float64_t get_custom_score ()
 
virtual EEvaluationDirection get_custom_direction () const
 
virtual void set_indices (SGVector< index_t > indices)
 
virtual CSGObjectshallow_copy () const
 
virtual CSGObjectdeep_copy () const
 
virtual bool is_generic (EPrimitiveType *generic) const
 
template<class T >
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 ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
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 ()
 
SGStringList< char > get_modelsel_names ()
 
void print_modsel_params ()
 
char * get_modsel_param_descr (const char *param_name)
 
index_t get_modsel_param_index (const char *param_name)
 
void build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict)
 
virtual void update_parameter_hash ()
 
virtual bool parameter_hash_changed ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
 
virtual CSGObjectclone ()
 

Public Attributes

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
uint32_t m_hash
 

Protected Member Functions

void compute_scores (CBinaryLabels *predicted, CBinaryLabels *ground_truth)
 
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)
 

Protected Attributes

EContingencyTableMeasureType m_type
 
bool m_computed
 
int32_t m_N
 
float64_t m_TP
 
float64_t m_FP
 
float64_t m_TN
 
float64_t m_FN
 

Constructor & Destructor Documentation

constructor

Definition at line 78 of file ContingencyTableEvaluation.h.

constructor

Parameters
typetype of measure (e.g ACCURACY)

Definition at line 84 of file ContingencyTableEvaluation.h.

virtual ~CContingencyTableEvaluation ( )
virtual

destructor

Definition at line 88 of file ContingencyTableEvaluation.h.

Member Function Documentation

void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject * > *  dict)
inherited

Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.

Parameters
dictdictionary of parameters to be built.

Definition at line 597 of file SGObject.cpp.

CSGObject * clone ( )
virtualinherited

Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.

Returns
an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed

Definition at line 714 of file SGObject.cpp.

void compute_scores ( CBinaryLabels predicted,
CBinaryLabels ground_truth 
)
protected

get scores for TP, FP, TN, FN

Definition at line 86 of file ContingencyTableEvaluation.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

Definition at line 198 of file SGObject.cpp.

bool equals ( CSGObject other,
float64_t  accuracy = 0.0,
bool  tolerant = false 
)
virtualinherited

Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!

May be overwritten but please do with care! Should not be necessary in most cases.

Parameters
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 618 of file SGObject.cpp.

float64_t evaluate ( CLabels predicted,
CLabels ground_truth 
)
virtual

evaluate labels

Parameters
predictedlabels
ground_truthlabels assumed to be correct
Returns
evaluation result

Implements CBinaryClassEvaluation.

Definition at line 16 of file ContingencyTableEvaluation.cpp.

float64_t get_accuracy ( ) const

accuracy

Returns
computed accuracy

Definition at line 108 of file ContingencyTableEvaluation.h.

float64_t get_BAL ( ) const

Balanced error (BAL)

Returns
computed BAL

Definition at line 130 of file ContingencyTableEvaluation.h.

float64_t get_cross_correlation ( ) const

cross correlation

Returns
computed cross correlation coefficient

Definition at line 163 of file ContingencyTableEvaluation.h.

virtual EEvaluationDirection get_custom_direction ( ) const
virtual

Returns custom direction, not implemented

Returns
direction of custom score

Definition at line 245 of file ContingencyTableEvaluation.h.

virtual float64_t get_custom_score ( )
virtual

Computes custom score, not implemented

Returns
custom score value

Definition at line 236 of file ContingencyTableEvaluation.h.

float64_t get_error_rate ( ) const

error rate

Returns
computed error rate

Definition at line 119 of file ContingencyTableEvaluation.h.

EEvaluationDirection get_evaluation_direction ( ) const
virtual
Returns
whether criterion has to be maximized or minimized

Implements CEvaluation.

Definition at line 55 of file ContingencyTableEvaluation.cpp.

float64_t get_F1 ( ) const

F1

Returns
computed F1 score

Definition at line 152 of file ContingencyTableEvaluation.h.

float64_t get_FN ( ) const

Returns number of True Negatives

Returns
number of false negatives

Definition at line 228 of file ContingencyTableEvaluation.h.

float64_t get_FP ( ) const

Returns number of False Positives

Returns
number of false positives

Definition at line 214 of file ContingencyTableEvaluation.h.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 235 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 277 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 290 of file SGObject.cpp.

SGStringList< char > get_modelsel_names ( )
inherited
Returns
vector of names of all parameters which are registered for model selection

Definition at line 498 of file SGObject.cpp.

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

Parameters
param_namename of the parameter
Returns
description of the parameter

Definition at line 522 of file SGObject.cpp.

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

Parameters
param_namename of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 535 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual
float64_t get_precision ( ) const

precision

Returns
computed precision

Definition at line 185 of file ContingencyTableEvaluation.h.

float64_t get_recall ( ) const

recall

Returns
computed recall

Definition at line 174 of file ContingencyTableEvaluation.h.

float64_t get_specificity ( ) const

specificity

Returns
computed specificity

Definition at line 196 of file ContingencyTableEvaluation.h.

float64_t get_TN ( ) const

Returns number of True Negatives

Returns
number of true negatives

Definition at line 221 of file ContingencyTableEvaluation.h.

float64_t get_TP ( ) const

Returns number of True Positives

Returns
number of true positives

Definition at line 207 of file ContingencyTableEvaluation.h.

float64_t get_WRACC ( ) const

WRACC

Returns
computed WRACC

Definition at line 141 of file ContingencyTableEvaluation.h.

bool is_generic ( EPrimitiveType *  generic) const
virtualinherited

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

Parameters
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 296 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "" 
)
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

Parameters
filewhere to load from
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 369 of file SGObject.cpp.

void load_serializable_post ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 426 of file SGObject.cpp.

void load_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 421 of file SGObject.cpp.

bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 262 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 474 of file SGObject.cpp.

void print_serializable ( const char *  prefix = "")
virtualinherited

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 308 of file SGObject.cpp.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "" 
)
virtualinherited

Save this object to file.

Parameters
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 314 of file SGObject.cpp.

void save_serializable_post ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 436 of file SGObject.cpp.

void save_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 431 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 41 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 46 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 51 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 56 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 61 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 66 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 71 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 76 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 81 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 86 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 91 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 96 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 101 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 106 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 111 of file SGObject.cpp.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 228 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 283 of file SGObject.cpp.

virtual void set_indices ( SGVector< index_t indices)
virtualinherited

set absolute indices of labels to be evaluated next used by multitask evaluations

Parameters
indicesindices

Reimplemented in CMultitaskROCEvaluation.

Definition at line 63 of file Evaluation.h.

CSGObject * shallow_copy ( ) const
virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

Reimplemented in CGaussianKernel.

Definition at line 192 of file SGObject.cpp.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 303 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 248 of file SGObject.cpp.

Member Data Documentation

SGIO* io
inherited

io

Definition at line 369 of file SGObject.h.

bool m_computed
protected

indicator of contingencies being computed

Definition at line 260 of file ContingencyTableEvaluation.h.

float64_t m_FN
protected

number of false negative examples

Definition at line 275 of file ContingencyTableEvaluation.h.

float64_t m_FP
protected

number of false positive examples

Definition at line 269 of file ContingencyTableEvaluation.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 384 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 387 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 381 of file SGObject.h.

int32_t m_N
protected

total number of labels

Definition at line 263 of file ContingencyTableEvaluation.h.

Parameter* m_parameters
inherited

parameters

Definition at line 378 of file SGObject.h.

float64_t m_TN
protected

number of true negative examples

Definition at line 272 of file ContingencyTableEvaluation.h.

float64_t m_TP
protected

number of true positive examples

Definition at line 266 of file ContingencyTableEvaluation.h.

EContingencyTableMeasureType m_type
protected

type of measure to evaluate

Definition at line 257 of file ContingencyTableEvaluation.h.

Parallel* parallel
inherited

parallel

Definition at line 372 of file SGObject.h.

Version* version
inherited

version

Definition at line 375 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation