SHOGUN  4.1.0
 全部  命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义  
所有成员列表 | Public 成员函数 | 静态 Public 成员函数 | Public 属性 | Protected 成员函数 | Protected 属性
CLinearHMM类 参考

详细描述

The class LinearHMM is for learning Higher Order Markov chains.

While learning the parameters \({\bf \theta}\) in

\begin{eqnarray*} P({\bf x}|{\bf \theta}^\pm)&=&P(x_1, \ldots, x_N|{\bf \theta}^\pm)\\ &=&P(x_1,\ldots,x_{d}|{\bf \theta}^\pm)\prod_{i=d+1}^N P(x_i|x_{i-1},\ldots,x_{i-d},{\bf \theta}^\pm) \end{eqnarray*}

are determined.

A more detailed description can be found in

Durbin et.al, Biological Sequence Analysis -Probabilistic Models of Proteins and Nucleic Acids, 1998

在文件 LinearHMM.h41 行定义.

类 CLinearHMM 继承关系图:
Inheritance graph
[图例]

Public 成员函数

 CLinearHMM ()
 
 CLinearHMM (CStringFeatures< uint16_t > *f)
 
 CLinearHMM (int32_t p_num_features, int32_t p_num_symbols)
 
virtual ~CLinearHMM ()
 
virtual bool train (CFeatures *data=NULL)
 
bool train (const int32_t *indizes, int32_t num_indizes, float64_t pseudo_count)
 
float64_t get_log_likelihood_example (uint16_t *vector, int32_t len)
 
float64_t get_likelihood_example (uint16_t *vector, int32_t len)
 
float64_t get_likelihood_example (int32_t num_example)
 
virtual float64_t get_log_likelihood_example (int32_t num_example)
 
virtual float64_t get_log_derivative (int32_t num_param, int32_t num_example)
 
virtual float64_t get_log_derivative_obsolete (uint16_t obs, int32_t pos)
 
virtual float64_t get_derivative_obsolete (uint16_t *vector, int32_t len, int32_t pos)
 
virtual int32_t get_sequence_length ()
 
virtual int32_t get_num_symbols ()
 
virtual int32_t get_num_model_parameters ()
 
virtual float64_t get_positional_log_parameter (uint16_t obs, int32_t position)
 
virtual float64_t get_log_model_parameter (int32_t num_param)
 
virtual SGVector< float64_tget_log_transition_probs ()
 
virtual bool set_log_transition_probs (const SGVector< float64_t > probs)
 
virtual SGVector< float64_tget_transition_probs ()
 
virtual bool set_transition_probs (const SGVector< float64_t > probs)
 
virtual const char * get_name () const
 
virtual int32_t get_num_relevant_model_parameters ()
 
virtual float64_t get_log_likelihood_sample ()
 
virtual SGVector< float64_tget_log_likelihood ()
 
virtual float64_t get_model_parameter (int32_t num_param)
 
virtual float64_t get_derivative (int32_t num_param, int32_t num_example)
 
virtual SGVector< float64_tget_likelihood_for_all_examples ()
 
virtual void set_features (CFeatures *f)
 
virtual CFeaturesget_features ()
 
virtual void set_pseudo_count (float64_t pseudo)
 
virtual float64_t get_pseudo_count ()
 
virtual float64_t update_params_em (float64_t *alpha_k, int32_t len)
 
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)
 
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 成员函数

static CDistributionobtain_from_generic (CSGObject *object)
 

Public 属性

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
uint32_t m_hash
 

Protected 成员函数

virtual void load_serializable_post () throw (ShogunException)
 
virtual void load_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_post () throw (ShogunException)
 

Protected 属性

int32_t sequence_length
 
int32_t num_symbols
 
int32_t num_params
 
float64_ttransition_probs
 
float64_tlog_transition_probs
 
CFeaturesfeatures
 
float64_t pseudo_count
 

构造及析构函数说明

default constructor

在文件 LinearHMM.cpp22 行定义.

CLinearHMM ( CStringFeatures< uint16_t > *  f)

constructor

参数
ffeatures to use

在文件 LinearHMM.cpp27 行定义.

CLinearHMM ( int32_t  p_num_features,
int32_t  p_num_symbols 
)

constructor

参数
p_num_featuresnumber of features
p_num_symbolsnumber of symbols in features

在文件 LinearHMM.cpp38 行定义.

~CLinearHMM ( )
virtual

在文件 LinearHMM.cpp48 行定义.

成员函数说明

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.

参数
dictdictionary of parameters to be built.

在文件 SGObject.cpp597 行定义.

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.

返回
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

在文件 SGObject.cpp714 行定义.

CSGObject * deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

在文件 SGObject.cpp198 行定义.

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.

参数
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
返回
true if all parameters were equal, false if not

在文件 SGObject.cpp618 行定义.

virtual float64_t get_derivative ( int32_t  num_param,
int32_t  num_example 
)
virtualinherited

get partial derivative of likelihood function

参数
num_parampartial derivative against which param
num_examplewhich example
返回
derivative of likelihood function

在文件 Distribution.h134 行定义.

virtual float64_t get_derivative_obsolete ( uint16_t *  vector,
int32_t  len,
int32_t  pos 
)
virtual

obsolete get one example's derivative

参数
vectorvector
lenlength
posposition

在文件 LinearHMM.h140 行定义.

virtual CFeatures* get_features ( )
virtualinherited

get feature vectors

返回
feature vectors

在文件 Distribution.h171 行定义.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp235 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp277 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp290 行定义.

float64_t get_likelihood_example ( uint16_t *  vector,
int32_t  len 
)

get one example's likelihood

参数
vectorthe example
lenlength of vector
返回
likelihood

在文件 LinearHMM.cpp210 行定义.

float64_t get_likelihood_example ( int32_t  num_example)
virtual

compute likelihood for example

参数
num_examplewhich example
返回
likelihood for example

重载 CDistribution .

在文件 LinearHMM.cpp220 行定义.

SGVector< float64_t > get_likelihood_for_all_examples ( )
virtualinherited

compute likelihood for all vectors in sample

返回
likelihood vector for all examples

在文件 Distribution.cpp65 行定义.

float64_t get_log_derivative ( int32_t  num_param,
int32_t  num_example 
)
virtual

get logarithm of one example's derivative's likelihood

参数
num_paramwhich example's param
num_examplewhich example
返回
logarithm of example's derivative

实现了 CDistribution.

在文件 LinearHMM.cpp235 行定义.

virtual float64_t get_log_derivative_obsolete ( uint16_t  obs,
int32_t  pos 
)
virtual

obsolete get logarithm of one example's derivative's likelihood

参数
obsobservation
posposition

在文件 LinearHMM.h128 行定义.

SGVector< float64_t > get_log_likelihood ( )
virtualinherited

compute log likelihood for each example

返回
log likelihood vector

在文件 Distribution.cpp39 行定义.

float64_t get_log_likelihood_example ( uint16_t *  vector,
int32_t  len 
)

get logarithm of one example's likelihood

参数
vectorthe example
lenlength of vector
返回
logarithm of likelihood

在文件 LinearHMM.cpp186 行定义.

float64_t get_log_likelihood_example ( int32_t  num_example)
virtual

get logarithm of one example's likelihood

参数
num_examplewhich example
返回
logarithm of example's likelihood

实现了 CDistribution.

在文件 LinearHMM.cpp196 行定义.

float64_t get_log_likelihood_sample ( )
virtualinherited

compute log likelihood for whole sample

返回
log likelihood for whole sample

在文件 Distribution.cpp28 行定义.

virtual float64_t get_log_model_parameter ( int32_t  num_param)
virtual

get logarithm of given model parameter

参数
num_paramwhich param
返回
logarithm of given model parameter

实现了 CDistribution.

在文件 LinearHMM.h182 行定义.

SGVector< float64_t > get_log_transition_probs ( )
virtual

get logarithm of all transition probs

返回
logarithm of transition probs vector

在文件 LinearHMM.cpp278 行定义.

virtual float64_t get_model_parameter ( int32_t  num_param)
virtualinherited

get model parameter

参数
num_paramwhich param
返回
model parameter

在文件 Distribution.h123 行定义.

SGStringList< char > get_modelsel_names ( )
inherited
返回
vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp498 行定义.

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数
param_namename of the parameter
返回
description of the parameter

在文件 SGObject.cpp522 行定义.

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

参数
param_namename of model selection parameter
返回
index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp535 行定义.

virtual const char* get_name ( ) const
virtual
返回
object name

实现了 CSGObject.

在文件 LinearHMM.h217 行定义.

virtual int32_t get_num_model_parameters ( )
virtual

get number of model parameters

返回
number of model parameters

实现了 CDistribution.

在文件 LinearHMM.h163 行定义.

int32_t get_num_relevant_model_parameters ( )
virtualinherited

get number of parameters in model that are relevant, i.e. > ALMOST_NEG_INFTY

返回
number of relevant model parameters

在文件 Distribution.cpp52 行定义.

virtual int32_t get_num_symbols ( )
virtual

get number of symbols in examples

返回
number of symbols in examples

在文件 LinearHMM.h157 行定义.

virtual float64_t get_positional_log_parameter ( uint16_t  obs,
int32_t  position 
)
virtual

get positional log parameter

参数
obsobservation
positionposition
返回
positional log parameter

在文件 LinearHMM.h171 行定义.

virtual float64_t get_pseudo_count ( )
virtualinherited

get pseudo count

返回
pseudo count

在文件 Distribution.h187 行定义.

virtual int32_t get_sequence_length ( )
virtual

get sequence length of each example

返回
sequence length of each example

在文件 LinearHMM.h151 行定义.

SGVector< float64_t > get_transition_probs ( )
virtual

get all transition probs

返回
vector of transition probs

在文件 LinearHMM.cpp254 行定义.

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.

参数
genericset to the type of the generic if returning TRUE
返回
TRUE if a class template.

在文件 SGObject.cpp296 行定义.

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!

参数
filewhere to load from
prefixprefix for members
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp369 行定义.

void load_serializable_post ( )
throw (ShogunException
)
protectedvirtual

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.

异常
ShogunExceptionwill be thrown if an error occurs.

重载 CSGObject .

在文件 LinearHMM.cpp302 行定义.

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.

异常
ShogunExceptionwill be thrown if an error occurs.

CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp421 行定义.

CDistribution * obtain_from_generic ( CSGObject object)
staticinherited

obtain from generic

参数
objectgeneric object
返回
Distribution object

在文件 Distribution.cpp85 行定义.

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

在文件 SGObject.cpp262 行定义.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp474 行定义.

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

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp308 行定义.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "" 
)
virtualinherited

Save this object to file.

参数
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp314 行定义.

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.

异常
ShogunExceptionwill be thrown if an error occurs.

CKernel 重载.

在文件 SGObject.cpp436 行定义.

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.

异常
ShogunExceptionwill be thrown if an error occurs.

CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp431 行定义.

virtual void set_features ( CFeatures f)
virtualinherited

set feature vectors

参数
fnew feature vectors

在文件 Distribution.h160 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp41 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp46 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp51 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp56 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp61 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp66 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp71 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp76 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp81 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp86 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp91 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp96 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp101 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp106 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp111 行定义.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO io)
inherited

set the io object

参数
ioio object to use

在文件 SGObject.cpp228 行定义.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp241 行定义.

void set_global_version ( Version version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp283 行定义.

bool set_log_transition_probs ( const SGVector< float64_t probs)
virtual

set logarithm of all transition probs

参数
probsnew logarithm transition probs
返回
if setting was successful

在文件 LinearHMM.cpp283 行定义.

virtual void set_pseudo_count ( float64_t  pseudo)
virtualinherited

set pseudo count

参数
pseudonew pseudo count

在文件 Distribution.h181 行定义.

bool set_transition_probs ( const SGVector< float64_t probs)
virtual

set all transition probs

参数
probsnew transition probs
返回
if setting was successful

在文件 LinearHMM.cpp259 行定义.

CSGObject * shallow_copy ( ) const
virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

CGaussianKernel 重载.

在文件 SGObject.cpp192 行定义.

bool train ( CFeatures data = NULL)
virtual

estimate LinearHMM distribution

参数
datatraining data (parameter can be avoided if distance or kernel-based classifiers are used and distance/kernels are initialized with train data)
返回
whether training was successful

实现了 CDistribution.

在文件 LinearHMM.cpp54 行定义.

bool train ( const int32_t *  indizes,
int32_t  num_indizes,
float64_t  pseudo_count 
)

alternative train distribution

参数
indizesindices
num_indizesnumber of indices
pseudo_countpseudo count
返回
if training was successful

在文件 LinearHMM.cpp123 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp303 行定义.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp248 行定义.

float64_t update_params_em ( float64_t alpha_k,
int32_t  len 
)
virtualinherited

update parameters in the em maximization step for mixture model of which this distribution is a part

abstract base method

参数
alpha_k"belongingness" values of various data points
lenlength of alpha_k array
返回
sum of alpha_k values

CGaussian 重载.

在文件 Distribution.cpp78 行定义.

类成员变量说明

CFeatures* features
protectedinherited

feature vectors

在文件 Distribution.h209 行定义.

SGIO* io
inherited

io

在文件 SGObject.h369 行定义.

float64_t* log_transition_probs
protected

logarithm of transition probs

在文件 LinearHMM.h235 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h384 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h387 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h381 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h378 行定义.

int32_t num_params
protected

number of parameters

在文件 LinearHMM.h231 行定义.

int32_t num_symbols
protected

number of symbols in examples

在文件 LinearHMM.h229 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h372 行定义.

float64_t pseudo_count
protectedinherited

pseudo count

在文件 Distribution.h211 行定义.

int32_t sequence_length
protected

examples' sequence length

在文件 LinearHMM.h227 行定义.

float64_t* transition_probs
protected

transition probs

在文件 LinearHMM.h233 行定义.

Version* version
inherited

version

在文件 SGObject.h375 行定义.


该类的文档由以下文件生成:

SHOGUN 机器学习工具包 - 项目文档