CFactor Class Reference

Detailed Description

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.

Definition at line 89 of file Factor.h.

Inheritance diagram for CFactor:

Public Member Functions
	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 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
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

Constructor & Destructor Documentation

CFactor

(

)

default constructor

Definition at line 16 of file Factor.cpp.

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

Constructor

Parameters

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

Definition at line 22 of file Factor.cpp.

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

Constructor

Parameters

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

Definition at line 45 of file Factor.cpp.

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

Constructor

Parameters

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

Definition at line 68 of file Factor.cpp.

~CFactor ( )

virtual

deconstructor

Definition at line 89 of file Factor.cpp.

Member Function Documentation

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.

void compute_energies

(

)

Compute energy table

Definition at line 210 of file Factor.cpp.

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

Parameters

marginals	marginal distribution of the factor
parameter_gradient	output gradients
mult	multiplier

Definition at line 229 of file Factor.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.

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.

float64_t evaluate_energy

(

const SGVector< int32_t >

state

)

const

evaluate energy for a given assignment

Parameters

state

variable assignments

Returns

energy

Definition at line 204 of file Factor.cpp.

const SGVector< int32_t > get_cardinalities

(

)

const

Returns

cardinalities of variables

Definition at line 122 of file Factor.cpp.

SGVector< float64_t > get_data

(

)

const

Returns

dense factor data

Definition at line 127 of file Factor.cpp.

SGSparseVector< float64_t > get_data_sparse

(

)

const

Returns

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

Definition at line 135 of file Factor.cpp.

SGVector< float64_t > get_energies

(

)

const

Returns

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

Definition at line 169 of file Factor.cpp.

float64_t get_energy

(

int32_t

index

)

const

get an entry in the energy table

Parameters

index

in the table

Returns

energy value

Definition at line 180 of file Factor.cpp.

CTableFactorType * get_factor_type

(

)

const

Returns

factor type pointer

Definition at line 95 of file Factor.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.

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

class name

Implements CSGObject.

Definition at line 125 of file Factor.h.

const int32_t get_num_vars

(

)

const

Returns

number of the adjacent variables

Definition at line 112 of file Factor.cpp.

const SGVector< int32_t > get_variables

(

)

const

Returns

adjacent variables

Definition at line 107 of file Factor.cpp.

bool is_data_dependent

(

)

const

Returns

whether this factor has data

Definition at line 156 of file Factor.cpp.

bool is_data_sparse

(

)

const

Returns

whether data vector is sparse

Definition at line 161 of file Factor.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.

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_data

(

SGVector< float64_t >

data_dense

)

set dense data

Parameters

data_dense

data vector

Definition at line 143 of file Factor.cpp.

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

set sparse data

Parameters

data_sparse	pointer to sparse entries
dlen	number of entries

Definition at line 149 of file Factor.cpp.

void set_energies

(

SGVector< float64_t >

ft_energies

)

set energies with new values

Parameters

ft_energies

new energy table

Definition at line 185 of file Factor.cpp.

void set_energy	(	int32_t	ei,
		float64_t	value
	)

set energy for a particular state

Parameters

ei	index in the energy table
value	energy value

Definition at line 193 of file Factor.cpp.

void set_factor_type

(

CTableFactorType *

ftype

)

set factor type

Parameters

ftype

factor type

Definition at line 101 of file Factor.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.

void set_variables

(

SGVector< int32_t >

vars

)

set variables

Parameters

vars	indices of variables

Definition at line 117 of file Factor.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_data

protected

dense data

Definition at line 230 of file Factor.h.

CFactorDataSource* m_data_source

protected

shared data

Definition at line 227 of file Factor.h.

SGSparseVector<float64_t> m_data_sparse

protected

sparse data

Definition at line 233 of file Factor.h.

SGVector<float64_t> m_energies

protected

energy table

Definition at line 224 of file Factor.h.

CTableFactorType* m_factor_type

protected

factor type

Definition at line 218 of file Factor.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.

bool m_is_data_dep

protected

whether the factor is data dependent

Definition at line 236 of file Factor.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.

SGVector<int32_t> m_var_index

protected

variable indices

Definition at line 221 of file Factor.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:

• Factor.h
• Factor.cpp