public abstract class AbstractEvaluationMetric
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Class and Description |
---|---|
class |
AbstractEvaluationMetric.UnknownStatisticException
Exception for subclasses to throw if asked for a statistic that is not part
of their implementation
|
Constructor and Description |
---|
AbstractEvaluationMetric() |
Modifier and Type | Method and Description |
---|---|
abstract boolean |
appliesToNominalClass()
Return true if this evaluation metric can be computed when the class is
nominal
|
abstract boolean |
appliesToNumericClass()
Return true if this evaluation metric can be computed when the class is
numeric
|
abstract java.lang.String |
getMetricDescription()
Get a short description of this metric (algorithm, forumulas etc.).
|
abstract java.lang.String |
getMetricName()
Get the name of this metric
|
static java.util.ArrayList<AbstractEvaluationMetric> |
getPluginMetrics()
Gets a list of freshly instantiated concrete implementations of available
plugin metrics or null if there are no plugin metrics available
|
abstract double |
getStatistic(java.lang.String statName)
Get the value of the named statistic
|
abstract java.util.List<java.lang.String> |
getStatisticNames()
Get a list of the names of the statistics that this metrics computes.
|
void |
setBaseEvaluation(Evaluation eval)
Set the base evaluation object to use.
|
boolean |
statisticIsMaximisable(java.lang.String statName)
True if the optimum value of the named metric is a maximum value; false if
the optimim value is a minimum value.
|
public static java.util.ArrayList<AbstractEvaluationMetric> getPluginMetrics()
public void setBaseEvaluation(Evaluation eval)
eval
- public abstract boolean appliesToNominalClass()
public abstract boolean appliesToNumericClass()
public abstract java.lang.String getMetricName()
public abstract java.lang.String getMetricDescription()
public abstract java.util.List<java.lang.String> getStatisticNames()
public abstract double getStatistic(java.lang.String statName)
statName
- the name of the statistic to compute the value forpublic boolean statisticIsMaximisable(java.lang.String statName)