IFigureOfMerit Class Reference

Abstract class representing a figure of merit. More...

#include <IFigureOfMerit.h>

Inheritance diagram for IFigureOfMerit:

Public Member Functions
	IFigureOfMerit ()
virtual	~IFigureOfMerit ()
virtual double	evaluate (IModel *model) const =0
	Evaluate the fittness of a model. More...
virtual bool	accept (IModel *model) const
virtual bool	isBetterThan (IModel *scoreToTest, IModel *referenceModel) const
void	setAcceptThreshold (double acceptThreshold)
double	getAcceptThreshold () const

Protected Member Functions
virtual bool	accept (double scrore) const
virtual bool	isBetterThan (double scoreToTest, double referenceScore) const

Protected Attributes
double	m_acceptThreshold
	Stores the score threshold to accept a model as a final answer.

Detailed Description

Abstract class representing a figure of merit.

A figure of merit should implement three functionalities:

• Evaluate the fittness of a model. The details of that evaluation is kept for the derive classes.
• Decide whether a model is good enough to be accepted as the final answer to a problem. The default behaviour is to apply a threshold on the score.
• Compares two models and decide which is the fittest. The default behaviour is that a larger score is better.

Deriving from this class:

• Derived classes should at least implement the evaluate() method if the score handling behavior is adequate.
• In addition, derived classes may reimplement accept() and/or isBetterThan() versions that take scores as input to modify the handling of the scores, e.g. a lower score is may be better.
• For more complex cases where the decisions are not taken solely on the score, the derived class may reimplement the overloaded versions of accept() and isBetterThan() that take a IModel as input. In this case, the fuction evaluate() may simply return a dummy value.

Definition at line 25 of file IFigureOfMerit.h.

Constructor & Destructor Documentation

IFigureOfMerit()

IFigureOfMerit::IFigureOfMerit

(

)

Default Constructor

Definition at line 5 of file IFigureOfMerit.cxx.

~IFigureOfMerit()

IFigureOfMerit::~IFigureOfMerit ( )

virtual

Destructor

Definition at line 10 of file IFigureOfMerit.cxx.

Member Function Documentation

evaluate()

virtual double IFigureOfMerit::evaluate ( IModel *  model ) const

pure virtual

Evaluate the fittness of a model.

Derived classes should implement this method.

Implemented in Chi2FitFigureOfMerit.

accept() [1/2]

bool IFigureOfMerit::accept ( IModel *  model ) const

virtual

Decide if a model can be accepted as a final answer.

This is an overloaded function. The default behavior is to apply a threshold on the score.

Derived classes can override this method if the decision is not based solely on the score.

Parameters

model

The model to be tested.

Returns

true if the model can be accepted.

Definition at line 36 of file IFigureOfMerit.cxx.

isBetterThan() [1/2]

bool IFigureOfMerit::isBetterThan ( IModel *  modelToTest, IModel *  referenceModel  ) const

virtual

Compares two Models

This is an overloaded function. The default behavior is: higher score is better.

Derived classes can override this method if the comparison is not based solely on the score.

Parameters

modelToTest	The model to be tested.
referenceModel	The model to compare to.

Returns

true if modelToTest is better than referenceModel, false otherwise.

Definition at line 65 of file IFigureOfMerit.cxx.

setAcceptThreshold()

void IFigureOfMerit::setAcceptThreshold

(

double

threshold

)

Sets the score threshold to accept a model as a final answer.

Parameters

threshold

score threshold to accept a model as a final answer.

Definition at line 73 of file IFigureOfMerit.cxx.

getAcceptThreshold()

double IFigureOfMerit::getAcceptThreshold

(

)

const

Returns the score threshold to accept a model as a final answer.

Returns

the score threshold to accept a model as a final answer.

Definition at line 81 of file IFigureOfMerit.cxx.

accept() [2/2]

bool IFigureOfMerit::accept ( double  score ) const

protectedvirtual

Decide if a model's score can be accepted as a final answer.

The default behavior is to apply a threshold on the score.

Derived classes can override this method if the default behaviour is not adequate.

Parameters

score

The score of the model to be tested.

Returns

true if the score can be accepted.

Definition at line 22 of file IFigureOfMerit.cxx.

isBetterThan() [2/2]

bool IFigureOfMerit::isBetterThan ( double  scoreToTest, double  referenceScore  ) const

protectedvirtual

Compares two scores

The default behavior is: higher score is better.

Derived classes can override this method if the default behaviour is not adequate.

Parameters

scoreToTest	The score of the model to be tested.
referenceScore	The score of the model to compare to.

Returns

true if scoreToTest is better than referenceScore, false otherwise.

Reimplemented in Chi2FitFigureOfMerit.

Definition at line 50 of file IFigureOfMerit.cxx.

---

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

• include/IFigureOfMerit.h
• src/IFigureOfMerit.cxx