org.grouplens.lenskit.eval.metrics

Class AbstractMetric<E>

java.lang.Object

org.grouplens.lenskit.eval.metrics.AbstractMetric<E>

All Implemented Interfaces:

Metric<E>

Direct Known Subclasses:

AbstractTestUserMetric

public abstract class AbstractMetric<E>
extends Object
implements Metric<E>

A simple metric base class that tracks the current evaluation.

Since:

0.10

Author:

GroupLens Research

Constructor Summary

Constructors

Constructor and Description
AbstractMetric()

Method Summary

Methods

Modifier and Type	Method and Description
void	finishEvaluation() Finish the evaluation, releasing any resources allocated for it.
protected E	getCurrentEvaluation() Get the current evaluation, or null none is in progress.
void	startEvaluation(E eval) Initialize the metric to accumulate evaluations for the specified evaluation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMetric

public AbstractMetric()

Method Detail

startEvaluation

public void startEvaluation(E eval)

Description copied from interface: Metric

Initialize the metric to accumulate evaluations for the specified evaluation. This method is called before any accumulators are constructed. It is invalid to start a metric twice without finishing it first.

Specified by:

startEvaluation in interface Metric<E>

Parameters:

eval - The evaluation this metric is in use for.

finishEvaluation

public void finishEvaluation()

Description copied from interface: Metric

Finish the evaluation, releasing any resources allocated for it. This will be called after all algorithms and data sets are run through the accumulator. After this method, the metric should be ready to be used on another evaluation.

Specified by:

finishEvaluation in interface Metric<E>

getCurrentEvaluation

protected E getCurrentEvaluation()

Get the current evaluation, or null none is in progress.

Returns:

The current evaluation.