STK::SimpleStrategy Class Reference

A SimpleStrategy is just nbTry long run. More...

#include <STK_MixtureStrategy.h>

Inheritance diagram for STK::SimpleStrategy:

Public Member Functions
	SimpleStrategy (IMixtureComposer *&p_model)
	default constructor.
	SimpleStrategy (SimpleStrategy const &strategy)
	copy constructor.
virtual	~SimpleStrategy ()
	destructor
virtual SimpleStrategy *	clone () const
	clone pattern
void	setParam (SimpleStrategyParam *p_param)
	set the parameters of the strategy
virtual bool	run ()
	run the strategy
	SimpleStrategy (IMixtureComposer *&p_model)
	default constructor.
	SimpleStrategy (SimpleStrategy const &strategy)
	copy constructor.
virtual	~SimpleStrategy ()
	destructor
virtual SimpleStrategy *	clone () const
	clone pattern
void	setParam (SimpleStrategyParam *p_param)
	set the parameters of the strategy
virtual bool	run ()
	run the strategy
Public Member Functions inherited from STK::IMixtureStrategy
	IMixtureStrategy (IMixtureComposer *&p_model)
	default constructor.
	IMixtureStrategy (IMixtureStrategy const &strategy)
	copy constructor
virtual	~IMixtureStrategy ()
	destructor
int	nbTry () const
void	setNbTry (int nbTry)
	set the number of tries of each strategies.
void	setMixtureInit (IMixtureInit *p_init)
	set the initialization method to use
Public Member Functions inherited from STK::IRunnerBase
String const &	error () const
	get the last error message.

Protected Attributes
SimpleStrategyParam *	p_param_
Protected Attributes inherited from STK::IMixtureStrategy
int	nbTry_
	number of tries of each strategies (1 by default)
IMixtureComposer *&	p_model_
	reference on the main model
IMixtureInit *	p_init_
	initialization method
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::IMixtureStrategy
void	storeModel (IMixtureComposer *&p_otherModel)
	store a model in p_model_ if it is better.
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

A SimpleStrategy is just nbTry long run.

Definition at line 64 of file STK_MixtureStrategy.h.

Constructor & Destructor Documentation

SimpleStrategy() [1/4]

STK::SimpleStrategy::SimpleStrategy ( IMixtureComposer *&  p_model )

inline

default constructor.

Parameters

p_model

a reference pointer on the model to estimate

Definition at line 70 of file STK_MixtureStrategy.h.

                                                      : IMixtureStrategy(p_model), p_param_(0)
    {}

SimpleStrategy() [2/4]

STK::SimpleStrategy::SimpleStrategy ( SimpleStrategy const &  strategy )

inline

copy constructor.

Parameters

strategy

the strategy to copy

Definition at line 75 of file STK_MixtureStrategy.h.

                                                          : IMixtureStrategy(strategy), p_param_(0)
    {}

~SimpleStrategy() [1/2]

virtual STK::SimpleStrategy::~SimpleStrategy ( )

inlinevirtual

destructor

Definition at line 79 of file STK_MixtureStrategy.h.

{ if (p_param_) delete p_param_;}

References p_param_.

SimpleStrategy() [3/4]

STK::SimpleStrategy::SimpleStrategy ( IMixtureComposer *&  p_model )

inline

default constructor.

Parameters

p_model

a reference pointer on the model to estimate

Definition at line 69 of file STK_SimpleStrategy.h.

                                                      : IMixtureStrategy(p_model), p_param_(0)
    {}

SimpleStrategy() [4/4]

STK::SimpleStrategy::SimpleStrategy ( SimpleStrategy const &  strategy )

inline

copy constructor.

Parameters

strategy

the strategy to copy

Definition at line 74 of file STK_SimpleStrategy.h.

                                                          : IMixtureStrategy(strategy), p_param_(0)
    {}

~SimpleStrategy() [2/2]

virtual STK::SimpleStrategy::~SimpleStrategy ( )

inlinevirtual

destructor

Definition at line 78 of file STK_SimpleStrategy.h.

{ if (p_param_) delete p_param_;}

References p_param_.

Member Function Documentation

clone() [1/2]

virtual SimpleStrategy * STK::SimpleStrategy::clone ( ) const

inlinevirtual

clone pattern

Definition at line 81 of file STK_MixtureStrategy.h.

{ return new SimpleStrategy(*this);}

clone() [2/2]

virtual SimpleStrategy * STK::SimpleStrategy::clone ( ) const

inlinevirtual

clone pattern

Definition at line 80 of file STK_SimpleStrategy.h.

{ return new SimpleStrategy(*this);}

run() [1/2]

bool STK::SimpleStrategy::run ( )

virtual

run the strategy

Implements STK::IRunnerBase.

Definition at line 50 of file STK_SimpleStrategy.cpp.

{
#ifdef STK_MIXTURE_VERBOSE
  stk_cout << _T("-----------------------------------------------\n");
  stk_cout << _T("Entering SimpleStrategy::run() with: ")
           << _T("nbTry_ = ") << nbTry_ << _T("\n");
#endif
  IMixtureComposer* p_currentModel = 0;
  if (p_model_->state() < 1) { p_model_->randomFuzzyInit();}
  Real value = p_model_->lnLikelihood();
  try
  {
    p_currentModel = p_model_->create();
 
    // initialize and run algo. break if success
    for (int iTry = 0; iTry < nbTry_; ++iTry)
    {
      // initialize current model
      p_init_->setModel(p_currentModel);
      if (!p_init_->run())
      {
#ifdef STK_MIXTURE_VERBOSE
        stk_cout << "SimpleStrategy::run(), Initialization failed.\n";
#endif
        msg_error_ += STKERROR_NO_ARG(SimpleStrategy::run,Initialization failed\n);
        msg_error_ += p_init_->error();
      } // init step
      p_param_->p_algo_->setModel(p_currentModel);
      // initial
      if (!p_param_->p_algo_->run())
      {
#ifdef STK_MIXTURE_VERBOSE
        stk_cout << "SimpleStrategy::run(), Long run failed.\n";
#endif
        msg_error_ += STKERROR_NO_ARG(SimpleStrategy::run,long run failed\n);
        msg_error_ += p_param_->p_algo_->error();
      }
      else { break;}  // we get a result
    } // iTry
  }
  catch (Exception const& e)
  {
    msg_error_ = e.error();
    return false;
  }
  storeModel(p_currentModel);
  delete p_currentModel;
#ifdef STK_MIXTURE_VERBOSE
  stk_cout << "SimpleStrategy::run() terminated.              \n";
  stk_cout << "-----------------------------------------------\n";
#endif
  if (p_model_->lnLikelihood() <= value)
  {
    msg_error_ += STKERROR_NO_ARG(SimpleStrategy::run,No gain\n);
    return false;
  }
  return true;
}

References _T, STK::IMixtureComposer::create(), STK::IRunnerBase::error(), STK::IStatModelBase::lnLikelihood(), STK::IRunnerBase::msg_error_, STK::IMixtureStrategy::nbTry_, STK::SimpleStrategyParam::p_algo_, STK::IMixtureStrategy::p_init_, STK::IMixtureStrategy::p_model_, p_param_, STK::IMixtureComposer::randomFuzzyInit(), run(), STK::IRunnerBase::run(), STK::IMixtureAlgo::setModel(), STK::IMixtureInit::setModel(), STK::IMixtureComposer::state(), stk_cout, STKERROR_NO_ARG, and STK::IMixtureStrategy::storeModel().

Referenced by run().

run() [2/2]

virtual bool STK::SimpleStrategy::run ( )

virtual

run the strategy

Implements STK::IRunnerBase.

setParam() [1/2]

void STK::SimpleStrategy::setParam ( SimpleStrategyParam *  p_param )

inline

set the parameters of the strategy

Parameters

p_param

the parameters of the strategy

Definition at line 84 of file STK_MixtureStrategy.h.

{ p_param_ = p_param;}

References p_param_.

setParam() [2/2]

void STK::SimpleStrategy::setParam ( SimpleStrategyParam *  p_param )

inline

set the parameters of the strategy

Parameters

p_param

the parameters of the strategy

Definition at line 83 of file STK_SimpleStrategy.h.

{ p_param_ = p_param;}

References p_param_.

Member Data Documentation

p_param_

SimpleStrategyParam * STK::SimpleStrategy::p_param_

protected

Definition at line 90 of file STK_MixtureStrategy.h.

Referenced by run(), setParam(), and ~SimpleStrategy().

---

The documentation for this class was generated from the following files:

• STK_MixtureStrategy.h
• STK_SimpleStrategy.h
• STK_SimpleStrategy.cpp