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

详细描述

Class FactorGraphLabels used e.g. in the application of Structured Output (SO) learning with the FactorGraphModel. Each of the labels is represented by a graph. Each label is of type CFactorGraphObservation and all of them are stored in a CDynamicObjectArray.

在文件 FactorGraphLabels.h89 行定义.

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

Public 成员函数

 CFactorGraphLabels ()
 
 CFactorGraphLabels (int32_t num_labels)
 
virtual ~CFactorGraphLabels ()
 
virtual const char * get_name () const
 
virtual void ensure_valid (const char *context=NULL)
 
virtual void add_label (CStructuredData *label)
 
CDynamicObjectArrayget_labels () const
 
virtual CStructuredDataget_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_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
 

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

CDynamicObjectArraym_labels
 
EStructuredDataType m_sdt
 
CSubsetStackm_subset_stack
 
SGVector< float64_tm_current_values
 

构造及析构函数说明

default constructor

在文件 FactorGraphLabels.cpp38 行定义.

CFactorGraphLabels ( int32_t  num_labels)

standard constructor

参数
num_labelsnumber of labels

在文件 FactorGraphLabels.cpp43 行定义.

~CFactorGraphLabels ( )
virtual

destructor

在文件 FactorGraphLabels.cpp49 行定义.

成员函数说明

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.

参数
labellabel to add

CMultilabelSOLabels , 以及 CMulticlassSOLabels 重载.

在文件 StructuredLabels.cpp55 行定义.

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

check if labeling is valid

possible with subset

返回
if labeling is valid

实现了 CLabels.

CMultilabelSOLabels 重载.

在文件 StructuredLabels.cpp34 行定义.

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

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

CStructuredData * get_label ( int32_t  idx)
virtualinherited

get label object for specified index

参数
idxindex of the label
返回
label object

CMultilabelSOLabels , 以及 CMulticlassSOLabels 重载.

在文件 StructuredLabels.cpp46 行定义.

virtual ELabelType get_label_type ( ) const
virtualinherited

get label type

返回
label type LT_STRUCTURED

实现了 CLabels.

在文件 StructuredLabels.h104 行定义.

CDynamicObjectArray * get_labels ( ) const
inherited

get labels

not possible with subset

返回
labels

在文件 StructuredLabels.cpp40 行定义.

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

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

重载 CStructuredLabels .

在文件 FactorGraphLabels.h105 行定义.

int32_t get_num_labels ( ) const
virtualinherited

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

返回
number of labels

实现了 CLabels.

CMulticlassSOLabels , 以及 CMultilabelSOLabels 重载.

在文件 StructuredLabels.cpp76 行定义.

EStructuredDataType get_structured_data_type ( )
inherited

get structured data type the labels are composed of

返回
structured data type

在文件 StructuredLabels.h110 行定义.

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

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

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

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

CMultilabelSOLabels , 以及 CMulticlassSOLabels 重载.

在文件 StructuredLabels.cpp61 行定义.

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

类成员变量说明

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

CDynamicObjectArray* m_labels
protectedinherited

the vector of labels

在文件 StructuredLabels.h121 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h381 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h378 行定义.

EStructuredDataType m_sdt
protectedinherited

the structured data type the labels are composed of

在文件 StructuredLabels.h124 行定义.

CSubsetStack* m_subset_stack
protectedinherited

subset class to enable subset support for this class

在文件 Labels.h132 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h372 行定义.

Version* version
inherited

version

在文件 SGObject.h375 行定义.


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

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