CSequenceLabels Class Reference

Detailed Description

Class CSequenceLabels used e.g. in the application of Structured Output (SO) learning to Hidden Markov Support Vector Machines (HM-SVM). Each of the labels is represented by a sequence of integers. Each label is of type CSequence and all of them are stored in a CDynamicObjectArray.

Definition at line 73 of file SequenceLabels.h.

Inheritance diagram for CSequenceLabels:

Public Member Functions
	CSequenceLabels ()
	CSequenceLabels (int32_t num_labels, int32_t num_states)
	CSequenceLabels (SGVector< int32_t > labels, int32_t label_length, int32_t num_labels, int32_t num_states)
virtual	~CSequenceLabels ()
virtual const char *	get_name () const
void	add_vector_label (SGVector< int32_t > label)
int32_t	get_num_states () const
virtual void	ensure_valid (const char *context=NULL)
virtual void	add_label (CStructuredData *label)
CDynamicObjectArray *	get_labels () const
virtual CStructuredData *	get_label (int32_t idx)
virtual bool	set_label (int32_t idx, CStructuredData *label)
virtual int32_t	get_num_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_t >	get_values ()
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 Attributes
SGIO *	io
Parallel *	parallel
Version *	version
Parameter *	m_parameters
Parameter *	m_model_selection_parameters
Parameter *	m_gradient_parameters
uint32_t	m_hash

Protected Member Functions
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
CDynamicObjectArray *	m_labels
EStructuredDataType	m_sdt
CSubsetStack *	m_subset_stack
SGVector< float64_t >	m_current_values

Constructor & Destructor Documentation

CSequenceLabels

(

)

default constructor

Definition at line 15 of file SequenceLabels.cpp.

CSequenceLabels	(	int32_t	num_labels,
		int32_t	num_states
	)

standard constructor

Parameters

num_labels	number of labels
num_states	number of states

Definition at line 20 of file SequenceLabels.cpp.

CSequenceLabels	(	SGVector< int32_t >	labels,
		int32_t	label_length,
		int32_t	num_labels,
		int32_t	num_states
	)

constructor using the data of all the labels concatenated. All the labels are assumed to have the same length. The length of labels must be equal to label_length times num_labels.

Parameters

labels	concatenation of the labels
label_length	number of elements in each label
num_labels	number of labels
num_states	number of states

Definition at line 26 of file SequenceLabels.cpp.

~CSequenceLabels ( )

virtual

destructor

Definition at line 42 of file SequenceLabels.cpp.

Member Function Documentation

void add_label ( CStructuredData *  label )

virtualinherited

add a new label to the vector of labels, effectively increasing the number of elements of the structure. This method should be used when inserting labels for the first time.

Parameters

label

label to add

Reimplemented in CMultilabelSOLabels, and CMulticlassSOLabels.

Definition at line 55 of file StructuredLabels.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

subset

subset 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

subset

subset of indices to replace the latest one with.

Definition at line 44 of file Labels.cpp.

void add_vector_label

(

SGVector< int32_t >

label

)

add a new label to the vector of labels, effectively increasing the number of elements of the structure. This method should be used when inserting labels for the first time. NOTE: the elements of the labels have to be in the interval [0, 1, ..., num_states-1].

Parameters

label

label to add

Definition at line 46 of file SequenceLabels.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

dict	dictionary 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.

CSGObject * deep_copy ( ) const

virtualinherited

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

Definition at line 198 of file SGObject.cpp.

void ensure_valid ( const char *  context = NULL )

virtualinherited

check if labeling is valid

possible with subset

Returns

if labeling is valid

Implements CLabels.

Reimplemented in CMultilabelSOLabels.

Definition at line 34 of file StructuredLabels.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

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

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.

CStructuredData * get_label ( int32_t  idx )

virtualinherited

get label object for specified index

Parameters

idx	index of the label

Returns

label object

Reimplemented in CMultilabelSOLabels, and CMulticlassSOLabels.

Definition at line 46 of file StructuredLabels.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 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_name

name 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_name

name 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

Returns

object name

Reimplemented from CStructuredLabels.

Definition at line 102 of file SequenceLabels.h.

int32_t get_num_labels ( ) const

virtualinherited

get number of labels, depending on wheter a subset is set

Returns

number of labels

Implements CLabels.

Reimplemented in CMulticlassSOLabels, and CMultilabelSOLabels.

Definition at line 76 of file StructuredLabels.cpp.

int32_t get_num_states

(

)

const

get the number of states

Returns

the number of states

Definition at line 119 of file SequenceLabels.h.

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

idx	label 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

generic

set 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

file	where to load from
prefix	prefix 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

ShogunException

will 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

ShogunException

will 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

prefix

prefix for members

Definition at line 308 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 = ""  )

virtualinherited

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

ShogunException

will 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

ShogunException

will 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

io	io object to use

Definition at line 228 of file SGObject.cpp.

void set_global_parallel ( Parallel *  parallel )

inherited

set the parallel object

Parameters

parallel

parallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version *  version )

inherited

set the version object

Parameters

version

version object to use

Definition at line 283 of file SGObject.cpp.

bool set_label ( int32_t  idx, CStructuredData *  label  )

virtualinherited

set label, possible with subset. This method should be used when substituting labels previously inserted. To insert new labels, use the method add_label.

Parameters

idx	index of label to set
label	value of label

Returns

if setting was successful

Reimplemented in CMultilabelSOLabels, and CMulticlassSOLabels.

Definition at line 61 of file StructuredLabels.cpp.

void set_value ( float64_t  value, int32_t  idx  )

virtualinherited

set the confidence value for a particular label

Parameters

value	value to set
idx	label 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

values

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

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 384 of file SGObject.h.

uint32_t m_hash

inherited

Hash of parameter values

Definition at line 387 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 381 of file SGObject.h.

Parameter* m_parameters

inherited

parameters

Definition at line 378 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 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:

• SequenceLabels.h
• SequenceLabels.cpp