STK++ 1.0
Public Member Functions | Protected Member Functions | Protected Attributes
STK::ICriterion Class Reference
Statistical Models

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

#include <STK_ICriterion.h>

Inheritance diagram for STK::ICriterion:
Inheritance graph
[legend]
Collaboration diagram for STK::ICriterion:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~ICriterion ()
 Destructor.
Real const & value () const
 get the value of the criterion
IModel const & model () const
 get the value of the criterion
void setModel (IModel const &model)
 set the current model.

Protected Member Functions

 ICriterion (IModel const &model)
 Constructor.

Protected Attributes

IModel const * p_model_
 The current statistical model to use.
Real value_
 Computed value of the criterion.

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 49 of file STK_ICriterion.h.

Constructor & Destructor Documentation

STK::ICriterion::ICriterion ( IModel const &  model) [protected]

Constructor.

Parameters:
modelthe current model

Definition at line 42 of file STK_ICriterion.cpp.

                      : p_model_(&model)
                      , value_(Arithmetic<Real>::NA())
{}
STK::ICriterion::~ICriterion ( ) [virtual]

Destructor.

Definition at line 48 of file STK_ICriterion.cpp.

{}

Member Function Documentation

Real const& STK::ICriterion::value ( ) const [inline]

get the value of the criterion

Returns:
The value of the criterion

Definition at line 65 of file STK_ICriterion.h.

References value_.

{ return value_;}
IModel const& STK::ICriterion::model ( ) const [inline]

get the value of the criterion

Returns:
The value of the criterion

Definition at line 70 of file STK_ICriterion.h.

References p_model_.

Referenced by setModel().

{ return *p_model_;}
void STK::ICriterion::setModel ( IModel const &  model) [inline]

set the current model.

Parameters:
modelthe current model

Definition at line 75 of file STK_ICriterion.h.

References model(), and p_model_.

     { p_model_ = &model;}

Here is the call graph for this function:

Member Data Documentation

IModel const* STK::ICriterion::p_model_ [protected]

The current statistical model to use.

Definition at line 80 of file STK_ICriterion.h.

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

Real STK::ICriterion::value_ [protected]

Computed value of the criterion.

Definition at line 82 of file STK_ICriterion.h.

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

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