STK::IMixtureAlgoLearn Class Reference

Interface base class for the learning algorithms. More...

#include <STK_IMixtureAlgoLearn.h>

Inheritance diagram for STK::IMixtureAlgoLearn:

Public Member Functions
virtual	~IMixtureAlgoLearn ()
	destructor
int	nbIterMax () const
int	epsilon () const
void	setModel (IMixtureLearner *p_model)
	set model
void	setNbIterMax (int nbIterMax)
	set maximal number of iterations
void	setEpsilon (Real epsilon)
	set tolerance value
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
	IMixtureAlgoLearn ()
	default constructor
	IMixtureAlgoLearn (IMixtureAlgoLearn const &algo)
	Copy constructor.
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
IMixtureLearner *	p_model_
	pointer on the mixture model
int	nbIterMax_
	maximal number of iterations of the algorithm
Real	epsilon_
	tolerance of the algorithm.
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 the learning algorithms.

All algorithms are runners applying on a model instance given by pointer and have to implement the run method.

Definition at line 51 of file STK_IMixtureAlgoLearn.h.

Constructor & Destructor Documentation

IMixtureAlgoLearn() [1/2]

STK::IMixtureAlgoLearn::IMixtureAlgoLearn ( )

protected

default constructor

Definition at line 45 of file STK_IMixtureAlgoLearn.cpp.

: IRunnerBase(), p_model_(0), nbIterMax_(0), epsilon_(0.) {}

IMixtureAlgoLearn() [2/2]

STK::IMixtureAlgoLearn::IMixtureAlgoLearn ( IMixtureAlgoLearn const &  algo )

protected

Copy constructor.

Parameters

algo	the algorithm to copy

Definition at line 48 of file STK_IMixtureAlgoLearn.cpp.

                        : IRunnerBase(algo)
                        , p_model_(algo.p_model_)
                        , nbIterMax_(algo.nbIterMax_)
                        , epsilon_(algo.epsilon_)
{}

~IMixtureAlgoLearn()

STK::IMixtureAlgoLearn::~IMixtureAlgoLearn ( )

virtual

destructor

Definition at line 56 of file STK_IMixtureAlgoLearn.cpp.

{}

Member Function Documentation

epsilon()

int STK::IMixtureAlgoLearn::epsilon ( ) const

inline

Returns

the epsilon of the algorithm

Definition at line 68 of file STK_IMixtureAlgoLearn.h.

{ return epsilon_;}

References epsilon_.

Referenced by setEpsilon().

nbIterMax()

int STK::IMixtureAlgoLearn::nbIterMax ( ) const

inline

Returns

the maximal number of iteration of the algorithm

Definition at line 66 of file STK_IMixtureAlgoLearn.h.

{ return nbIterMax_; }

References nbIterMax_.

Referenced by setNbIterMax().

setEpsilon()

void STK::IMixtureAlgoLearn::setEpsilon ( Real  epsilon )

inline

set tolerance value

Definition at line 76 of file STK_IMixtureAlgoLearn.h.

{ epsilon_ = epsilon; }

References epsilon(), and epsilon_.

setModel()

void STK::IMixtureAlgoLearn::setModel

(

IMixtureLearner *

p_model

)

set model

Definition at line 58 of file STK_IMixtureAlgoLearn.cpp.

{ p_model_ = p_model; }

References p_model_.

Referenced by STK::LearnFacade::createImputeAlgo(), and STK::LearnFacade::createSimulAlgo().

setNbIterMax()

void STK::IMixtureAlgoLearn::setNbIterMax ( int  nbIterMax )

inline

set maximal number of iterations

Definition at line 74 of file STK_IMixtureAlgoLearn.h.

{ nbIterMax_ = nbIterMax; }

References nbIterMax(), and nbIterMax_.

Member Data Documentation

epsilon_

Real STK::IMixtureAlgoLearn::epsilon_

protected

tolerance of the algorithm.

Definition at line 84 of file STK_IMixtureAlgoLearn.h.

Referenced by epsilon(), STK::ImputeAlgo::run(), and setEpsilon().

nbIterMax_

int STK::IMixtureAlgoLearn::nbIterMax_

protected

maximal number of iterations of the algorithm

Definition at line 82 of file STK_IMixtureAlgoLearn.h.

Referenced by nbIterMax(), STK::ImputeAlgo::run(), STK::SimulAlgo::run(), and setNbIterMax().

p_model_

IMixtureLearner* STK::IMixtureAlgoLearn::p_model_

protected

pointer on the mixture model

Definition at line 80 of file STK_IMixtureAlgoLearn.h.

Referenced by STK::ImputeAlgo::run(), STK::SimulAlgo::run(), and setModel().

---

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

• STK_IMixtureAlgoLearn.h
• STK_IMixtureAlgoLearn.cpp