STK::IMixtureCriterion Class Reference

Interface base class for the selection model criterion. More...

#include <STK_IMixtureCriterion.h>

Inheritance diagram for STK::IMixtureCriterion:

Public Member Functions
virtual	~IMixtureCriterion ()
	Destructor.
Real const &	value () const
void	setModel (IMixtureStatModel const *p_composer)
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
	IMixtureCriterion ()
	Default Constructor.
	IMixtureCriterion (IMixtureStatModel const *p_composer)
	Constructor.
	IMixtureCriterion (IMixtureCriterion const &criterion)
	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
IMixtureStatModel const *	p_composer_
	The current statistical model to use.
Real	value_
	Computed value of the criterion.
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 selection model criterion.

The pure virtual function run will be implemented in derived class and compute the value_ member.

Definition at line 52 of file STK_IMixtureCriterion.h.

Constructor & Destructor Documentation

IMixtureCriterion() [1/3]

STK::IMixtureCriterion::IMixtureCriterion ( )

inlineprotected

Default Constructor.

Definition at line 56 of file STK_IMixtureCriterion.h.

: p_composer_(), value_(Arithmetic<Real>::NA()) {}

IMixtureCriterion() [2/3]

STK::IMixtureCriterion::IMixtureCriterion ( IMixtureStatModel const *  p_composer )

inlineprotected

Constructor.

Parameters

p_composer

a pointer on the current model

Definition at line 60 of file STK_IMixtureCriterion.h.

                            : p_composer_(p_composer), value_(Arithmetic<Real>::NA()){}

IMixtureCriterion() [3/3]

STK::IMixtureCriterion::IMixtureCriterion ( IMixtureCriterion const &  criterion )

inlineprotected

copy Constructor.

Parameters

criterion

the criterion to copy

Definition at line 65 of file STK_IMixtureCriterion.h.

                            : p_composer_(criterion.p_composer_)
                            , value_(criterion.value_) {}

~IMixtureCriterion()

virtual STK::IMixtureCriterion::~IMixtureCriterion ( )

inlinevirtual

Destructor.

Definition at line 70 of file STK_IMixtureCriterion.h.

{}

Member Function Documentation

setModel()

void STK::IMixtureCriterion::setModel ( IMixtureStatModel const *  p_composer )

inline

Parameters

p_composer

a pointer on the current model to set

Definition at line 74 of file STK_IMixtureCriterion.h.

    { p_composer_ = p_composer;}

References p_composer_.

value()

Real const & STK::IMixtureCriterion::value ( ) const

inline

Returns

The value of the criterion

Definition at line 72 of file STK_IMixtureCriterion.h.

{ return value_;}

References value_.

Member Data Documentation

p_composer_

IMixtureStatModel const* STK::IMixtureCriterion::p_composer_

protected

The current statistical model to use.

Definition at line 79 of file STK_IMixtureCriterion.h.

Referenced by STK::AICMixtureCriterion::run(), STK::BICMixtureCriterion::run(), STK::ICLMixtureCriterion::run(), STK::MLMixtureCriterion::run(), and setModel().

value_

Real STK::IMixtureCriterion::value_

protected

Computed value of the criterion.

Definition at line 81 of file STK_IMixtureCriterion.h.

Referenced by STK::AICMixtureCriterion::run(), STK::BICMixtureCriterion::run(), STK::ICLMixtureCriterion::run(), STK::MLMixtureCriterion::run(), and value().

---

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

• STK_IMixtureCriterion.h