mlpack
Public Member Functions | List of all members
HMMModel Class Reference

A serializable HMM model that also stores the type. More...

Public Member Functions

 HMMModel (const HMMType type=HMMType::DiscreteHMM)
 Construct a model of the given type. More...

 
 HMMModel (const HMMModel &other)
 Copy another model. More...

 
 HMMModel (HMMModel &&other)
 Take ownership of another model. More...

 
 ~HMMModel ()
 Clean memory. More...

 
HMM< gmm::DiagonalGMM > * DiagGMMHMM ()
 
HMM< distribution::DiscreteDistribution > * DiscreteHMM ()
 Accessor methods for discreteHMM, gaussianHMM, gmmHMM, and diagGMMHMM. More...

 
HMM< distribution::GaussianDistribution > * GaussianHMM ()
 
HMM< gmm::GMM > * GMMHMM ()
 
HMMModel & operator= (const HMMModel &other)
 Copy assignment operator. More...

 
HMMModel & operator= (HMMModel &&other)
 Move assignment operator. More...

 
template
<
typename
ActionType
,
typename
ExtraInfoType
>
void PerformAction (util::Params &params, ExtraInfoType *x)
 Given a functor type, perform that functor with the optional extra info on the HMM. More...

 
template
<
typename
Archive
>
void serialize (Archive &ar, const uint32_t)
 Serialize the model. More...

 
HMMType Type ()
 

Detailed Description

A serializable HMM model that also stores the type.

Definition at line 34 of file hmm_model.hpp.

Constructor & Destructor Documentation

◆ HMMModel() [1/3]

HMMModel ( const HMMType  type = HMMType::DiscreteHMM)
inline

Construct a model of the given type.

Definition at line 50 of file hmm_model.hpp.

References mlpack::hmm::DiagonalGaussianMixtureModelHMM, mlpack::hmm::DiscreteHMM, mlpack::hmm::GaussianHMM, and mlpack::hmm::GaussianMixtureModelHMM.

◆ HMMModel() [2/3]

HMMModel ( const HMMModel &  other)
inline

Copy another model.

Definition at line 68 of file hmm_model.hpp.

References mlpack::hmm::DiagonalGaussianMixtureModelHMM, mlpack::hmm::DiscreteHMM, mlpack::hmm::GaussianHMM, and mlpack::hmm::GaussianMixtureModelHMM.

◆ HMMModel() [3/3]

HMMModel ( HMMModel &&  other)
inline

Take ownership of another model.

Definition at line 88 of file hmm_model.hpp.

References mlpack::hmm::DiscreteHMM.

◆ ~HMMModel()

~HMMModel ( )
inline

Clean memory.

Definition at line 154 of file hmm_model.hpp.

Member Function Documentation

◆ DiagGMMHMM()

HMM<gmm::DiagonalGMM>* DiagGMMHMM ( )
inline

Definition at line 235 of file hmm_model.hpp.

◆ DiscreteHMM()

HMM<distribution::DiscreteDistribution>* DiscreteHMM ( )
inline

Accessor methods for discreteHMM, gaussianHMM, gmmHMM, and diagGMMHMM.

Note that an instatiation of this class will only contain one type of HMM (as indicated by the "type" instance variable) - the other two pointers will be NULL.

For instance, if the HMMModel object holds a discrete HMM, then: type –> DiscreteHMM gaussianHMM –> NULL gmmHMM –> NULL diagGMMHMM –> NULL discreteHMM –> HMM<DiscreteDistribution> object and hence, calls to GMMHMM(), DiagGMMHMM() and GaussianHMM() will return NULL. Only the call to DiscreteHMM() will return a non NULL pointer.

Hence, in practice, a user should be careful to first check the type of HMM (by calling the Type() accessor) and then perform subsequent actions, to avoid null pointer dereferences.

Definition at line 232 of file hmm_model.hpp.

◆ GaussianHMM()

HMM<distribution::GaussianDistribution>* GaussianHMM ( )
inline

Definition at line 233 of file hmm_model.hpp.

◆ GMMHMM()

HMM<gmm::GMM>* GMMHMM ( )
inline

Definition at line 234 of file hmm_model.hpp.

◆ operator=() [1/2]

HMMModel& operator= ( const HMMModel &  other)
inline

Copy assignment operator.

Definition at line 103 of file hmm_model.hpp.

References mlpack::hmm::DiagonalGaussianMixtureModelHMM, mlpack::hmm::DiscreteHMM, mlpack::hmm::GaussianHMM, and mlpack::hmm::GaussianMixtureModelHMM.

◆ operator=() [2/2]

HMMModel& operator= ( HMMModel &&  other)
inline

Move assignment operator.

Definition at line 134 of file hmm_model.hpp.

References mlpack::hmm::DiscreteHMM.

◆ PerformAction()

void PerformAction ( util::Params &  params,
ExtraInfoType *  x 
)
inline

Given a functor type, perform that functor with the optional extra info on the HMM.

Definition at line 168 of file hmm_model.hpp.

References mlpack::hmm::DiagonalGaussianMixtureModelHMM, mlpack::hmm::DiscreteHMM, mlpack::hmm::GaussianHMM, and mlpack::hmm::GaussianMixtureModelHMM.

◆ serialize()

void serialize ( Archive &  ar,
const uint32_t   
)
inline

Serialize the model.

Definition at line 182 of file hmm_model.hpp.

References CEREAL_POINTER, mlpack::hmm::DiagonalGaussianMixtureModelHMM, mlpack::hmm::DiscreteHMM, mlpack::hmm::GaussianHMM, and mlpack::hmm::GaussianMixtureModelHMM.

◆ Type()

HMMType Type ( )
inline

Definition at line 211 of file hmm_model.hpp.

The documentation for this class was generated from the following file:
  • /home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/methods/hmm/hmm_model.hpp