facade design pattern. More...

#include <STK_MixtureFacade.h>

Inheritance diagram for STK::LearnFacade:

Public Member Functions
	LearnFacade (IMixtureLearner *p_model)
	constructor.

virtual	~LearnFacade ()
	destructor.

void	setModel (IMixtureLearner *p_model)
	set model in case we want to use the strategy again

void	createImputeAlgo (Clust::algoLearnType algo, int nbIter, Real epsilon)
	create an imputation algorithm

void	createSimulAlgo (Clust::algoLearnType algo, int nblongIter)
	create a simulation algorithm

virtual bool	run ()
	run algorithm

Public Member Functions inherited from STK::IRunnerBase
String const &	error () const
	get the last error message.

Protected Attributes
IMixtureLearner *	p_model_
	the mixture model to learn

IMixtureAlgoLearn *	p_algo_
	the algorithm to use for learning

Protected Attributes inherited from STK::IRunnerBase
String	msg_error_
	String with the last error message.

bool	hasRun_
	`true` if run has been used, `false` otherwise

Additional Inherited Members
Protected Member Functions inherited from STK::IRunnerBase
	IRunnerBase ()
	default constructor

	IRunnerBase (IRunnerBase const &runner)
	copy constructor

virtual	~IRunnerBase ()
	destructor

virtual void	update ()
	update the runner.

Detailed Description

facade design pattern.

LearnFacade allows to create the algorithms for learning a mixture model with less effort

Definition at line 95 of file STK_MixtureFacade.h.

Constructor & Destructor Documentation

◆ LearnFacade()

STK::LearnFacade::LearnFacade ( IMixtureLearner * p_model )

inline

constructor.

Parameters

p_model a reference on the current model

Definition at line 101 of file STK_MixtureFacade.h.

102 : IRunnerBase(), p_model_(p_model), p_algo_(0)

103 {}

STK::IRunnerBase::IRunnerBase

IRunnerBase()

default constructor

Definition STK_IRunner.h:68

STK::LearnFacade::p_model_

IMixtureLearner * p_model_

the mixture model to learn

Definition STK_MixtureFacade.h:119

STK::LearnFacade::p_algo_

IMixtureAlgoLearn * p_algo_

the algorithm to use for learning

Definition STK_MixtureFacade.h:121

◆ ~LearnFacade()

STK::LearnFacade::~LearnFacade ( )

virtual

destructor.

Definition at line 103 of file STK_MixtureFacade.cpp.

103{ if (p_algo_) delete p_algo_;}

References p_algo_.

Member Function Documentation

◆ createImputeAlgo()

void STK::LearnFacade::createImputeAlgo	(	Clust::algoLearnType	algo,
		int	nbIter,
		Real	epsilon
	)

create an imputation algorithm

Definition at line 105 of file STK_MixtureFacade.cpp.

{
  p_algo_ = Clust::createLearnAlgo(algo, nbIter, epsilon);
  p_algo_->setModel(p_model_);
}

References STK::Clust::createLearnAlgo(), p_algo_, p_model_, and STK::IMixtureAlgoLearn::setModel().

◆ createSimulAlgo()

void STK::LearnFacade::createSimulAlgo	(	Clust::algoLearnType	algo,
		int	nblongIter
	)

create a simulation algorithm

Definition at line 112 of file STK_MixtureFacade.cpp.

{
  p_algo_ = Clust::createLearnAlgo(algo, nbIter, 0.);
  p_algo_->setModel(p_model_);
}

References STK::Clust::createLearnAlgo(), p_algo_, p_model_, and STK::IMixtureAlgoLearn::setModel().

◆ run()

bool STK::LearnFacade::run ( )

virtual

run algorithm

Implements STK::IRunnerBase.

Definition at line 118 of file STK_MixtureFacade.cpp.

{
#ifdef STK_MIXTURE_VERBOSE
  stk_cout << _T("------------------------------\n")
           << _T("Entering LearnFacade::run()   \n");
#endif
  // initialize model
  p_model_->initializeStep();
  // start algorithm
  bool flag = false;
  if (p_algo_)
  {
    if (p_algo_->run()) { flag = true;}
    else
    {
      msg_error_ += STKERROR_NO_ARG(StrategyFacade::run,strategy failed\n);
      msg_error_ += p_algo_->error();
#ifdef STK_MIXTURE_VERBOSE
      stk_cout << _T("LearnFacade:run() terminated without success.   \n")
               << msg_error_ << _T("\n")
               << _T("------------------------------------------------\n");
#endif
    }
    // finalize any
    p_model_->finalizeStep();
  }
  else
  {
    msg_error_ = STKERROR_NO_ARG(MixtureFacade::run(),algo is not created);
  }
#ifdef STK_MIXTURE_VERBOSE
  stk_cout << _T("StrategyFacade:run() terminated.\n")
           << _T("p_model->lnLikelihood() =") << p_model_->lnLikelihood() << _T("\n")
           << _T("--------------------------------\n");
#endif
  return flag;
}

References _T, STK::IRunnerBase::error(), STK::IMixtureStatModel::finalizeStep(), STK::IMixtureStatModel::initializeStep(), STK::IStatModelBase::lnLikelihood(), STK::IRunnerBase::msg_error_, p_algo_, p_model_, STK::StrategyFacade::run(), STK::IRunnerBase::run(), stk_cout, and STKERROR_NO_ARG.

◆ setModel()

void STK::LearnFacade::setModel ( IMixtureLearner * p_model )

inline

set model in case we want to use the strategy again

Parameters

p_model the model to set

Definition at line 109 of file STK_MixtureFacade.h.

109{p_model_ = p_model;};

References p_model_.

Member Data Documentation

◆ p_algo_

IMixtureAlgoLearn* STK::LearnFacade::p_algo_

protected

the algorithm to use for learning

Definition at line 121 of file STK_MixtureFacade.h.

Referenced by createImputeAlgo(), createSimulAlgo(), run(), and ~LearnFacade().

◆ p_model_

IMixtureLearner* STK::LearnFacade::p_model_