SHOGUN  4.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CTableFactorType Class Reference

Detailed Description

Class CTableFactorType the way that store assignments of variables and energies in a table or a multi-array.

Definition at line 122 of file FactorType.h.

Inheritance diagram for CTableFactorType:
[legend]

Public Member Functions

 CTableFactorType ()
 
 CTableFactorType (int32_t id, SGVector< int32_t > card, SGVector< float64_t > w)
 
virtual ~CTableFactorType ()
 
virtual const char * get_name () const
 
virtual bool is_table () const
 
int32_t state_from_index (int32_t ei, int32_t var_index) const
 
SGVector< int32_t > assignment_from_index (int32_t ei) const
 
int32_t index_from_new_state (int32_t old_ei, int32_t var_index, int32_t var_state) const
 
int32_t index_from_assignment (const SGVector< int32_t > assig) const
 
int32_t index_from_universe_assignment (const SGVector< int32_t > assig, const SGVector< int32_t > var_index) const
 
virtual void compute_energies (const SGVector< float64_t > factor_data, SGVector< float64_t > &energies) const
 
virtual void compute_energies (const SGSparseVector< float64_t > factor_data_sparse, SGVector< float64_t > &energies) const
 
virtual void compute_gradients (const SGVector< float64_t > factor_data, const SGVector< float64_t > marginals, SGVector< float64_t > &parameter_gradient, double mult) const
 
virtual void compute_gradients (const SGSparseVector< float64_t > factor_data_sparse, const SGVector< float64_t > marginals, SGVector< float64_t > &parameter_gradient, double mult) const
 
virtual int32_t get_type_id () const
 
virtual void set_type_id (int32_t id)
 
virtual SGVector< float64_tget_w ()
 
virtual const SGVector< float64_tget_w () const
 
void set_w (SGVector< float64_t > w)
 
virtual int32_t get_w_dim () const
 
virtual const SGVector< int32_t > get_cardinalities () const
 
virtual void set_cardinalities (SGVector< int32_t > cards)
 
virtual int32_t get_num_vars ()
 
virtual int32_t get_num_assignments () 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

void init_card ()
 
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

int32_t m_type_id
 
SGVector< int32_t > m_cards
 
SGVector< int32_t > m_cumprod_cards
 
int32_t m_num_assignments
 
int32_t m_data_size
 
SGVector< float64_tm_w
 

Constructor & Destructor Documentation

default constructor

Definition at line 138 of file FactorType.cpp.

CTableFactorType ( int32_t  id,
SGVector< int32_t >  card,
SGVector< float64_t w 
)

constructor

Parameters
idused for query in FactorGraphModel
cardcardinalities of variables in the clique
wfactor parameters

Definition at line 143 of file FactorType.cpp.

~CTableFactorType ( )
virtual

deconstructor

Definition at line 151 of file FactorType.cpp.

Member Function Documentation

SGVector< int32_t > assignment_from_index ( int32_t  ei) const

get variable assignment from absolute energy index

Parameters
eienergy index
Returns
variable assignment

Definition at line 161 of file FactorType.cpp.

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 ( const SGVector< float64_t factor_data,
SGVector< float64_t > &  energies 
) const
virtual

compute energy values from parameters for a specific factor.

Parameters
factor_datadense factor data vector
energiesforwarded energy table

Definition at line 206 of file FactorType.cpp.

void compute_energies ( const SGSparseVector< float64_t factor_data_sparse,
SGVector< float64_t > &  energies 
) const
virtual

Compute energy values from parameters for a specific factor.

Parameters
factor_data_sparsesparse factor data
energiesforwarded energy table

Definition at line 238 of file FactorType.cpp.

void compute_gradients ( const SGVector< float64_t factor_data,
const SGVector< float64_t marginals,
SGVector< float64_t > &  parameter_gradient,
double  mult 
) const
virtual

compute parameter gradient from marginals and factor data

Parameters
factor_datadense factor data
marginalsmarginal distribution of the factor
parameter_gradientgradient of factor parameters
multmultiplier

Definition at line 276 of file FactorType.cpp.

void compute_gradients ( const SGSparseVector< float64_t factor_data_sparse,
const SGVector< float64_t marginals,
SGVector< float64_t > &  parameter_gradient,
double  mult 
) const
virtual

compute parameter gradient from marginals and factor data

Parameters
factor_data_sparsesparse factor data
marginalsmarginal distribution of the factor
parameter_gradientgradient of factor parameters
multmultiplier

Definition at line 309 of file FactorType.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.

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
virtualinherited
Returns
cardinalities of the variables

Definition at line 97 of file FactorType.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

Reimplemented from CFactorType.

Definition at line 140 of file FactorType.h.

int32_t get_num_assignments ( ) const
virtualinherited
Returns
number of configurations of variables

Definition at line 122 of file FactorType.cpp.

int32_t get_num_vars ( )
virtualinherited

get number of variables

Definition at line 117 of file FactorType.cpp.

int32_t get_type_id ( ) const
virtualinherited
Returns
get factor type id

Definition at line 67 of file FactorType.cpp.

SGVector< float64_t > get_w ( )
virtualinherited
Returns
get factor parameters

Definition at line 77 of file FactorType.cpp.

const SGVector< float64_t > get_w ( ) const
virtualinherited
Returns
get factor parameters

Definition at line 82 of file FactorType.cpp.

int32_t get_w_dim ( ) const
virtualinherited
Returns
dimension of the factor parameter vector

Definition at line 92 of file FactorType.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.

int32_t index_from_assignment ( const SGVector< int32_t >  assig) const

energy index from a given assignment

Parameters
assigvariable assignments
Returns
energy index

Definition at line 170 of file FactorType.cpp.

int32_t index_from_new_state ( int32_t  old_ei,
int32_t  var_index,
int32_t  var_state 
) const

update energy index by substituting with contribution from new state of a particular variable

Parameters
old_eiold energy index.
var_indexthe variable index of this factor:
var_statenew variable state
Returns
new energy index

Definition at line 180 of file FactorType.cpp.

int32_t index_from_universe_assignment ( const SGVector< int32_t >  assig,
const SGVector< int32_t >  var_index 
) const

energy index in the table of a factor given an universe assignment

Parameters
assigvariable assignments
var_indexvariable indices of that particular factor
Returns
energy index

Definition at line 190 of file FactorType.cpp.

void init_card ( )
protectedinherited

initialize m_num_assignments and m_cumprod_cards

Definition at line 127 of file FactorType.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.

virtual bool is_table ( ) const
virtual
Returns
this is the table implementation but memory inefficient

Reimplemented from CFactorType.

Definition at line 143 of file FactorType.h.

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_cardinalities ( SGVector< int32_t >  cards)
virtualinherited

set cardinalities

Parameters
cardscardinalities of variables

Definition at line 102 of file FactorType.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_type_id ( int32_t  id)
virtualinherited

set factor type id

Parameters
idtype id in CFactorGraphModel

Definition at line 72 of file FactorType.cpp.

void set_w ( SGVector< float64_t w)
inherited

set parameters

Parameters
wfactor parameters

Definition at line 87 of file FactorType.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.

int32_t state_from_index ( int32_t  ei,
int32_t  var_index 
) const

infer variable state from a given index of energy table

Parameters
eithe energy index.
var_indexthe variable index of this factor:
Returns
variable state

Definition at line 155 of file FactorType.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<int32_t> m_cards
protectedinherited

variable cardinalities

Definition at line 104 of file FactorType.h.

SGVector<int32_t> m_cumprod_cards
protectedinherited

the cumulative product of cardinalities

Definition at line 107 of file FactorType.h.

int32_t m_data_size
protectedinherited

data size

Definition at line 113 of file FactorType.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.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 549 of file SGObject.h.

int32_t m_num_assignments
protectedinherited

number of state assignments (for each variable)

Definition at line 110 of file FactorType.h.

Parameter* m_parameters
inherited

parameters

Definition at line 546 of file SGObject.h.

int32_t m_type_id
protectedinherited

factor type identifier

Definition at line 101 of file FactorType.h.

SGVector<float64_t> m_w
protectedinherited

factor paramters

Definition at line 116 of file FactorType.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