STK::IMixtureStrategy Class Reference

Interface base class for all the strategies. More...

#include <STK_IMixtureStrategy.h>

Inheritance diagram for STK::IMixtureStrategy:

Public Member Functions
	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.
virtual bool	run ()=0
	run the computations.

Protected Member Functions
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.

Protected Attributes
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

Detailed Description

Interface base class for all the strategies.

Definition at line 49 of file STK_IMixtureStrategy.h.

Constructor & Destructor Documentation

IMixtureStrategy() [1/2]

STK::IMixtureStrategy::IMixtureStrategy

(

IMixtureComposer *&

p_model

)

default constructor.

Parameters

p_model

the model to estimate

Definition at line 45 of file STK_IMixtureStrategy.cpp.

                                  : IRunnerBase(), nbTry_(1), p_model_(p_model), p_init_(0)
{}

IMixtureStrategy() [2/2]

STK::IMixtureStrategy::IMixtureStrategy

(

IMixtureStrategy const &

strategy

)

copy constructor

Parameters

strategy

the strategy to copy

Definition at line 51 of file STK_IMixtureStrategy.cpp.

                                  : IRunnerBase(strategy), nbTry_(strategy.nbTry_)
                                  , p_model_(strategy.p_model_)
                                  , p_init_(strategy.p_init_->clone())
{}

~IMixtureStrategy()

STK::IMixtureStrategy::~IMixtureStrategy ( )

virtual

destructor

Definition at line 66 of file STK_IMixtureStrategy.cpp.

{ if (p_init_) delete p_init_;}

References p_init_.

Member Function Documentation

nbTry()

int STK::IMixtureStrategy::nbTry ( ) const

inline

Returns

get number of tries of strategy

Definition at line 64 of file STK_IMixtureStrategy.h.

{ return nbTry_;}

References nbTry_.

Referenced by setNbTry().

setMixtureInit()

void STK::IMixtureStrategy::setMixtureInit ( IMixtureInit *  p_init )

inline

set the initialization method to use

Parameters

p_init

the initialization method to use

Definition at line 71 of file STK_IMixtureStrategy.h.

{ p_init_ = p_init;}

References p_init_.

setNbTry()

void STK::IMixtureStrategy::setNbTry ( int  nbTry )

inline

set the number of tries of each strategies.

Parameters

nbTry

the number of tries to set

Definition at line 68 of file STK_IMixtureStrategy.h.

{ nbTry_ = nbTry;}

References nbTry(), and nbTry_.

storeModel()

void STK::IMixtureStrategy::storeModel ( IMixtureComposer *&  p_otherModel )

protected

store a model in p_model_ if it is better.

Parameters

p_otherModel

the model to store

Definition at line 60 of file STK_IMixtureStrategy.cpp.

{ if (p_model_->lnLikelihood()<p_otherModel->lnLikelihood())
  { std::swap(p_model_, p_otherModel);}
}

References STK::IStatModelBase::lnLikelihood(), and p_model_.

Referenced by STK::SimpleStrategy::run(), and STK::XemStrategy::run().

Member Data Documentation

nbTry_

int STK::IMixtureStrategy::nbTry_

protected

number of tries of each strategies (1 by default)

Definition at line 75 of file STK_IMixtureStrategy.h.

Referenced by nbTry(), STK::FullStrategy::run(), STK::SimpleStrategy::run(), STK::XemStrategy::run(), and setNbTry().

p_init_

IMixtureInit* STK::IMixtureStrategy::p_init_

protected

initialization method

Definition at line 79 of file STK_IMixtureStrategy.h.

Referenced by STK::FullStrategy::initStep(), STK::SimpleStrategy::run(), STK::XemStrategy::run(), setMixtureInit(), and ~IMixtureStrategy().

p_model_

IMixtureComposer*& STK::IMixtureStrategy::p_model_

protected

reference on the main model

Definition at line 77 of file STK_IMixtureStrategy.h.

Referenced by STK::FullStrategy::initStep(), STK::FullStrategy::run(), STK::SimpleStrategy::run(), STK::XemStrategy::run(), and storeModel().

---

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

• STK_IMixtureStrategy.h
• STK_IMixtureStrategy.cpp