STK::BICCriterion Class Reference

Derived class of Criterion for computing the BIC Criterion The Bic criteria is a penalization of the likelihood given by the formula. More...

#include <STK_PenCriterion.h>

Inheritance diagram for STK::BICCriterion:

Public Member Functions
	BICCriterion ()
	Default Constructor.
	BICCriterion (IStatModelBase *const p_model)
	Constructor.
	BICCriterion (IStatModelBase const &model)
	Constructor.
	BICCriterion (BICCriterion const &criterion)
	copy Constructor.
virtual	~BICCriterion ()
	virtual destructor.
BICCriterion *	clone () const
	clone pattern
virtual bool	run ()
	implementation of the virtual method run
Public Member Functions inherited from STK::ICriterion
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.

Additional Inherited Members
Protected Member Functions inherited from STK::ICriterion
	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 inherited from STK::ICriterion
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

Derived class of Criterion for computing the BIC Criterion The Bic criteria is a penalization of the likelihood given by the formula.

where represents the likelihood of the observations, the number of free parameter of the model and the number of sample.

Definition at line 142 of file STK_PenCriterion.h.

Constructor & Destructor Documentation

BICCriterion() [1/4]

STK::BICCriterion::BICCriterion ( )

inline

Default Constructor.

Definition at line 146 of file STK_PenCriterion.h.

: ICriterion() {}

Referenced by clone().

BICCriterion() [2/4]

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

inline

Constructor.

Parameters

p_model

apointer on the current model

Definition at line 150 of file STK_PenCriterion.h.

: ICriterion(p_model) {}

BICCriterion() [3/4]

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

inline

Constructor.

Parameters

model

the current model

Definition at line 154 of file STK_PenCriterion.h.

: ICriterion(model) {}

BICCriterion() [4/4]

STK::BICCriterion::BICCriterion ( BICCriterion const &  criterion )

inline

copy Constructor.

Parameters

criterion

the criterion to copy

Definition at line 158 of file STK_PenCriterion.h.

: ICriterion(criterion) {}

~BICCriterion()

virtual STK::BICCriterion::~BICCriterion ( )

inlinevirtual

virtual destructor.

Definition at line 160 of file STK_PenCriterion.h.

{}

Member Function Documentation

clone()

BICCriterion * STK::BICCriterion::clone ( ) const

inline

clone pattern

Definition at line 162 of file STK_PenCriterion.h.

{ return new BICCriterion(*this);}

References BICCriterion().

run()

bool STK::BICCriterion::run ( )

inlinevirtual

implementation of the virtual method run

Implements STK::IRunnerBase.

Definition at line 168 of file STK_PenCriterion.h.

{
  if (!p_model_)
  { msg_error_ = STKERROR_NO_ARG(BICCriterion::run,p_model_ is not set);
    return false;
  }
  value_  = p_model_->computeBIC();
  return true;
}

References STK::IStatModelBase::computeBIC(), STK::IRunnerBase::msg_error_, STK::ICriterion::p_model_, run(), STKERROR_NO_ARG, and STK::ICriterion::value_.

Referenced by run().

---

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

• STK_PenCriterion.h