SHOGUN  3.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
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:
Inheritance graph
[legend]

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
CTableFactorTypeget_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_tget_data () const
SGSparseVector< float64_tget_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_tget_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 CSGObjectshallow_copy () const
virtual CSGObjectdeep_copy () const
virtual bool is_generic (EPrimitiveType *generic) const
template<class T >
void set_generic ()
void unset_generic ()
virtual void print_serializable (const char *prefix="")
virtual bool save_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter())
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter())
DynArray< TParameter * > * load_file_parameters (const SGParamInfo *param_info, int32_t file_version, CSerializableFile *file, const char *prefix="")
DynArray< TParameter * > * load_all_file_parameters (int32_t file_version, int32_t current_version, CSerializableFile *file, const char *prefix="")
void map_parameters (DynArray< TParameter * > *param_base, int32_t &base_version, DynArray< const SGParamInfo * > *target_param_infos)
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 Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
Parameterm_gradient_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

virtual TParametermigrate (DynArray< TParameter * > *param_base, const SGParamInfo *target)
virtual void one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL)
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

CTableFactorTypem_factor_type
SGVector< int32_t > m_var_index
SGVector< float64_tm_energies
CFactorDataSourcem_data_source
SGVector< float64_tm_data
SGSparseVector< float64_tm_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
ftypefactor type
var_indexindices of variables
datadense 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
ftypefactor type
var_indexindices of variables
data_sparsesparse 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
ftypefactor type
var_indexindices of variables
data_sourcecommon 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
dictdictionary of parameters to be built.

Definition at line 1189 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 1306 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
marginalsmarginal distribution of the factor
parameter_gradientoutput gradients
multmultiplier

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 146 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
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 1210 of file SGObject.cpp.

float64_t evaluate_energy ( const SGVector< int32_t >  state) const

evaluate energy for a given assignment

Parameters
statevariable 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
indexin 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 183 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 224 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 237 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 1081 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_namename of the parameter
Returns
description of the parameter

Definition at line 1105 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_namename of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 1118 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
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 243 of file SGObject.cpp.

DynArray< TParameter * > * load_all_file_parameters ( int32_t  file_version,
int32_t  current_version,
CSerializableFile file,
const char *  prefix = "" 
)
inherited

maps all parameters of this instance to the provided file version and loads all parameter data from the file into an array, which is sorted (basically calls load_file_parameter(...) for all parameters and puts all results into a sorted array)

Parameters
file_versionparameter version of the file
current_versionversion from which mapping begins (you want to use Version::get_version_parameter() for this in most cases)
filefile to load from
prefixprefix for members
Returns
(sorted) array of created TParameter instances with file data

Definition at line 650 of file SGObject.cpp.

DynArray< TParameter * > * load_file_parameters ( const SGParamInfo param_info,
int32_t  file_version,
CSerializableFile file,
const char *  prefix = "" 
)
inherited

loads some specified parameters from a file with a specified version The provided parameter info has a version which is recursively mapped until the file parameter version is reached. Note that there may be possibly multiple parameters in the mapping, therefore, a set of TParameter instances is returned

Parameters
param_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
Returns
new array with TParameter instances with the attached data

Definition at line 491 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
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
filewhere to load from
prefixprefix for members
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 320 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
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 1008 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
ShogunExceptionwill 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 1003 of file SGObject.cpp.

void map_parameters ( DynArray< TParameter * > *  param_base,
int32_t &  base_version,
DynArray< const SGParamInfo * > *  target_param_infos 
)
inherited

Takes a set of TParameter instances (base) with a certain version and a set of target parameter infos and recursively maps the base level wise to the current version using CSGObject::migrate(...). The base is replaced. After this call, the base version containing parameters should be of same version/type as the initial target parameter infos. Note for this to work, the migrate methods and all the internal parameter mappings have to match

Parameters
param_baseset of TParameter instances that are mapped to the provided target parameter infos
base_versionversion of the parameter base
target_param_infosset of SGParamInfo instances that specify the target parameter base

Definition at line 688 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
)
protectedvirtualinherited

creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.

If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass

Parameters
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
Returns
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 895 of file SGObject.cpp.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
)
protectedvirtualinherited

This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)

Parameters
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
replacement(used as output) here the TParameter instance which is returned by migration is created into
to_migratethe only source that is used for migration
old_namewith this parameter, a name change may be specified

Definition at line 835 of file SGObject.cpp.

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

Definition at line 209 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1057 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 255 of file SGObject.cpp.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

Save this object to file.

Parameters
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 261 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
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 1018 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
ShogunExceptionwill 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 1013 of file SGObject.cpp.

void set_data ( SGVector< float64_t data_dense)

set dense data

Parameters
data_densedata 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_sparsepointer to sparse entries
dlennumber 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_energiesnew 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
eiindex in the energy table
valueenergy value

Definition at line 193 of file Factor.cpp.

void set_factor_type ( CTableFactorType ftype)

set factor type

Parameters
ftypefactor type

Definition at line 101 of file Factor.cpp.

void set_generic< complex128_t > ( )
inherited

set generic type to T

Definition at line 38 of file SGObject.cpp.

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 176 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 189 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 230 of file SGObject.cpp.

void set_variables ( SGVector< int32_t >  vars)

set variables

Parameters
varsindices 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 140 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 250 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 196 of file SGObject.cpp.

Member Data Documentation

SGIO* io
inherited

io

Definition at line 457 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 472 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 478 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 469 of file SGObject.h.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 475 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 466 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 460 of file SGObject.h.

Version* version
inherited

version

Definition at line 463 of file SGObject.h.


The documentation for this class was generated from the following files:

SHOGUN Machine Learning Toolbox - Documentation