clustering (normalized) mutual information
Definition at line 23 of file ClusteringMutualInformation.h.
|
| CClusteringMutualInformation () |
|
virtual | ~CClusteringMutualInformation () |
|
virtual float64_t | evaluate (CLabels *predicted, CLabels *ground_truth) |
|
virtual EEvaluationDirection | get_evaluation_direction () const |
|
virtual const char * | get_name () const |
|
void | best_map (CLabels *predicted, CLabels *ground_truth) |
|
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) |
|
bool | has (const std::string &name) const |
|
template<typename T > |
bool | has (const Tag< T > &tag) const |
|
template<typename T , typename U = void> |
bool | has (const std::string &name) const |
|
template<typename T > |
void | set (const Tag< T > &_tag, const T &value) |
|
template<typename T , typename U = void> |
void | set (const std::string &name, const T &value) |
|
template<typename T > |
T | get (const Tag< T > &_tag) const |
|
template<typename T , typename U = void> |
T | get (const std::string &name) const |
|
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 () |
|
permute the order of the predicted labels to match the ground_truth as good as possible.
The Munkres assignment algorithm is used to find the best match. Note this method perform inplace modification on the parameter predicted
- Parameters
-
predicted | labels for evaluating |
ground_truth | labels assumed to be correct |
Definition at line 40 of file ClusteringEvaluation.cpp.
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
-
dict | dictionary of parameters to be built. |
Definition at line 630 of file SGObject.cpp.
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 747 of file SGObject.cpp.
A deep copy. All the instance variables will also be copied.
Definition at line 231 of file SGObject.cpp.
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
-
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
tolerant | allows linient check on float equality (within accuracy) |
- Returns
- true if all parameters were equal, false if not
Definition at line 651 of file SGObject.cpp.
int32_t find_match_count |
( |
SGVector< int32_t > |
l1, |
|
|
int32_t |
m1, |
|
|
SGVector< int32_t > |
l2, |
|
|
int32_t |
m2 |
|
) |
| |
|
protectedinherited |
find number of matches in the two labels sequence.
For each index i, if l1[i] == m1 and l2[i] == m2, then we get a match.
- Parameters
-
l1 | the first label sequence to be matched |
m1 | the first label to match |
l2 | the second label sequence to be matched |
m2 | the second label to match |
- Returns
- number of matches
Definition at line 23 of file ClusteringEvaluation.cpp.
int32_t find_mismatch_count |
( |
SGVector< int32_t > |
l1, |
|
|
int32_t |
m1, |
|
|
SGVector< int32_t > |
l2, |
|
|
int32_t |
m2 |
|
) |
| |
|
protectedinherited |
T get |
( |
const Tag< T > & |
_tag | ) |
const |
|
inherited |
Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.
- Parameters
-
_tag | name and type information of parameter |
- Returns
- value of the parameter identified by the input tag
Definition at line 367 of file SGObject.h.
T get |
( |
const std::string & |
name | ) |
const |
|
inherited |
Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.
- Parameters
-
name | name of the parameter |
- Returns
- value of the parameter corresponding to the input name and type
Definition at line 388 of file SGObject.h.
get the io object
- Returns
- io object
Definition at line 268 of file SGObject.cpp.
get the parallel object
- Returns
- parallel object
Definition at line 310 of file SGObject.cpp.
get the version object
- Returns
- version object
Definition at line 323 of file SGObject.cpp.
- Returns
- vector of names of all parameters which are registered for model selection
Definition at line 531 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_name | name of the parameter |
- Returns
- description of the parameter
Definition at line 555 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_name | name of model selection parameter |
- Returns
- index of model selection parameter with provided name, -1 if there is no such
Definition at line 568 of file SGObject.cpp.
virtual const char* get_name |
( |
| ) |
const |
|
virtual |
Returns the name of the SGSerializable instance. It MUST BE the CLASS NAME without the prefixed `C'.
- Returns
- name of the SGSerializable
Implements CSGObject.
Definition at line 53 of file ClusteringMutualInformation.h.
bool has |
( |
const std::string & |
name | ) |
const |
|
inherited |
Checks if object has a class parameter identified by a name.
- Parameters
-
name | name of the parameter |
- Returns
- true if the parameter exists with the input name
Definition at line 289 of file SGObject.h.
bool has |
( |
const Tag< T > & |
tag | ) |
const |
|
inherited |
Checks if object has a class parameter identified by a Tag.
- Parameters
-
tag | tag of the parameter containing name and type information |
- Returns
- true if the parameter exists with the input tag
Definition at line 301 of file SGObject.h.
bool has |
( |
const std::string & |
name | ) |
const |
|
inherited |
Checks if a type exists for a class parameter identified by a name.
- Parameters
-
name | name of the parameter |
- Returns
- true if the parameter exists with the input name and type
Definition at line 312 of file SGObject.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
-
generic | set to the type of the generic if returning TRUE |
- Returns
- TRUE if a class template.
Definition at line 329 of file SGObject.cpp.
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
- Parameters
-
file | where to load from |
prefix | prefix for members |
- Returns
- TRUE if done, otherwise FALSE
Definition at line 402 of file SGObject.cpp.
|
protectedvirtualinherited |
|
protectedvirtualinherited |
bool parameter_hash_changed |
( |
| ) |
|
|
virtualinherited |
- Returns
- whether parameter combination has changed since last update
Definition at line 295 of file SGObject.cpp.
void print_modsel_params |
( |
| ) |
|
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 507 of file SGObject.cpp.
void print_serializable |
( |
const char * |
prefix = "" | ) |
|
|
virtualinherited |
prints registered parameters out
- Parameters
-
Definition at line 341 of file SGObject.cpp.
void register_param |
( |
Tag< T > & |
_tag, |
|
|
const T & |
value |
|
) |
| |
|
protectedinherited |
Registers a class parameter which is identified by a tag. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.
- Parameters
-
_tag | name and type information of parameter |
value | value of the parameter |
Definition at line 439 of file SGObject.h.
void register_param |
( |
const std::string & |
name, |
|
|
const T & |
value |
|
) |
| |
|
protectedinherited |
Registers a class parameter which is identified by a name. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.
- Parameters
-
name | name of the parameter |
value | value of the parameter along with type information |
Definition at line 452 of file SGObject.h.
Save this object to file.
- Parameters
-
file | where to save the object; will be closed during returning if PREFIX is an empty string. |
prefix | prefix for members |
- Returns
- TRUE if done, otherwise FALSE
Definition at line 347 of file SGObject.cpp.
|
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
-
Reimplemented in CKernel.
Definition at line 469 of file SGObject.cpp.
|
protectedvirtualinherited |
void set |
( |
const Tag< T > & |
_tag, |
|
|
const T & |
value |
|
) |
| |
|
inherited |
Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.
- Parameters
-
_tag | name and type information of parameter |
value | value of the parameter |
Definition at line 328 of file SGObject.h.
void set |
( |
const std::string & |
name, |
|
|
const T & |
value |
|
) |
| |
|
inherited |
Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.
- Parameters
-
name | name of the parameter |
value | value of the parameter along with type information |
Definition at line 354 of file SGObject.h.
void set_global_io |
( |
SGIO * |
io | ) |
|
|
inherited |
void set_global_parallel |
( |
Parallel * |
parallel | ) |
|
|
inherited |
set the parallel object
- Parameters
-
parallel | parallel object to use |
Definition at line 274 of file SGObject.cpp.
void set_global_version |
( |
Version * |
version | ) |
|
|
inherited |
set the version object
- Parameters
-
version | version object to use |
Definition at line 316 of file SGObject.cpp.
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 225 of file SGObject.cpp.
unset generic type
this has to be called in classes specializing a template class
Definition at line 336 of file SGObject.cpp.
void update_parameter_hash |
( |
| ) |
|
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 281 of file SGObject.cpp.
parameters wrt which we can compute gradients
Definition at line 552 of file SGObject.h.
Hash of parameter values
Definition at line 555 of file SGObject.h.
model selection parameters
Definition at line 549 of file SGObject.h.
The documentation for this class was generated from the following files: