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

#include <STK_MixtureCriterion.h>

Inheritance diagram for STK::BICMixtureCriterion:

Public Member Functions
	BICMixtureCriterion ()
	Default Constructor.

	BICMixtureCriterion (IMixtureStatModel *const p_composer)
	Constructor.

	BICMixtureCriterion (BICMixtureCriterion const &criterion)
	copy Constructor.

virtual	~BICMixtureCriterion ()
	virtual destructor.

BICMixtureCriterion *	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 BIC Criterion The Bic criteria of a model M is a penalization of the likelihood given by the formula.

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

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

Definition at line 90 of file STK_MixtureCriterion.h.

Constructor & Destructor Documentation

◆ BICMixtureCriterion() [1/3]

STK::BICMixtureCriterion::BICMixtureCriterion ( )

inline

Default Constructor.

Definition at line 94 of file STK_MixtureCriterion.h.

94: IMixtureCriterion() {}

STK::IMixtureCriterion::IMixtureCriterion

IMixtureCriterion()

Default Constructor.

Definition STK_IMixtureCriterion.h:56

Referenced by clone().

◆ BICMixtureCriterion() [2/3]

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

inline

Constructor.

Parameters

p_composer apointer on the current model

Definition at line 98 of file STK_MixtureCriterion.h.

99 : IMixtureCriterion(p_composer) {}

◆ BICMixtureCriterion() [3/3]

STK::BICMixtureCriterion::BICMixtureCriterion ( BICMixtureCriterion const & criterion )

inline

copy Constructor.

Parameters

criterion the criterion to copy

Definition at line 103 of file STK_MixtureCriterion.h.

104 : IMixtureCriterion(criterion) {}

◆ ~BICMixtureCriterion()

virtual STK::BICMixtureCriterion::~BICMixtureCriterion ( )

inlinevirtual

virtual destructor.

Definition at line 106 of file STK_MixtureCriterion.h.

106{}

Member Function Documentation

◆ clone()

BICMixtureCriterion * STK::BICMixtureCriterion::clone ( ) const

inline

clone pattern

Definition at line 108 of file STK_MixtureCriterion.h.

108{ return new BICMixtureCriterion(*this);}

STK::BICMixtureCriterion::BICMixtureCriterion

BICMixtureCriterion()

Default Constructor.

Definition STK_MixtureCriterion.h:94

References BICMixtureCriterion().

◆ run()

bool STK::BICMixtureCriterion::run ( )

virtual

implementation of the virtual method run

Implements STK::IRunnerBase.

Definition at line 52 of file STK_MixtureCriterion.cpp.

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

References STK::IStatModelBase::computeBIC(), 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

◆ BICMixtureCriterion() [1/3]

◆ BICMixtureCriterion() [2/3]

◆ BICMixtureCriterion() [3/3]

◆ ~BICMixtureCriterion()

Member Function Documentation

◆ clone()

◆ run()