File heuristic_f_measure.hpp

namespace seco

class IFMeasureConfig

#include <heuristic_f_measure.hpp>

Defines an interface for all classes that allow to configure a heuristic that calculates as the (weighted) harmonic mean between the heuristics “Precision” and “Recall”, where the parameter “beta” allows to trade off between both heuristics. If beta = 1, both heuristics are weighed equally. If beta = 0, this heuristic is equivalent to “Precision”. As beta approaches infinity, this heuristic becomes equivalent to “Recall”.

Subclassed by seco::FMeasureConfig

Public Functions

inline virtual ~IFMeasureConfig()

virtual float64 getBeta() const = 0

Returns the value of the “beta” parameter.

Returns:

The value of the “beta” parameter

virtual IFMeasureConfig &setBeta(float64 beta) = 0

Sets the value of the “beta” parameter

Parameters:

beta – The value of the “beta” parameter. Must be at least 0

Returns:

A reference to an object of type IFMeasureConfig that allows further configuration of the heuristic

class FMeasureConfig : public seco::IHeuristicConfig, public seco::IFMeasureConfig

#include <heuristic_f_measure.hpp>

Allows to configure a heuristic that calculates as the (weighted) harmonic mean between the heuristics “Precision” and “Recall”, where the parameter “beta” allows to trade off between both heuristics. If beta = 1, both heuristics are weighed equally. If beta = 0, this heuristic is equivalent to “Precision”. As beta approaches infinity, this heuristic becomes equivalent to “Recall”.

Public Functions

FMeasureConfig()

virtual float64 getBeta() const override

Returns the value of the “beta” parameter.

Returns:

The value of the “beta” parameter

virtual IFMeasureConfig &setBeta(float64 beta) override

Sets the value of the “beta” parameter

Parameters:

beta – The value of the “beta” parameter. Must be at least 0

Returns:

A reference to an object of type IFMeasureConfig that allows further configuration of the heuristic

virtual std::unique_ptr<IHeuristicFactory> createHeuristicFactory() const override

Creates and returns a new object of type IHeuristicFactory according to the specified configuration.

Returns:

An unique pointer to an object of type IHeuristicFactory that has been created

Private Members

float64 beta_