SHOGUN  3.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CMultilabelSOLabels Class Reference

Detailed Description

Class CMultilabelSOLabels used in the application of Structured Output (SO) learning to Multilabel Classification. Labels are subsets of {0, 1, ..., num_classes-1}. Each of the label if of type CSparseMultilabel and all of them are stored in a CDynamicObjectArray.

Definition at line 86 of file MultilabelSOLabels.h.

Inheritance diagram for CMultilabelSOLabels:
Inheritance graph
[legend]

Public Member Functions

 CMultilabelSOLabels ()
 CMultilabelSOLabels (int32_t num_classes)
 CMultilabelSOLabels (int32_t num_labels, int32_t num_classes)
 CMultilabelSOLabels (CMultilabelLabels *multilabel_labels)
 ~CMultilabelSOLabels ()
virtual const char * get_name () const
virtual int32_t get_num_labels () const
virtual int32_t get_num_classes () const
virtual CMultilabelLabelsget_multilabel_labels ()
virtual void set_sparse_labels (SGVector< int32_t > *labels)
virtual void set_sparse_label (int32_t j, SGVector< int32_t > label)
virtual bool set_label (int32_t j, CStructuredData *label)
virtual void add_label (CStructuredData *label)
virtual SGVector< int32_t > get_sparse_label (int32_t j)
virtual CStructuredDataget_label (int32_t j)
virtual void ensure_valid (const char *context=NULL)
CDynamicObjectArrayget_labels () const
virtual ELabelType get_label_type () const
EStructuredDataType get_structured_data_type ()
virtual void add_subset (SGVector< index_t > subset)
virtual void add_subset_in_place (SGVector< index_t > subset)
virtual void remove_subset ()
virtual void remove_all_subsets ()
virtual void set_value (float64_t value, int32_t idx)
virtual float64_t get_value (int32_t idx)
virtual void set_values (SGVector< float64_t > values)
virtual SGVector< float64_tget_values ()
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::get_version_parameter())
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_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_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 ()

Static Public Member Functions

static SGVector< float64_tto_dense (CStructuredData *label, int32_t dense_dim, float64_t d_true, float64_t d_false)

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
Parameterm_gradient_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

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)

Protected Attributes

CDynamicObjectArraym_labels
EStructuredDataType m_sdt
CSubsetStackm_subset_stack
SGVector< float64_tm_current_values

Constructor & Destructor Documentation

default constructor

Definition at line 14 of file MultilabelSOLabels.cpp.

CMultilabelSOLabels ( int32_t  num_classes)

constructor

Parameters
num_classesnumber of (binary) class assignment per label

Definition at line 20 of file MultilabelSOLabels.cpp.

CMultilabelSOLabels ( int32_t  num_labels,
int32_t  num_classes 
)

constructor

Parameters
num_labelsnumber of labels
num_classesnumber of (binary) class assignment per label

Definition at line 27 of file MultilabelSOLabels.cpp.

CMultilabelSOLabels ( CMultilabelLabels multilabel_labels)

constructor

Parameters
multilabel_labels

Definition at line 34 of file MultilabelSOLabels.cpp.

destructor

Definition at line 52 of file MultilabelSOLabels.cpp.

Member Function Documentation

void add_label ( CStructuredData label)
virtual

add a new label to the vector of labels. This method should be used when inserting labels for the first time.

Parameters
labelsparse label to add

Reimplemented from CStructuredLabels.

Definition at line 140 of file MultilabelSOLabels.cpp.

void add_subset ( SGVector< index_t subset)
virtualinherited

Adds a subset of indices on top of the current subsets (possibly subset of subset). Every call causes a new active index vector to be stored. Added subsets can be removed one-by-one. If this is not needed, add_subset_in_place() should be used (does not store intermediate index vectors)

Parameters
subsetsubset of indices to add

Definition at line 39 of file Labels.cpp.

void add_subset_in_place ( SGVector< index_t subset)
virtualinherited

Sets/changes latest added subset. This allows to add multiple subsets with in-place memory requirements. They cannot be removed one-by-one afterwards, only the latest active can. If this is needed, use add_subset(). If no subset is active, this just adds.

Parameters
subsetsubset of indices to replace the latest one with.

Definition at line 44 of file Labels.cpp.

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

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 200 of file SGObject.cpp.

void ensure_valid ( const char *  context = NULL)
virtual

Make sure the label is valid, otherwise raise SG_ERROR

Parameters
contextoptional message to convey the context

Reimplemented from CStructuredLabels.

Definition at line 126 of file MultilabelSOLabels.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 1264 of file SGObject.cpp.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 237 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 278 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 291 of file SGObject.cpp.

CStructuredData * get_label ( int32_t  j)
virtual

get label for j-th index

Parameters
jlabel index

Reimplemented from CStructuredLabels.

Definition at line 114 of file MultilabelSOLabels.cpp.

virtual ELabelType get_label_type ( ) const
virtualinherited

get label type

Returns
label type LT_STRUCTURED

Implements CLabels.

Definition at line 104 of file StructuredLabels.h.

CDynamicObjectArray * get_labels ( ) const
inherited

get labels

not possible with subset

Returns
labels

Definition at line 40 of file StructuredLabels.cpp.

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

Definition at line 1135 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 1159 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 1172 of file SGObject.cpp.

CMultilabelLabels * get_multilabel_labels ( )
virtual
Returns
multilabel-labels object

Definition at line 97 of file MultilabelSOLabels.cpp.

virtual const char* get_name ( ) const
virtual
Returns
name of the SGSerializable

Reimplemented from CStructuredLabels.

Definition at line 115 of file MultilabelSOLabels.h.

int32_t get_num_classes ( ) const
virtual
Returns
number of classes (per label)

Definition at line 87 of file MultilabelSOLabels.cpp.

int32_t get_num_labels ( ) const
virtual
Returns
number of stored labels

Reimplemented from CStructuredLabels.

Definition at line 77 of file MultilabelSOLabels.cpp.

SGVector< int32_t > get_sparse_label ( int32_t  j)
virtual

get sparse assigment for j-th label

Parameters
jlabel index

Definition at line 121 of file MultilabelSOLabels.cpp.

EStructuredDataType get_structured_data_type ( )
inherited

get structured data type the labels are composed of

Returns
structured data type

Definition at line 110 of file StructuredLabels.h.

float64_t get_value ( int32_t  idx)
virtualinherited

get confidence value for a particular label

Parameters
idxlabel index
Returns
confidence value of label with index idx

Definition at line 59 of file Labels.cpp.

SGVector< float64_t > get_values ( )
virtualinherited

get confidence vector

Returns
confidences

Definition at line 90 of file Labels.cpp.

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 297 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::get_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 704 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 545 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
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
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 374 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 1062 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 1057 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 742 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
)
protectedvirtualinherited

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 949 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 
)
protectedvirtualinherited

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

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

Definition at line 263 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1111 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 309 of file SGObject.cpp.

void remove_all_subsets ( )
virtualinherited

removes all subsets Calls subset_changed_post() afterwards

Definition at line 54 of file Labels.cpp.

void remove_subset ( )
virtualinherited

removes that last added subset from subset stack, if existing Calls subset_changed_post() afterwards

Definition at line 49 of file Labels.cpp.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
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
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 315 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 1072 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 1067 of file SGObject.cpp.

void set_generic< complex128_t > ( )
inherited

set generic type to T

Definition at line 42 of file SGObject.cpp.

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 230 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 243 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 284 of file SGObject.cpp.

bool set_label ( int32_t  j,
CStructuredData label 
)
virtual

set assignment for j-th label

Parameters
jlabel index
labelsparse label

Reimplemented from CStructuredLabels.

Definition at line 102 of file MultilabelSOLabels.cpp.

void set_sparse_label ( int32_t  j,
SGVector< int32_t >  label 
)
virtual

set sparse assignment for j-th label

Parameters
jlabel index
labelsparse label

Definition at line 57 of file MultilabelSOLabels.cpp.

void set_sparse_labels ( SGVector< int32_t > *  labels)
virtual

set sparse labels

Parameters
labelslist of sparse labels

Definition at line 67 of file MultilabelSOLabels.cpp.

void set_value ( float64_t  value,
int32_t  idx 
)
virtualinherited

set the confidence value for a particular label

Parameters
valuevalue to set
idxlabel index whose conf. value is to be changed

Definition at line 66 of file Labels.cpp.

void set_values ( SGVector< float64_t values)
virtualinherited

set confidence vector

Parameters
valuesto be set (should have zero length to disable values or length must match the number of labels)

Definition at line 78 of file Labels.cpp.

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

SGVector< float64_t > to_dense ( CStructuredData label,
int32_t  dense_dim,
float64_t  d_true,
float64_t  d_false 
)
static

Convert sparse labels to dense. The dense vector would be {d_true; d_false}^dense_dim. Indices in sparse would be marked "d_true", everything else "d_false".

Parameters
labelsparse label to convert
dense_dimdense dimension
d_truemarker for "true" labels
d_falsemarker for "false" labels
Returns
SGVector<float64_t> dense vector of dimension dense_dim

Definition at line 131 of file MultilabelSOLabels.cpp.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 304 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 250 of file SGObject.cpp.

Member Data Documentation

SGIO* io
inherited

io

Definition at line 496 of file SGObject.h.

SGVector<float64_t> m_current_values
protectedinherited

current active value vector

Definition at line 135 of file Labels.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 511 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 517 of file SGObject.h.

CDynamicObjectArray* m_labels
protectedinherited

the vector of labels

Definition at line 121 of file StructuredLabels.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 508 of file SGObject.h.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 514 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 505 of file SGObject.h.

EStructuredDataType m_sdt
protectedinherited

the structured data type the labels are composed of

Definition at line 124 of file StructuredLabels.h.

CSubsetStack* m_subset_stack
protectedinherited

subset class to enable subset support for this class

Definition at line 132 of file Labels.h.

Parallel* parallel
inherited

parallel

Definition at line 499 of file SGObject.h.

Version* version
inherited

version

Definition at line 502 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation