|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweka.classifiers.timeseries.eval.TSEvalModule
public abstract class TSEvalModule
Constructor Summary | |
---|---|
TSEvalModule()
|
Method Summary | |
---|---|
abstract double[] |
calculateMeasure()
Calculate the measure that this module represents. |
abstract void |
evaluateForInstance(java.util.List<NumericPrediction> forecasts,
Instance inst)
Evaluate the given forecast(s) with respect to the given test instance. |
abstract java.lang.String |
getDefinition()
Return the mathematical formula that this evaluation module computes. |
abstract java.lang.String |
getDescription()
Return the longer (single sentence) description of this evaluation module |
abstract java.lang.String |
getEvalName()
Return the short identifying name of this evaluation module |
static TSEvalModule |
getModule(java.lang.String moduleName)
Factory method for obtaining a named evaluation module. |
static java.util.List<TSEvalModule> |
getModuleList()
|
java.util.List<java.lang.String> |
getTargetFields()
Get the list of target field names. |
abstract void |
reset()
Reset the module |
void |
setTargetFields(java.util.List<java.lang.String> targets)
Set a list of target field names. |
abstract java.lang.String |
toSummaryString()
Return the summary description of the computed measure for each target. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TSEvalModule()
Method Detail |
---|
public static java.util.List<TSEvalModule> getModuleList()
public static TSEvalModule getModule(java.lang.String moduleName) throws java.lang.IllegalArgumentException
moduleName
- the name of the module to obtain
java.lang.IllegalArgumentException
- if the supplied module
name is unknownpublic abstract void reset()
public abstract java.lang.String getEvalName()
public abstract java.lang.String getDescription()
public abstract java.lang.String getDefinition()
public abstract void evaluateForInstance(java.util.List<NumericPrediction> forecasts, Instance inst) throws java.lang.Exception
forecasts
- a List of forecasted values. Each element
corresponds to one of the targets and is assumed to be in the same
order as the list of targets supplied to the setTargetFields() method.
java.lang.Exception
- if the evaluation can't be completed for some
reason.public abstract double[] calculateMeasure() throws java.lang.Exception
java.lang.Exception
- if the measure can't be computed for some reason.public abstract java.lang.String toSummaryString() throws java.lang.Exception
java.lang.Exception
- if the measure can't be computed for some reason.public void setTargetFields(java.util.List<java.lang.String> targets)
targets
- a List of target field namespublic java.util.List<java.lang.String> getTargetFields()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |