CMultilabelLabels类 参考

详细描述

Multilabel Labels for multi-label classification.

Labels are subsets of {0, ..., num_classes-1}

在文件 MultilabelLabels.h 第 51 行定义.

类 CMultilabelLabels 继承关系图:

Public 成员函数
	CMultilabelLabels ()
	CMultilabelLabels (int32_t num_classes)
	CMultilabelLabels (int32_t num_labels, int32_t num_classes)
	~CMultilabelLabels ()
void	ensure_valid (const char *context=NULL)
virtual ELabelType	get_label_type () const
virtual const char *	get_name () const
virtual int32_t	get_num_labels () const
virtual int32_t	get_num_classes () const
void	set_labels (SGVector< int32_t > *labels)
SGVector< int32_t > **	get_class_labels () const
SGMatrix< int32_t >	get_labels () const
SGVector< int32_t >	get_label (int32_t j)
void	set_label (int32_t j, SGVector< int32_t > label)
void	set_class_labels (SGVector< int32_t > **labels_list)
void	display () const
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 成员函数
template<class S , class D >
static SGVector< D >	to_dense (SGVector< S > *sparse, int32_t dense_len, D d_true, D d_false)

Public 属性
SGIO *	io
Parallel *	parallel
Version *	version
Parameter *	m_parameters
Parameter *	m_model_selection_parameters
Parameter *	m_gradient_parameters
uint32_t	m_hash

Protected 成员函数
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 属性
int32_t	m_num_labels
int32_t	m_num_classes
SGVector< int32_t > *	m_labels
CSubsetStack *	m_subset_stack
SGVector< float64_t >	m_current_values

构造及析构函数说明

CMultilabelLabels

(

)

default constructor

在文件 MultilabelLabels.cpp 第 37 行定义.

CMultilabelLabels

(

int32_t

num_classes

)

constructor

参数

num_classes

number of (binary) class assignments per label

在文件 MultilabelLabels.cpp 第 44 行定义.

CMultilabelLabels	(	int32_t	num_labels,
		int32_t	num_classes
	)

constructor

参数

num_labels	number of labels
num_classes	number of (binary) class assignments per label

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

~CMultilabelLabels

(

)

destructor

在文件 MultilabelLabels.cpp 第 58 行定义.

成员函数说明

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)

参数

subset

subset of indices to add

在文件 Labels.cpp 第 39 行定义.

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.

参数

subset

subset of indices to replace the latest one with.

在文件 Labels.cpp 第 44 行定义.

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 行定义.

CSGObject * deep_copy ( ) const

virtualinherited

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

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

void display

(

)

const

print the current labeling

在文件 MultilabelLabels.cpp 第 331 行定义.

void ensure_valid ( const char *  context = NULL )

virtual

Make sure the label is valid, otherwise raise SG_ERROR.

possible with subset

参数

context

optional message to convey the context

实现了 CLabels.

在文件 MultilabelLabels.cpp 第 94 行定义.

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 行定义.

SGVector< int32_t > ** get_class_labels

(

)

const

get list of sparse class labels (one vector per class)

返回

list of sparse class labels

在文件 MultilabelLabels.cpp 第 148 行定义.

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 行定义.

SGVector< int32_t > get_label

(

int32_t

j

)

get sparse assignment for j-th label

返回

sparse label

在文件 MultilabelLabels.cpp 第 225 行定义.

virtual ELabelType get_label_type ( ) const

virtual

get label type

返回

label type multiclass

实现了 CLabels.

在文件 MultilabelLabels.h 第 85 行定义.

SGMatrix< int32_t > get_labels

(

)

const

get label matrix, only for multiclass multiple output labels

返回

label matrix

在文件 MultilabelLabels.cpp 第 206 行定义.

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

返回

object name

实现了 CSGObject.

在文件 MultilabelLabels.h 第 91 行定义.

int32_t get_num_classes ( ) const

virtual

return number of classes (per label)

返回

number of classes

在文件 MultilabelLabels.cpp 第 131 行定义.

int32_t get_num_labels ( ) const

virtual

get the number of stored labels

返回

the number of labels

实现了 CLabels.

在文件 MultilabelLabels.cpp 第 124 行定义.

float64_t get_value ( int32_t  idx )

virtualinherited

get confidence value for a particular label

参数

idx	label index

返回

confidence value of label with index idx

在文件 Labels.cpp 第 59 行定义.

SGVector< float64_t > get_values ( )

virtualinherited

get confidence vector

返回

confidences

在文件 Labels.cpp 第 90 行定义.

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 行定义.

void remove_all_subsets ( )

virtualinherited

removes all subsets Calls subset_changed_post() afterwards

在文件 Labels.cpp 第 54 行定义.

void remove_subset ( )

virtualinherited

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

在文件 Labels.cpp 第 49 行定义.

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_class_labels

(

SGVector< int32_t > **

labels_list

)

assigning class labels

在文件 MultilabelLabels.cpp 第 270 行定义.

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 行定义.

void set_label	(	int32_t	j,
		SGVector< int32_t >	label
	)

set sparse assignment for j-th label

参数

j	label index
label	sparse label

在文件 MultilabelLabels.cpp 第 260 行定义.

void set_labels

(

SGVector< int32_t > *

labels

)

set labels

参数

labels

list of sparse labels

在文件 MultilabelLabels.cpp 第 138 行定义.

void set_value ( float64_t  value, int32_t  idx  )

virtualinherited

set the confidence value for a particular label

参数

value	value to set
idx	label index whose conf. value is to be changed

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

void set_values ( SGVector< float64_t >  values )

virtualinherited

set confidence vector

参数

values

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

在文件 Labels.cpp 第 78 行定义.

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 行定义.

template SGVector< float64_t > to_dense< int32_t, float64_t > ( SGVector< S > *  sparse, int32_t  dense_len, D  d_true, D  d_false  )

static

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

参数

sparse	sparse vector to convert
dense_len	dimension
d_true	marker for "true" labels
d_false	marker for "false" labels

返回

dense vector of dimension dense_len

在文件 MultilabelLabels.cpp 第 236 行定义.

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 行定义.

SGVector<float64_t> m_current_values

protectedinherited

current active value vector

在文件 Labels.h 第 135 行定义.

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 行定义.

SGVector<int32_t>* m_labels

protected

Labels themselves

在文件 MultilabelLabels.h 第 170 行定义.

Parameter* m_model_selection_parameters

inherited

model selection parameters

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

int32_t m_num_classes

protected

Number of classes

在文件 MultilabelLabels.h 第 167 行定义.

int32_t m_num_labels

protected

Number of labels

在文件 MultilabelLabels.h 第 164 行定义.

Parameter* m_parameters

inherited

parameters

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

CSubsetStack* m_subset_stack

protectedinherited

subset class to enable subset support for this class

在文件 Labels.h 第 132 行定义.

Parallel* parallel

inherited

parallel

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

Version* version

inherited

version

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

---

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

• MultilabelLabels.h
• MultilabelLabels.cpp