SHOGUN  v2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CAccuracyMeasure Class Reference

Detailed Description

class AccuracyMeasure used to measure accuracy of 2-class classifier.

This class is also capable of measuring any other rate using get_[measure name] methods of CContingencyTableEvaluation class.

Note that evaluate() should be called first.

Definition at line 237 of file ContingencyTableEvaluation.h.

Inheritance diagram for CAccuracyMeasure:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CAccuracyMeasure ()
virtual ~CAccuracyMeasure ()
virtual const char * get_name () const
virtual float64_t evaluate (CLabels *predicted, CLabels *ground_truth)
EEvaluationDirection get_evaluation_direction ()
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
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 ()
void unset_generic ()
virtual void print_serializable (const char *prefix="")
virtual bool save_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=VERSION_PARAMETER)
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=VERSION_PARAMETER)
DynArray< TParameter * > * load_file_parameters (const SGParamInfo *param_info, int32_t file_version, CSerializableFile *file, const char *prefix="")
DynArray< TParameter * > * load_all_file_parameters (int32_t file_version, int32_t current_version, CSerializableFile *file, const char *prefix="")
void map_parameters (DynArray< TParameter * > *param_base, int32_t &base_version, DynArray< const SGParamInfo * > *target_param_infos)
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_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict)

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

void compute_scores (CBinaryLabels *predicted, CBinaryLabels *ground_truth)
virtual TParametermigrate (DynArray< TParameter * > *param_base, const SGParamInfo *target)
virtual void one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL)
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)
virtual bool update_parameter_hash ()

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

Definition at line 241 of file ContingencyTableEvaluation.h.

virtual ~CAccuracyMeasure ( ) [virtual]

Definition at line 243 of file ContingencyTableEvaluation.h.


Member Function Documentation

void build_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 1204 of file SGObject.cpp.

void compute_scores ( CBinaryLabels predicted,
CBinaryLabels ground_truth 
) [protected, inherited]

get scores for TP, FP, TN, FN

Definition at line 82 of file ContingencyTableEvaluation.cpp.

virtual CSGObject* deep_copy ( ) const [virtual, inherited]

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

Definition at line 131 of file SGObject.h.

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

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 [inherited]

accuracy

Returns:
computed accuracy

Definition at line 105 of file ContingencyTableEvaluation.h.

float64_t get_BAL ( ) const [inherited]

Balanced error (BAL)

Returns:
computed BAL

Definition at line 127 of file ContingencyTableEvaluation.h.

float64_t get_cross_correlation ( ) const [inherited]

cross correlation

Returns:
computed cross correlation coefficient

Definition at line 160 of file ContingencyTableEvaluation.h.

float64_t get_error_rate ( ) const [inherited]

error rate

Returns:
computed error rate

Definition at line 116 of file ContingencyTableEvaluation.h.

Returns:
whether criterium has to be maximized or minimized

Implements CEvaluation.

Definition at line 53 of file ContingencyTableEvaluation.cpp.

float64_t get_F1 ( ) const [inherited]

F1

Returns:
computed F1 score

Definition at line 149 of file ContingencyTableEvaluation.h.

SGIO * get_global_io ( ) [inherited]

get the io object

Returns:
io object

Definition at line 224 of file SGObject.cpp.

Parallel * get_global_parallel ( ) [inherited]

get the parallel object

Returns:
parallel object

Definition at line 259 of file SGObject.cpp.

Version * get_global_version ( ) [inherited]

get the version object

Returns:
version object

Definition at line 272 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 1108 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 1132 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 1145 of file SGObject.cpp.

virtual const char* get_name ( ) const [virtual]

get name

Reimplemented from CContingencyTableEvaluation.

Definition at line 245 of file ContingencyTableEvaluation.h.

float64_t get_precision ( ) const [inherited]

precision

Returns:
computed precision

Definition at line 182 of file ContingencyTableEvaluation.h.

float64_t get_recall ( ) const [inherited]

recall

Returns:
computed recall

Definition at line 171 of file ContingencyTableEvaluation.h.

float64_t get_specificity ( ) const [inherited]

specificity

Returns:
computed specificity

Definition at line 193 of file ContingencyTableEvaluation.h.

float64_t get_WRACC ( ) const [inherited]

WRACC

Returns:
computed WRACC

Definition at line 138 of file ContingencyTableEvaluation.h.

bool is_generic ( EPrimitiveType *  generic) const [virtual, inherited]

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 278 of file SGObject.cpp.

DynArray< TParameter * > * load_all_file_parameters ( int32_t  file_version,
int32_t  current_version,
CSerializableFile file,
const char *  prefix = "" 
) [inherited]

maps all parameters of this instance to the provided file version and loads all parameter data from the file into an array, which is sorted (basically calls load_file_parameter(...) for all parameters and puts all results into a sorted array)

Parameters:
file_versionparameter version of the file
current_versionversion from which mapping begins (you want to use VERSION_PARAMETER for this in most cases)
filefile to load from
prefixprefix for members
Returns:
(sorted) array of created TParameter instances with file data

Definition at line 679 of file SGObject.cpp.

DynArray< TParameter * > * load_file_parameters ( const SGParamInfo param_info,
int32_t  file_version,
CSerializableFile file,
const char *  prefix = "" 
) [inherited]

loads some specified parameters from a file with a specified version The provided parameter info has a version which is recursively mapped until the file parameter version is reached. Note that there may be possibly multiple parameters in the mapping, therefore, a set of TParameter instances is returned

Parameters:
param_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
Returns:
new array with TParameter instances with the attached data

Definition at line 523 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual, inherited]

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
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns:
TRUE if done, otherwise FALSE

Reimplemented in CModelSelectionParameters.

Definition at line 354 of file SGObject.cpp.

void load_serializable_post ( ) throw (ShogunException) [protected, virtual, inherited]

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 occurres.

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

Definition at line 1033 of file SGObject.cpp.

void load_serializable_pre ( ) throw (ShogunException) [protected, virtual, inherited]

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 occurres.

Definition at line 1028 of file SGObject.cpp.

void map_parameters ( DynArray< TParameter * > *  param_base,
int32_t &  base_version,
DynArray< const SGParamInfo * > *  target_param_infos 
) [inherited]

Takes a set of TParameter instances (base) with a certain version and a set of target parameter infos and recursively maps the base level wise to the current version using CSGObject::migrate(...). The base is replaced. After this call, the base version containing parameters should be of same version/type as the initial target parameter infos. Note for this to work, the migrate methods and all the internal parameter mappings have to match

Parameters:
param_baseset of TParameter instances that are mapped to the provided target parameter infos
base_versionversion of the parameter base
target_param_infosset of SGParamInfo instances that specify the target parameter base

Definition at line 717 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
) [protected, virtual, inherited]

creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.

If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass

Parameters:
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
Returns:
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 923 of file SGObject.cpp.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
) [protected, virtual, inherited]

This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)

Parameters:
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
replacement(used as output) here the TParameter instance which is returned by migration is created into
to_migratethe only source that is used for migration
old_namewith this parameter, a name change may be specified

Definition at line 864 of file SGObject.cpp.

void print_modsel_params ( ) [inherited]

prints all parameter registered for model selection and their type

Definition at line 1084 of file SGObject.cpp.

void print_serializable ( const char *  prefix = "") [virtual, inherited]

prints registered parameters out

Parameters:
prefixprefix for members

Definition at line 290 of file SGObject.cpp.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual, inherited]

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
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns:
TRUE if done, otherwise FALSE

Reimplemented in CModelSelectionParameters.

Definition at line 296 of file SGObject.cpp.

void save_serializable_post ( ) throw (ShogunException) [protected, virtual, inherited]

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 occurres.

Reimplemented in CKernel.

Definition at line 1043 of file SGObject.cpp.

void save_serializable_pre ( ) throw (ShogunException) [protected, virtual, inherited]

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 occurres.

Reimplemented in CKernel.

Definition at line 1038 of file SGObject.cpp.

void set_generic< floatmax_t > ( ) [inherited]

set generic type to T

Definition at line 41 of file SGObject.cpp.

void set_global_io ( SGIO io) [inherited]

set the io object

Parameters:
ioio object to use

Definition at line 217 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel) [inherited]

set the parallel object

Parameters:
parallelparallel object to use

Definition at line 230 of file SGObject.cpp.

void set_global_version ( Version version) [inherited]

set the version object

Parameters:
versionversion object to use

Definition at line 265 of file SGObject.cpp.

virtual void set_indices ( SGVector< index_t indices) [virtual, inherited]

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

Parameters:
indicesindices

Reimplemented in CMultitaskROCEvaluation.

Definition at line 57 of file Evaluation.h.

virtual CSGObject* shallow_copy ( ) const [virtual, inherited]

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

Reimplemented in CGaussianKernel.

Definition at line 122 of file SGObject.h.

void unset_generic ( ) [inherited]

unset generic type

this has to be called in classes specializing a template class

Definition at line 285 of file SGObject.cpp.

bool update_parameter_hash ( ) [protected, virtual, inherited]

Updates the hash of current parameter combination.

Returns:
bool if parameter combination has changed since last update.

Definition at line 237 of file SGObject.cpp.


Member Data Documentation

SGIO* io [inherited]

io

Definition at line 462 of file SGObject.h.

bool m_computed [protected, inherited]

indicator of contingencies being computed

Definition at line 210 of file ContingencyTableEvaluation.h.

float64_t m_FN [protected, inherited]

number of false negative examples

Definition at line 225 of file ContingencyTableEvaluation.h.

float64_t m_FP [protected, inherited]

number of false positive examples

Definition at line 219 of file ContingencyTableEvaluation.h.

uint32_t m_hash [inherited]

Hash of parameter values

Definition at line 480 of file SGObject.h.

model selection parameters

Definition at line 474 of file SGObject.h.

int32_t m_N [protected, inherited]

total number of labels

Definition at line 213 of file ContingencyTableEvaluation.h.

map for different parameter versions

Definition at line 477 of file SGObject.h.

Parameter* m_parameters [inherited]

parameters

Definition at line 471 of file SGObject.h.

float64_t m_TN [protected, inherited]

number of true negative examples

Definition at line 222 of file ContingencyTableEvaluation.h.

float64_t m_TP [protected, inherited]

number of true positive examples

Definition at line 216 of file ContingencyTableEvaluation.h.

EContingencyTableMeasureType m_type [protected, inherited]

type of measure to evaluate

Definition at line 207 of file ContingencyTableEvaluation.h.

Parallel* parallel [inherited]

parallel

Definition at line 465 of file SGObject.h.

Version* version [inherited]

version

Definition at line 468 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation