CFactor类 参考

详细描述

Class CFactor A factor is defined on a clique in the factor graph. Each factor can have its own data, either dense, sparse or shared data. Note that currently this class is table factor oriented.

在文件 Factor.h 第 89 行定义.

类 CFactor 继承关系图:

Public 成员函数
	CFactor ()
	CFactor (CTableFactorType *ftype, SGVector< int32_t > var_index, SGVector< float64_t > data)
	CFactor (CTableFactorType *ftype, SGVector< int32_t > var_index, SGSparseVector< float64_t > data_sparse)
	CFactor (CTableFactorType *ftype, SGVector< int32_t > var_index, CFactorDataSource *data_source)
virtual	~CFactor ()
virtual const char *	get_name () const
CTableFactorType *	get_factor_type () const
void	set_factor_type (CTableFactorType *ftype)
const SGVector< int32_t >	get_variables () const
const int32_t	get_num_vars () const
void	set_variables (SGVector< int32_t > vars)
const SGVector< int32_t >	get_cardinalities () const
SGVector< float64_t >	get_data () const
SGSparseVector< float64_t >	get_data_sparse () const
void	set_data (SGVector< float64_t > data_dense)
void	set_data_sparse (SGSparseVectorEntry< float64_t > *data_sparse, int32_t dlen)
bool	is_data_dependent () const
bool	is_data_sparse () const
SGVector< float64_t >	get_energies () const
float64_t	get_energy (int32_t index) const
void	set_energies (SGVector< float64_t > ft_energies)
void	set_energy (int32_t ei, float64_t value)
float64_t	evaluate_energy (const SGVector< int32_t > state) const
void	compute_energies ()
void	compute_gradients (const SGVector< float64_t > marginals, SGVector< float64_t > &parameter_gradient, double mult=1.0) const
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 属性
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 属性
CTableFactorType *	m_factor_type
SGVector< int32_t >	m_var_index
SGVector< float64_t >	m_energies
CFactorDataSource *	m_data_source
SGVector< float64_t >	m_data
SGSparseVector< float64_t >	m_data_sparse
bool	m_is_data_dep

构造及析构函数说明

CFactor

(

)

default constructor

在文件 Factor.cpp 第 16 行定义.

CFactor	(	CTableFactorType *	ftype,
		SGVector< int32_t >	var_index,
		SGVector< float64_t >	data
	)

Constructor

参数

ftype	factor type
var_index	indices of variables
data	dense data, can be empty

在文件 Factor.cpp 第 22 行定义.

CFactor	(	CTableFactorType *	ftype,
		SGVector< int32_t >	var_index,
		SGSparseVector< float64_t >	data_sparse
	)

Constructor

参数

ftype	factor type
var_index	indices of variables
data_sparse	sparse data, can be empty

在文件 Factor.cpp 第 45 行定义.

CFactor	(	CTableFactorType *	ftype,
		SGVector< int32_t >	var_index,
		CFactorDataSource *	data_source
	)

Constructor

参数

ftype	factor type
var_index	indices of variables
data_source	common data for many factors

在文件 Factor.cpp 第 68 行定义.

~CFactor ( )

virtual

deconstructor

在文件 Factor.cpp 第 89 行定义.

成员函数说明

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

void compute_energies

(

)

Compute energy table

在文件 Factor.cpp 第 210 行定义.

void compute_gradients	(	const SGVector< float64_t >	marginals,
		SGVector< float64_t > &	parameter_gradient,
		double	mult = 1.0
	)		const

Compute parameter gradient from marginals and factor data

参数

marginals	marginal distribution of the factor
parameter_gradient	output gradients
mult	multiplier

在文件 Factor.cpp 第 229 行定义.

CSGObject * deep_copy ( ) const

virtualinherited

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

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

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

float64_t evaluate_energy

(

const SGVector< int32_t >

state

)

const

evaluate energy for a given assignment

参数

state

variable assignments

返回

energy

在文件 Factor.cpp 第 204 行定义.

const SGVector< int32_t > get_cardinalities

(

)

const

返回

cardinalities of variables

在文件 Factor.cpp 第 122 行定义.

SGVector< float64_t > get_data

(

)

const

返回

dense factor data

在文件 Factor.cpp 第 127 行定义.

SGSparseVector< float64_t > get_data_sparse

(

)

const

返回

sparse factor data, note that call get_dense() to get SGVector

在文件 Factor.cpp 第 135 行定义.

SGVector< float64_t > get_energies

(

)

const

返回

energy table which are in Matlab-linearized order: leftmost indices run by one.

在文件 Factor.cpp 第 169 行定义.

float64_t get_energy

(

int32_t

index

)

const

get an entry in the energy table

参数

index

in the table

返回

energy value

在文件 Factor.cpp 第 180 行定义.

CTableFactorType * get_factor_type

(

)

const

返回

factor type pointer

在文件 Factor.cpp 第 95 行定义.

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

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

返回

class name

实现了 CSGObject.

在文件 Factor.h 第 125 行定义.

const int32_t get_num_vars

(

)

const

返回

number of the adjacent variables

在文件 Factor.cpp 第 112 行定义.

const SGVector< int32_t > get_variables

(

)

const

返回

adjacent variables

在文件 Factor.cpp 第 107 行定义.

bool is_data_dependent

(

)

const

返回

whether this factor has data

在文件 Factor.cpp 第 156 行定义.

bool is_data_sparse

(

)

const

返回

whether data vector is sparse

在文件 Factor.cpp 第 161 行定义.

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

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_data

(

SGVector< float64_t >

data_dense

)

set dense data

参数

data_dense

data vector

在文件 Factor.cpp 第 143 行定义.

void set_data_sparse	(	SGSparseVectorEntry< float64_t > *	data_sparse,
		int32_t	dlen
	)

set sparse data

参数

data_sparse	pointer to sparse entries
dlen	number of entries

在文件 Factor.cpp 第 149 行定义.

void set_energies

(

SGVector< float64_t >

ft_energies

)

set energies with new values

参数

ft_energies

new energy table

在文件 Factor.cpp 第 185 行定义.

void set_energy	(	int32_t	ei,
		float64_t	value
	)

set energy for a particular state

参数

ei	index in the energy table
value	energy value

在文件 Factor.cpp 第 193 行定义.

void set_factor_type

(

CTableFactorType *

ftype

)

set factor type

参数

ftype

factor type

在文件 Factor.cpp 第 101 行定义.

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_variables

(

SGVector< int32_t >

vars

)

set variables

参数

vars	indices of variables

在文件 Factor.cpp 第 117 行定义.

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

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_data

protected

dense data

在文件 Factor.h 第 230 行定义.

CFactorDataSource* m_data_source

protected

shared data

在文件 Factor.h 第 227 行定义.

SGSparseVector<float64_t> m_data_sparse

protected

sparse data

在文件 Factor.h 第 233 行定义.

SGVector<float64_t> m_energies

protected

energy table

在文件 Factor.h 第 224 行定义.

CTableFactorType* m_factor_type

protected

factor type

在文件 Factor.h 第 218 行定义.

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

bool m_is_data_dep

protected

whether the factor is data dependent

在文件 Factor.h 第 236 行定义.

Parameter* m_model_selection_parameters

inherited

model selection parameters

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

Parameter* m_parameters

inherited

parameters

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

SGVector<int32_t> m_var_index

protected

variable indices

在文件 Factor.h 第 221 行定义.

Parallel* parallel

inherited

parallel

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

Version* version

inherited

version

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

---

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

• Factor.h
• Factor.cpp