Derived class of Criterion for computing the AIC Criterion The AIC criteria of a given model M is a penalization of the likelihood given by the formula. More...

#include <STK_MixtureCriterion.h>

Inheritance diagram for STK::AICMixtureCriterion:

Public Member Functions
	AICMixtureCriterion ()
	Default Constructor.

	AICMixtureCriterion (IMixtureStatModel *const p_composer)
	Constructor.

	AICMixtureCriterion (AICMixtureCriterion const &criterion)
	copy Constructor.

virtual	~AICMixtureCriterion ()
	virtual destructor.

AICMixtureCriterion *	clone () const
	clone pattern

virtual bool	run ()
	implementation of the virtual method run

Public Member Functions inherited from STK::IMixtureCriterion
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.

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

Derived class of Criterion for computing the AIC Criterion The AIC criteria of a given model M is a penalization of the likelihood given by the formula.

$-2 \cdot \ln{p(x|M)} \approx \mathrm{AIC} = {-2 \cdot \ln{L} +2 D }$

where $ L $ represents the likelihood of the observations and $ D $ the number of free parameter of the model.

Definition at line 56 of file STK_MixtureCriterion.h.

Constructor & Destructor Documentation

◆ AICMixtureCriterion() [1/3]

STK::AICMixtureCriterion::AICMixtureCriterion ( )

inline

Default Constructor.

Definition at line 60 of file STK_MixtureCriterion.h.

60: IMixtureCriterion() {}

STK::IMixtureCriterion::IMixtureCriterion

IMixtureCriterion()

Default Constructor.

Definition STK_IMixtureCriterion.h:56

Referenced by clone().

◆ AICMixtureCriterion() [2/3]

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

inline

Constructor.

Parameters

p_composer apointer on the current model

Definition at line 64 of file STK_MixtureCriterion.h.

65 : IMixtureCriterion(p_composer) {}

◆ AICMixtureCriterion() [3/3]

STK::AICMixtureCriterion::AICMixtureCriterion ( AICMixtureCriterion const & criterion )

inline

copy Constructor.

Parameters

criterion the criterion to copy

Definition at line 69 of file STK_MixtureCriterion.h.

70 : IMixtureCriterion(criterion) {}

◆ ~AICMixtureCriterion()

virtual STK::AICMixtureCriterion::~AICMixtureCriterion ( )

inlinevirtual

virtual destructor.

Definition at line 72 of file STK_MixtureCriterion.h.

72{}

Member Function Documentation

◆ clone()

AICMixtureCriterion * STK::AICMixtureCriterion::clone ( ) const

inline

clone pattern

Definition at line 74 of file STK_MixtureCriterion.h.

74{ return new AICMixtureCriterion(*this);}

STK::AICMixtureCriterion::AICMixtureCriterion

AICMixtureCriterion()

Default Constructor.

Definition STK_MixtureCriterion.h:60

References AICMixtureCriterion().

◆ run()

bool STK::AICMixtureCriterion::run ( )

virtual

implementation of the virtual method run

Implements STK::IRunnerBase.

Definition at line 41 of file STK_MixtureCriterion.cpp.

{
  if (!p_composer_)
  { msg_error_ = STKERROR_NO_ARG(AICMixtureCriterion::run,p_composer_ is not set);
    return false;
  }
  value_  = p_composer_->computeAIC();
  return true;
}

References STK::IStatModelBase::computeAIC(), STK::IRunnerBase::msg_error_, STK::IMixtureCriterion::p_composer_, run(), STKERROR_NO_ARG, and STK::IMixtureCriterion::value_.

Referenced by run().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AICMixtureCriterion() [1/3]

◆ AICMixtureCriterion() [2/3]

◆ AICMixtureCriterion() [3/3]

◆ ~AICMixtureCriterion()

Member Function Documentation

◆ clone()

◆ run()