详细描述

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.

在文件 ContingencyTableEvaluation.h 第 72 行定义.

类 CContingencyTableEvaluation 继承关系图:

[图例]

Public 成员函数
	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 CSGObject *	shallow_copy () const

virtual CSGObject *	deep_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)

SGIO *	get_global_io ()

void	set_global_parallel (Parallel *parallel)

Parallel *	get_global_parallel ()

void	set_global_version (Version *version)

Version *	get_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 CSGObject *	clone ()

Public 属性
SGIO *	io

Parallel *	parallel

Version *	version

Parameter *	m_parameters

Parameter *	m_model_selection_parameters

Parameter *	m_gradient_parameters

uint32_t	m_hash

Protected 成员函数
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 属性
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

构造及析构函数说明

CContingencyTableEvaluation ( )

constructor

在文件 ContingencyTableEvaluation.h 第 78 行定义.

CContingencyTableEvaluation ( EContingencyTableMeasureType type )

constructor

参数

type	type of measure (e.g ACCURACY)

在文件 ContingencyTableEvaluation.h 第 84 行定义.

virtual ~CContingencyTableEvaluation ( )

virtual

destructor

在文件 ContingencyTableEvaluation.h 第 88 行定义.

成员函数说明

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.

参数

dict	dictionary of parameters to be built.

在文件 SGObject.cpp 第 597 行定义.

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.

返回: 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

在文件 SGObject.cpp 第 714 行定义.

void compute_scores	(	CBinaryLabels *	predicted,
		CBinaryLabels *	ground_truth
	)

protected

get scores for TP, FP, TN, FN

在文件 ContingencyTableEvaluation.cpp 第 86 行定义.

CSGObject * deep_copy ( ) const

virtualinherited

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

在文件 SGObject.cpp 第 198 行定义.

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.

参数

other	object to compare with
accuracy	accuracy to use for comparison (optional)
tolerant	allows linient check on float equality (within accuracy)

返回: true if all parameters were equal, false if not

在文件 SGObject.cpp 第 618 行定义.

float64_t evaluate	(	CLabels *	predicted,
		CLabels *	ground_truth
	)

virtual

evaluate labels

参数

predicted	labels
ground_truth	labels assumed to be correct

返回: evaluation result

实现了 CBinaryClassEvaluation.

在文件 ContingencyTableEvaluation.cpp 第 16 行定义.

float64_t get_accuracy ( ) const

accuracy

返回: computed accuracy

在文件 ContingencyTableEvaluation.h 第 108 行定义.

float64_t get_BAL ( ) const

Balanced error (BAL)

返回: computed BAL

在文件 ContingencyTableEvaluation.h 第 130 行定义.

float64_t get_cross_correlation ( ) const

cross correlation

返回: computed cross correlation coefficient

在文件 ContingencyTableEvaluation.h 第 163 行定义.

virtual EEvaluationDirection get_custom_direction ( ) const

virtual

Returns custom direction, not implemented

返回: direction of custom score

在文件 ContingencyTableEvaluation.h 第 245 行定义.

virtual float64_t get_custom_score ( )

virtual

Computes custom score, not implemented

返回: custom score value

在文件 ContingencyTableEvaluation.h 第 236 行定义.

float64_t get_error_rate ( ) const

error rate

返回: computed error rate

在文件 ContingencyTableEvaluation.h 第 119 行定义.

EEvaluationDirection get_evaluation_direction ( ) const

virtual

返回: whether criterion has to be maximized or minimized

实现了 CEvaluation.

在文件 ContingencyTableEvaluation.cpp 第 55 行定义.

float64_t get_F1 ( ) const

F1

返回: computed F1 score

在文件 ContingencyTableEvaluation.h 第 152 行定义.

float64_t get_FN ( ) const

Returns number of True Negatives

返回: number of false negatives

在文件 ContingencyTableEvaluation.h 第 228 行定义.

float64_t get_FP ( ) const

Returns number of False Positives

返回: number of false positives

在文件 ContingencyTableEvaluation.h 第 214 行定义.

SGIO * get_global_io ( )

inherited

get the io object

返回: io object

在文件 SGObject.cpp 第 235 行定义.

Parallel * get_global_parallel ( )

inherited

get the parallel object

返回: parallel object

在文件 SGObject.cpp 第 277 行定义.

Version * get_global_version ( )

inherited

get the version object

返回: version object

在文件 SGObject.cpp 第 290 行定义.

SGStringList< char > get_modelsel_names ( )

inherited

返回: vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp 第 498 行定义.

char * get_modsel_param_descr ( const char * param_name )

inherited

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

参数

param_name name of the parameter

返回: description of the parameter

在文件 SGObject.cpp 第 522 行定义.

index_t get_modsel_param_index ( const char * param_name )

inherited

Returns index of model selection parameter with provided index

参数

param_name name of model selection parameter

返回: index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp 第 535 行定义.

virtual const char* get_name ( ) const

virtual

get name

实现了 CSGObject.

被 CSpecificityMeasure, CPrecisionMeasure, CRecallMeasure, CCrossCorrelationMeasure, CF1Measure, CWRACCMeasure, CBALMeasure, CErrorRateMeasure , 以及 CAccuracyMeasure 重载.

在文件 ContingencyTableEvaluation.h 第 100 行定义.

float64_t get_precision ( ) const

precision

返回: computed precision

在文件 ContingencyTableEvaluation.h 第 185 行定义.

float64_t get_recall ( ) const

recall

返回: computed recall

在文件 ContingencyTableEvaluation.h 第 174 行定义.

float64_t get_specificity ( ) const

specificity

返回: computed specificity

在文件 ContingencyTableEvaluation.h 第 196 行定义.

float64_t get_TN ( ) const

Returns number of True Negatives

返回: number of true negatives

在文件 ContingencyTableEvaluation.h 第 221 行定义.

float64_t get_TP ( ) const

Returns number of True Positives

返回: number of true positives

在文件 ContingencyTableEvaluation.h 第 207 行定义.

float64_t get_WRACC ( ) const

WRACC

返回: computed WRACC

在文件 ContingencyTableEvaluation.h 第 141 行定义.

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.

参数

generic set to the type of the generic if returning TRUE

返回: TRUE if a class template.

在文件 SGObject.cpp 第 296 行定义.

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!

参数

file	where to load from
prefix	prefix for members

返回: TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 369 行定义.

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.

异常

ShogunException will be thrown if an error occurs.

被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp 第 426 行定义.

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.

异常

ShogunException will be thrown if an error occurs.

被 CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 421 行定义.

bool parameter_hash_changed ( )

virtualinherited

返回: whether parameter combination has changed since last update

在文件 SGObject.cpp 第 262 行定义.

void print_modsel_params ( )

inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp 第 474 行定义.

void print_serializable ( const char * prefix = "" )

virtualinherited

prints registered parameters out

参数

prefix prefix for members

在文件 SGObject.cpp 第 308 行定义.

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

virtualinherited

Save this object to file.

参数

file	where to save the object; will be closed during returning if PREFIX is an empty string.
prefix	prefix for members

返回: TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 314 行定义.

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.

异常

ShogunException will be thrown if an error occurs.

被 CKernel 重载.

在文件 SGObject.cpp 第 436 行定义.

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.

异常

ShogunException will be thrown if an error occurs.

被 CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 431 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 41 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 46 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 51 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 56 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 61 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 66 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 71 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 76 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 81 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 86 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 91 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 96 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 101 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 106 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 111 行定义.

void set_generic ( )

inherited

set generic type to T

void set_global_io ( SGIO * io )

inherited

set the io object

参数

io	io object to use

在文件 SGObject.cpp 第 228 行定义.

void set_global_parallel ( Parallel * parallel )

inherited

set the parallel object

参数

parallel parallel object to use

在文件 SGObject.cpp 第 241 行定义.

void set_global_version ( Version * version )

inherited

set the version object

参数

version version object to use

在文件 SGObject.cpp 第 283 行定义.

virtual void set_indices ( SGVector< index_t > indices )

virtualinherited

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

参数

indices indices

被 CMultitaskROCEvaluation 重载.

在文件 Evaluation.h 第 63 行定义.

CSGObject * shallow_copy ( ) const

virtualinherited

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

被 CGaussianKernel 重载.

在文件 SGObject.cpp 第 192 行定义.

void unset_generic ( )

inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp 第 303 行定义.

void update_parameter_hash ( )

virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp 第 248 行定义.

类成员变量说明

SGIO* io

inherited

io

在文件 SGObject.h 第 369 行定义.

bool m_computed

protected

indicator of contingencies being computed

在文件 ContingencyTableEvaluation.h 第 260 行定义.

float64_t m_FN

protected

number of false negative examples

在文件 ContingencyTableEvaluation.h 第 275 行定义.

float64_t m_FP

protected

number of false positive examples

在文件 ContingencyTableEvaluation.h 第 269 行定义.

Parameter* m_gradient_parameters

inherited

parameters wrt which we can compute gradients

在文件 SGObject.h 第 384 行定义.

uint32_t m_hash

inherited

Hash of parameter values

在文件 SGObject.h 第 387 行定义.

Parameter* m_model_selection_parameters

inherited

model selection parameters

在文件 SGObject.h 第 381 行定义.

int32_t m_N

protected

total number of labels

在文件 ContingencyTableEvaluation.h 第 263 行定义.

Parameter* m_parameters

inherited

parameters

在文件 SGObject.h 第 378 行定义.

float64_t m_TN

protected

number of true negative examples

在文件 ContingencyTableEvaluation.h 第 272 行定义.

float64_t m_TP

protected

number of true positive examples

在文件 ContingencyTableEvaluation.h 第 266 行定义.

EContingencyTableMeasureType m_type

protected

type of measure to evaluate

在文件 ContingencyTableEvaluation.h 第 257 行定义.

Parallel* parallel

inherited

parallel

在文件 SGObject.h 第 372 行定义.

Version* version

inherited

version

在文件 SGObject.h 第 375 行定义.

该类的文档由以下文件生成:

详细描述

Public 成员函数

Public 属性

Protected 成员函数

Protected 属性

构造及析构函数说明

成员函数说明

类成员变量说明