STK::MLMixtureCriterion Class Reference

Derived class of Criterion for computing the Maximum Likelihood Criterion This criterion does not penalize the model and return minux two times the log likelihood of the model. More...

#include <STK_MixtureCriterion.h>

Inheritance diagram for STK::MLMixtureCriterion:

Public Member Functions
	MLMixtureCriterion ()
	Default Constructor.
	MLMixtureCriterion (IMixtureStatModel *const p_composer)
	Constructor.
	MLMixtureCriterion (MLMixtureCriterion const &criterion)
	copy Constructor.
virtual	~MLMixtureCriterion ()
	virtual destructor.
MLMixtureCriterion *	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 Maximum Likelihood Criterion This criterion does not penalize the model and return minux two times the log likelihood of the model.

Definition at line 154 of file STK_MixtureCriterion.h.

Constructor & Destructor Documentation

MLMixtureCriterion() [1/3]

STK::MLMixtureCriterion::MLMixtureCriterion ( )

inline

Default Constructor.

Definition at line 158 of file STK_MixtureCriterion.h.

: IMixtureCriterion() {}

Referenced by clone().

MLMixtureCriterion() [2/3]

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

inline

Constructor.

Parameters

p_composer

apointer on the current model

Definition at line 162 of file STK_MixtureCriterion.h.

                              : IMixtureCriterion(p_composer) {}

MLMixtureCriterion() [3/3]

STK::MLMixtureCriterion::MLMixtureCriterion ( MLMixtureCriterion const &  criterion )

inline

copy Constructor.

Parameters

criterion

the criterion to copy

Definition at line 167 of file STK_MixtureCriterion.h.

                              : IMixtureCriterion(criterion) {}

~MLMixtureCriterion()

virtual STK::MLMixtureCriterion::~MLMixtureCriterion ( )

inlinevirtual

virtual destructor.

Definition at line 170 of file STK_MixtureCriterion.h.

{}

Member Function Documentation

clone()

MLMixtureCriterion * STK::MLMixtureCriterion::clone ( ) const

inline

clone pattern

Definition at line 172 of file STK_MixtureCriterion.h.

{ return new MLMixtureCriterion(*this);}

References MLMixtureCriterion().

run()

bool STK::MLMixtureCriterion::run ( )

virtual

implementation of the virtual method run

Implements STK::IRunnerBase.

Definition at line 74 of file STK_MixtureCriterion.cpp.

{
  if (!p_composer_)
  { msg_error_ = STKERROR_NO_ARG(MLMixtureCriterion::run,p_composer_ is not set);
    return false;
  }
  value_  = -2 * p_composer_->lnLikelihood();
  return true;
}

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

• STK_MixtureCriterion.h
• STK_MixtureCriterion.cpp