SHOGUN  4.1.0
 全部  命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义  
所有成员列表 | Public 成员函数 | Public 属性 | 静态 Public 属性 | Protected 成员函数 | Protected 属性
CMulticlassLabels类 参考

详细描述

Multiclass Labels for multi-class classification.

valid values for labels are 0...nr_classes-1

在文件 MulticlassLabels.h36 行定义.

类 CMulticlassLabels 继承关系图:
Inheritance graph
[图例]

Public 成员函数

 CMulticlassLabels ()
 
 CMulticlassLabels (int32_t num_labels)
 
 CMulticlassLabels (SGVector< float64_t > src)
 
 CMulticlassLabels (CFile *loader)
 
 ~CMulticlassLabels ()
 
virtual void ensure_valid (const char *context=NULL)
 
virtual ELabelType get_label_type () const
 
CBinaryLabelsget_binary_for_class (int32_t i)
 
SGVector< float64_tget_unique_labels ()
 
int32_t get_num_classes ()
 
SGVector< float64_tget_multiclass_confidences (int32_t i)
 
void set_multiclass_confidences (int32_t i, SGVector< float64_t > confidences)
 
void allocate_confidences_for (int32_t n_classes)
 
virtual const char * get_name () const
 
virtual void load (CFile *loader)
 
virtual void save (CFile *writer)
 
bool set_label (int32_t idx, float64_t label)
 
bool set_int_label (int32_t idx, int32_t label)
 
float64_t get_label (int32_t idx)
 
int32_t get_int_label (int32_t idx)
 
SGVector< float64_tget_labels ()
 
SGVector< float64_tget_labels_copy ()
 
void set_labels (SGVector< float64_t > v)
 
void set_to_one ()
 
void zero ()
 
void set_to_const (float64_t c)
 
SGVector< int32_t > get_int_labels ()
 
void set_int_labels (SGVector< int32_t > labels)
 
void set_int_labels (SGVector< int64_t > labels)
 
virtual int32_t get_num_labels () 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_tget_values ()
 
virtual CSGObjectshallow_copy () const
 
virtual CSGObjectdeep_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)
 
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 ()
 

Public 属性

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
uint32_t m_hash
 

静态 Public 属性

static const int32_t REJECTION_LABEL = -2
 

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

SGMatrix< float64_tm_multiclass_confidences
 
SGVector< float64_tm_labels
 
CSubsetStackm_subset_stack
 
SGVector< float64_tm_current_values
 

构造及析构函数说明

default constructor

在文件 MulticlassLabels.cpp7 行定义.

CMulticlassLabels ( int32_t  num_labels)

constructor

参数
num_labelsnumber of labels

在文件 MulticlassLabels.cpp12 行定义.

constructor

参数
srclabels to set

在文件 MulticlassLabels.cpp17 行定义.

CMulticlassLabels ( CFile loader)

constructor

参数
loaderFile object via which to load data

在文件 MulticlassLabels.cpp23 行定义.

destructor

在文件 MulticlassLabels.cpp28 行定义.

成员函数说明

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)

参数
subsetsubset of indices to add

在文件 Labels.cpp39 行定义.

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.

参数
subsetsubset of indices to replace the latest one with.

在文件 Labels.cpp44 行定义.

void allocate_confidences_for ( int32_t  n_classes)

allocates matrix to store confidences. should always be called before setting confidences with set_multiclass_confidences

参数
n_classesnumber of classes

在文件 MulticlassLabels.cpp57 行定义.

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.

参数
dictdictionary of parameters to be built.

在文件 SGObject.cpp597 行定义.

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

CSGObject * deep_copy ( ) const
virtualinherited

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

在文件 SGObject.cpp198 行定义.

void ensure_valid ( const char *  context = NULL)
virtual

Make sure the label is valid, otherwise raise SG_ERROR.

possible with subset

参数
contextoptional message to convey the context

重载 CDenseLabels .

在文件 MulticlassLabels.cpp66 行定义.

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.

参数
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
返回
true if all parameters were equal, false if not

在文件 SGObject.cpp618 行定义.

CBinaryLabels * get_binary_for_class ( int32_t  i)

returns labels containing +1 at positions with ith class and -1 at other positions

参数
iindex of class
返回
new binary labels

在文件 MulticlassLabels.cpp89 行定义.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp235 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp277 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp290 行定义.

int32_t get_int_label ( int32_t  idx)
inherited

get INT label

possible with subset

参数
idxindex of label to get
返回
INT value of label

在文件 DenseLabels.cpp191 行定义.

SGVector< int32_t > get_int_labels ( )
inherited

get INT label vector

possible with subset

返回
INT labels

在文件 DenseLabels.cpp105 行定义.

float64_t get_label ( int32_t  idx)
inherited

get label

possible with subset

参数
idxindex of label to get
返回
value of label

在文件 DenseLabels.cpp184 行定义.

ELabelType get_label_type ( ) const
virtual

get label type

返回
label type multiclass

实现了 CDenseLabels.

在文件 MulticlassLabels.cpp84 行定义.

SGVector< float64_t > get_labels ( )
inherited

Getter for labels

返回
labels, a copy if a subset is set

在文件 DenseLabels.cpp82 行定义.

SGVector< float64_t > get_labels_copy ( )
inherited

get copy of labels.

possible with subset

返回
labels

在文件 DenseLabels.cpp90 行定义.

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

在文件 SGObject.cpp498 行定义.

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数
param_namename of the parameter
返回
description of the parameter

在文件 SGObject.cpp522 行定义.

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

参数
param_namename of model selection parameter
返回
index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp535 行定义.

SGVector< float64_t > get_multiclass_confidences ( int32_t  i)

returns multiclass confidences

参数
iindex
返回
confidences of ith result

在文件 MulticlassLabels.cpp48 行定义.

virtual const char* get_name ( ) const
virtual
返回
object name

实现了 CSGObject.

在文件 MulticlassLabels.h125 行定义.

int32_t get_num_classes ( )

return number of classes (for multiclass)

possible with subset

返回
number of classes

在文件 MulticlassLabels.cpp132 行定义.

int32_t get_num_labels ( ) const
virtualinherited

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

返回
number of labels

实现了 CLabels.

在文件 DenseLabels.cpp201 行定义.

SGVector< float64_t > get_unique_labels ( )

get unique labels (new SGVector)

possible with subset

返回
unique labels

在文件 MulticlassLabels.cpp118 行定义.

float64_t get_value ( int32_t  idx)
virtualinherited

get confidence value for a particular label

参数
idxlabel index
返回
confidence value of label with index idx

在文件 Labels.cpp59 行定义.

SGVector< float64_t > get_values ( )
virtualinherited

get confidence vector

返回
confidences

在文件 Labels.cpp90 行定义.

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.

参数
genericset to the type of the generic if returning TRUE
返回
TRUE if a class template.

在文件 SGObject.cpp296 行定义.

void load ( CFile loader)
virtualinherited

load labels from file

any subset is removed before

参数
loaderFile object via which to load data

在文件 DenseLabels.cpp145 行定义.

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!

参数
filewhere to load from
prefixprefix for members
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp369 行定义.

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.

异常
ShogunExceptionwill be thrown if an error occurs.

CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp426 行定义.

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.

异常
ShogunExceptionwill be thrown if an error occurs.

CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp421 行定义.

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

在文件 SGObject.cpp262 行定义.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp474 行定义.

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

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp308 行定义.

void remove_all_subsets ( )
virtualinherited

removes all subsets Calls subset_changed_post() afterwards

在文件 Labels.cpp54 行定义.

void remove_subset ( )
virtualinherited

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

在文件 Labels.cpp49 行定义.

void save ( CFile writer)
virtualinherited

save labels to file

not possible with subset

参数
writerFile object via which to save data

在文件 DenseLabels.cpp152 行定义.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "" 
)
virtualinherited

Save this object to file.

参数
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp314 行定义.

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.

异常
ShogunExceptionwill be thrown if an error occurs.

CKernel 重载.

在文件 SGObject.cpp436 行定义.

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.

异常
ShogunExceptionwill be thrown if an error occurs.

CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp431 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp41 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp46 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp51 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp56 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp61 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp66 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp71 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp76 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp81 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp86 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp91 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp96 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp101 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp106 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp111 行定义.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO io)
inherited

set the io object

参数
ioio object to use

在文件 SGObject.cpp228 行定义.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp241 行定义.

void set_global_version ( Version version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp283 行定义.

bool set_int_label ( int32_t  idx,
int32_t  label 
)
inherited

set INT label

possible with subset

参数
idxindex of label to set
labelINT value of label
返回
if setting was successful

在文件 DenseLabels.cpp172 行定义.

void set_int_labels ( SGVector< int32_t >  labels)
inherited

set INT labels

not possible on subset

参数
labelsINT labels

在文件 DenseLabels.cpp115 行定义.

void set_int_labels ( SGVector< int64_t >  labels)
inherited

set INT64 labels

not possible on subset

参数
labelsINT labels

在文件 DenseLabels.cpp127 行定义.

bool set_label ( int32_t  idx,
float64_t  label 
)
inherited

set label

possible with subset

参数
idxindex of label to set
labelvalue of label
返回
if setting was successful

在文件 DenseLabels.cpp160 行定义.

void set_labels ( SGVector< float64_t v)
inherited

set labels

not possible with subset

参数
vlabels

在文件 DenseLabels.cpp74 行定义.

void set_multiclass_confidences ( int32_t  i,
SGVector< float64_t confidences 
)

sets multiclass confidences. to prepare labels for storing multiclass confidences call allocate_confidences_for

参数
iindex
confidencesconfidences to be set for ith result

在文件 MulticlassLabels.cpp37 行定义.

void set_to_const ( float64_t  c)
inherited

set all labels to a const value

possible with subset

参数
cconst to set labels to

在文件 DenseLabels.cpp63 行定义.

void set_to_one ( )
inherited

set all labels to +1

possible with subset

在文件 DenseLabels.cpp53 行定义.

void set_value ( float64_t  value,
int32_t  idx 
)
virtualinherited

set the confidence value for a particular label

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

在文件 Labels.cpp66 行定义.

void set_values ( SGVector< float64_t values)
virtualinherited

set confidence vector

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

在文件 Labels.cpp78 行定义.

CSGObject * shallow_copy ( ) const
virtualinherited

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

CGaussianKernel 重载.

在文件 SGObject.cpp192 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp303 行定义.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp248 行定义.

void zero ( )
inherited

set all labels to zero

possible with subset

在文件 DenseLabels.cpp58 行定义.

类成员变量说明

SGIO* io
inherited

io

在文件 SGObject.h369 行定义.

SGVector<float64_t> m_current_values
protectedinherited

current active value vector

在文件 Labels.h135 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h384 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h387 行定义.

SGVector<float64_t> m_labels
protectedinherited

the label vector

在文件 DenseLabels.h210 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h381 行定义.

SGMatrix<float64_t> m_multiclass_confidences
protected

multiclass confidences

在文件 MulticlassLabels.h134 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h378 行定义.

CSubsetStack* m_subset_stack
protectedinherited

subset class to enable subset support for this class

在文件 Labels.h132 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h372 行定义.

const int32_t REJECTION_LABEL = -2
staticinherited

label designates classify reject

在文件 DenseLabels.h203 行定义.

Version* version
inherited

version

在文件 SGObject.h375 行定义.


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

SHOGUN 机器学习工具包 - 项目文档