STK::ICriterion Class Reference

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

#include <STK_PenCriterion.h>

Inheritance diagram for STK::ICriterion:

Public Member Functions
virtual	~ICriterion ()
	Destructor.
Real const &	value () const
void	setModel (IStatModelBase const *p_model)
void	setModel (IStatModelBase const &model)
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
	ICriterion ()
	Default Constructor.
	ICriterion (IStatModelBase const *p_model)
	Constructor.
	ICriterion (IStatModelBase const &model)
	Constructor.
	ICriterion (ICriterion 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
IStatModelBase const *	p_model_
	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 50 of file STK_PenCriterion.h.

Constructor & Destructor Documentation

ICriterion() [1/4]

STK::ICriterion::ICriterion ( )

inlineprotected

Default Constructor.

Definition at line 54 of file STK_PenCriterion.h.

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

ICriterion() [2/4]

STK::ICriterion::ICriterion ( IStatModelBase const *  p_model )

inlineprotected

Constructor.

Parameters

p_model

a pointer on the current model

Definition at line 58 of file STK_PenCriterion.h.

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

ICriterion() [3/4]

STK::ICriterion::ICriterion ( IStatModelBase const &  model )

inlineprotected

Constructor.

Parameters

model

the current model

Definition at line 63 of file STK_PenCriterion.h.

                     : p_model_(&model), value_(Arithmetic<Real>::NA()) {}

ICriterion() [4/4]

STK::ICriterion::ICriterion ( ICriterion const &  criterion )

inlineprotected

copy Constructor.

Parameters

criterion

the criterion to copy

Definition at line 68 of file STK_PenCriterion.h.

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

~ICriterion()

virtual STK::ICriterion::~ICriterion ( )

inlinevirtual

Destructor.

Definition at line 73 of file STK_PenCriterion.h.

{}

Member Function Documentation

setModel() [1/2]

void STK::ICriterion::setModel ( IStatModelBase const &  model )

inline

Parameters

model

the current model to set

Definition at line 79 of file STK_PenCriterion.h.

{ p_model_ = &model;}

References p_model_.

setModel() [2/2]

void STK::ICriterion::setModel ( IStatModelBase const *  p_model )

inline

Parameters

p_model

a pointer on the current model to set

Definition at line 77 of file STK_PenCriterion.h.

{ p_model_ = p_model;}

References p_model_.

value()

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

inline

Returns

The value of the criterion

Definition at line 75 of file STK_PenCriterion.h.

{ return value_;}

References value_.

Member Data Documentation

p_model_

IStatModelBase const* STK::ICriterion::p_model_

protected

The current statistical model to use.

Definition at line 83 of file STK_PenCriterion.h.

Referenced by STK::AICCriterion::run(), STK::BICCriterion::run(), setModel(), and setModel().

value_

Real STK::ICriterion::value_

protected

Computed value of the criterion.

Definition at line 85 of file STK_PenCriterion.h.

Referenced by STK::AICCriterion::run(), STK::BICCriterion::run(), and value().

---

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

• STK_PenCriterion.h