SHOGUN  5.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
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:
[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 ()
 
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)
 
bool has (const std::string &name) const
 
template<typename T >
bool has (const Tag< T > &tag) const
 
template<typename T , typename U = void>
bool has (const std::string &name) const
 
template<typename T >
void set (const Tag< T > &_tag, const T &value)
 
template<typename T , typename U = void>
void set (const std::string &name, const T &value)
 
template<typename T >
get (const Tag< T > &_tag) const
 
template<typename T , typename U = void>
get (const std::string &name) const
 
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
 
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)
 
template<typename T >
void register_param (Tag< T > &_tag, const T &value)
 
template<typename T >
void register_param (const std::string &name, const T &value)
 

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 630 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 747 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 231 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 651 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.

T get ( const Tag< T > &  _tag) const
inherited

Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
_tagname and type information of parameter
Returns
value of the parameter identified by the input tag

Definition at line 367 of file SGObject.h.

T get ( const std::string &  name) const
inherited

Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
namename of the parameter
Returns
value of the parameter corresponding to the input name and type

Definition at line 388 of file SGObject.h.

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 268 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 310 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 323 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 531 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 555 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 568 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 has ( const std::string &  name) const
inherited

Checks if object has a class parameter identified by a name.

Parameters
namename of the parameter
Returns
true if the parameter exists with the input name

Definition at line 289 of file SGObject.h.

bool has ( const Tag< T > &  tag) const
inherited

Checks if object has a class parameter identified by a Tag.

Parameters
tagtag of the parameter containing name and type information
Returns
true if the parameter exists with the input tag

Definition at line 301 of file SGObject.h.

bool has ( const std::string &  name) const
inherited

Checks if a type exists for a class parameter identified by a name.

Parameters
namename of the parameter
Returns
true if the parameter exists with the input name and type

Definition at line 312 of file SGObject.h.

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 329 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
filewhere to load from
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 402 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 459 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 454 of file SGObject.cpp.

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

Definition at line 295 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 507 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 341 of file SGObject.cpp.

void register_param ( Tag< T > &  _tag,
const T &  value 
)
protectedinherited

Registers a class parameter which is identified by a tag. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters
_tagname and type information of parameter
valuevalue of the parameter

Definition at line 439 of file SGObject.h.

void register_param ( const std::string &  name,
const T &  value 
)
protectedinherited

Registers a class parameter which is identified by a name. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 452 of file SGObject.h.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "" 
)
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
Returns
TRUE if done, otherwise FALSE

Definition at line 347 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 469 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 464 of file SGObject.cpp.

void set ( const Tag< T > &  _tag,
const T &  value 
)
inherited

Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
_tagname and type information of parameter
valuevalue of the parameter

Definition at line 328 of file SGObject.h.

void set ( const std::string &  name,
const T &  value 
)
inherited

Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 354 of file SGObject.h.

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 ( )
inherited

Definition at line 74 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 79 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 84 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 89 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 94 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 99 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 104 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 109 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 114 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 119 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 124 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 129 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 134 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 139 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 144 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
ioio object to use

Definition at line 261 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 274 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 316 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 225 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 336 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 281 of file SGObject.cpp.

Member Data Documentation

SGIO* io
inherited

io

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

uint32_t m_hash
inherited

Hash of parameter values

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

Parameter* m_parameters
inherited

parameters

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

Version* version
inherited

version

Definition at line 543 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation