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
CPlifMatrix Class Reference

Detailed Description

store plif arrays for all transitions in the model

Definition at line 31 of file PlifMatrix.h.

Inheritance diagram for CPlifMatrix:
[legend]

Public Member Functions

 CPlifMatrix ()
 
 ~CPlifMatrix ()
 
CPlif ** get_PEN ()
 
CPlifBase ** get_plif_matrix ()
 
int32_t get_num_states ()
 
CPlifBase ** get_state_signals ()
 
int32_t get_num_plifs ()
 
int32_t get_num_limits ()
 
void create_plifs (int32_t num_plifs, int32_t num_limits)
 
void set_plif_ids (SGVector< int32_t > ids)
 
void set_plif_min_values (SGVector< float64_t > min_values)
 
void set_plif_max_values (SGVector< float64_t > max_values)
 
void set_plif_use_cache (SGVector< bool > use_cache)
 
void set_plif_use_svm (SGVector< int32_t > use_svm)
 
void set_plif_limits (SGMatrix< float64_t > limits)
 
void set_plif_penalties (SGMatrix< float64_t > penalties)
 
void set_plif_names (SGString< char > *names, int32_t num_values, int32_t maxlen=0)
 
void set_plif_transform_type (SGString< char > *transform_type, int32_t num_values, int32_t maxlen=0)
 
int32_t get_plif_id (int32_t idx)
 
bool compute_plif_matrix (SGNDArray< float64_t > penalties_array)
 
bool compute_signal_plifs (SGMatrix< int32_t > state_signals)
 
void set_plif_state_signal_matrix (int32_t *plif_id_matrix, int32_t m, int32_t n)
 
virtual const char * get_name () 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

CPlif ** m_PEN
 
int32_t m_num_plifs
 
int32_t m_num_limits
 
int32_t m_num_states
 
int m_feat_dim3
 
CDynamicArray< int32_t > m_ids
 
CPlifBase ** m_plif_matrix
 
CPlifBase ** m_state_signals
 

Constructor & Destructor Documentation

constructor

Definition at line 8 of file PlifMatrix.cpp.

destructor

Definition at line 13 of file PlifMatrix.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.

bool compute_plif_matrix ( SGNDArray< float64_t penalties_array)

parse an 3D array of plif ids and compute the corresponding 2D plif matrix by subsuming the third dim into one PlifArray; Note: the class PlifArray is derived from PlifBase. It computes all individual plifs and sums them up.

Parameters
penalties_array3D array of plif ids (nofstates x nofstates x nof(features for each transition))
Returns
success

Definition at line 180 of file PlifMatrix.cpp.

bool compute_signal_plifs ( SGMatrix< int32_t >  state_signals)

parse an 3D array of plif ids and compute the corresponding 3D plif array;

Parameters
state_signalsmapping of features to states
Returns
success

Definition at line 243 of file PlifMatrix.cpp.

void create_plifs ( int32_t  num_plifs,
int32_t  num_limits 
)

create an empty plif matrix of size num_plifs * num_limits

Parameters
num_plifsnumber of plifs
num_limitsnumber of plif limits

Definition at line 27 of file PlifMatrix.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.

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
object name

Implements CSGObject.

Definition at line 192 of file PlifMatrix.h.

int32_t get_num_limits ( )

get number of support points for picewise linear transformations (PLiFs)

Returns
number of support points

Definition at line 80 of file PlifMatrix.h.

int32_t get_num_plifs ( )

get number of plifs

Returns
number of plifs

Definition at line 74 of file PlifMatrix.h.

int32_t get_num_states ( )

get number of states the number of states determines the size of the plif matrix

Returns
number of states

Definition at line 61 of file PlifMatrix.h.

CPlif** get_PEN ( )

get array of all plifs

Returns
plif array

Definition at line 48 of file PlifMatrix.h.

int32_t get_plif_id ( int32_t  idx)

return plif id for idx

Parameters
idxidx of plif
Returns
id of plif

Definition at line 156 of file PlifMatrix.h.

CPlifBase** get_plif_matrix ( )

get plif matrix

Returns
matrix of plifs

Definition at line 54 of file PlifMatrix.h.

CPlifBase** get_state_signals ( )

get plifs defining the mapping of signals to states

Returns
plifs

Definition at line 68 of file PlifMatrix.h.

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_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_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_plif_ids ( SGVector< int32_t >  ids)

set plif ids

Parameters
idsplif ids

Definition at line 41 of file PlifMatrix.cpp.

void set_plif_limits ( SGMatrix< float64_t limits)

set all abscissa values of the support points for the for the pice wise linear transformations (PLiFs)

Parameters
limitsarray of length num_plifs*num_limits

Definition at line 104 of file PlifMatrix.cpp.

void set_plif_max_values ( SGVector< float64_t max_values)

set array of max values for all plifs

Parameters
max_valuesarray of max values

Definition at line 68 of file PlifMatrix.cpp.

void set_plif_min_values ( SGVector< float64_t min_values)

set array of min values for all plifs

Parameters
min_valuesarray of min values

Definition at line 56 of file PlifMatrix.cpp.

void set_plif_names ( SGString< char > *  names,
int32_t  num_values,
int32_t  maxlen = 0 
)

set names for the PLiFs

Parameters
namesnames
num_valuesnumber of names
maxlenmaximal string len of the names

Definition at line 143 of file PlifMatrix.cpp.

void set_plif_penalties ( SGMatrix< float64_t penalties)

set all ordinate values of the support points for the for the pice wise linear transformations (PLiFs)

Parameters
penaltiesplif values: array of length num_plifs*num_limits

Definition at line 123 of file PlifMatrix.cpp.

void set_plif_state_signal_matrix ( int32_t *  plif_id_matrix,
int32_t  m,
int32_t  n 
)

set best path plif state signal matrix

Parameters
plif_id_matrixplif id matrix
mdimension m of matrix
ndimension n of matrix

Definition at line 270 of file PlifMatrix.cpp.

void set_plif_transform_type ( SGString< char > *  transform_type,
int32_t  num_values,
int32_t  maxlen = 0 
)

set plif transform type; for some features the plifs live in log space therefore the input values have to be transformed to log space before the transformation can be applied; the transform type is string coded

Parameters
transform_typetransform type (e.g. LOG(x), LOG(x+1), ...)
num_valuesnumber of transform strings
maxlenof transform strings

Definition at line 157 of file PlifMatrix.cpp.

void set_plif_use_cache ( SGVector< bool >  use_cache)

set plif use cache

Parameters
use_cacheset array of bool values

Definition at line 80 of file PlifMatrix.cpp.

void set_plif_use_svm ( SGVector< int32_t >  use_svm)

set plif use svm

Parameters
use_svmuse svm

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

int m_feat_dim3
protected

maximal number of features for a given state

Definition at line 209 of file PlifMatrix.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.

CDynamicArray<int32_t> m_ids
protected

plif ids

Definition at line 212 of file PlifMatrix.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 549 of file SGObject.h.

int32_t m_num_limits
protected

number of supporting points per plif

Definition at line 203 of file PlifMatrix.h.

int32_t m_num_plifs
protected

number of plifs

Definition at line 200 of file PlifMatrix.h.

int32_t m_num_states
protected

number of states in model

Definition at line 206 of file PlifMatrix.h.

Parameter* m_parameters
inherited

parameters

Definition at line 546 of file SGObject.h.

CPlif** m_PEN
protected

array of plifs

Definition at line 197 of file PlifMatrix.h.

CPlifBase** m_plif_matrix
protected

plif matrix

Definition at line 215 of file PlifMatrix.h.

CPlifBase** m_state_signals
protected

state signals

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