org.grouplens.lenskit.eval.metrics.predict

Class HLUtilityPredictMetric

java.lang.Object

org.grouplens.lenskit.eval.metrics.AbstractMetric<MeanAccumulator,HLUtilityPredictMetric.Result,HLUtilityPredictMetric.Result>

org.grouplens.lenskit.eval.metrics.predict.HLUtilityPredictMetric

All Implemented Interfaces:

Closeable, AutoCloseable, Metric<MeanAccumulator>

public class HLUtilityPredictMetric
extends AbstractMetric<MeanAccumulator,HLUtilityPredictMetric.Result,HLUtilityPredictMetric.Result>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HLUtilityPredictMetric.Result

Constructor Summary

Constructors

Constructor and Description
HLUtilityPredictMetric()
HLUtilityPredictMetric(double newAlpha)

Method Summary

Modifier and Type	Method and Description
MeanAccumulator	createContext(Attributed algo, TTDataSet ds, Recommender rec) Create the context for an experimental condition (algorithm/data set pair).
HLUtilityPredictMetric.Result	doMeasureUser(TestUser user, MeanAccumulator context) Measure a user with typed results.
protected HLUtilityPredictMetric.Result	getTypedResults(MeanAccumulator context) Get the typed results from an accumulator.

Methods inherited from class org.grouplens.lenskit.eval.metrics.AbstractMetric

close, getColumnLabels, getPrefix, getResults, getSuffix, getUserColumnLabels, measureUser

Methods inherited from class java.lang.Object

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

Constructor Detail

HLUtilityPredictMetric

public HLUtilityPredictMetric(double newAlpha)

HLUtilityPredictMetric

public HLUtilityPredictMetric()

Method Detail

createContext

public MeanAccumulator createContext(Attributed algo,
                                     TTDataSet ds,
                                     Recommender rec)

Description copied from interface: Metric

Create the context for an experimental condition (algorithm/data set pair).

Parameters:

algo - The algorithm.

ds - The data set.

rec - The LensKit recommender, if applicable. This can be null for an external algorithm that does not provide a LensKit recommender.

Returns:

The accumulator. This will be passed to Metric.measureUser(TestUser, Object). If the metric does not accumulate any results, this method can return null.

doMeasureUser

public HLUtilityPredictMetric.Result doMeasureUser(TestUser user,
                                                   MeanAccumulator context)

Description copied from class: AbstractMetric

Measure a user with typed results.

Specified by:

doMeasureUser in class AbstractMetric<MeanAccumulator,HLUtilityPredictMetric.Result,HLUtilityPredictMetric.Result>

Parameters:

user - The user to measure.

context - The context.

Returns:

The results of measuring the user, or null to emit NAs for the user.

getTypedResults

protected HLUtilityPredictMetric.Result getTypedResults(MeanAccumulator context)

Description copied from class: AbstractMetric

Get the typed results from an accumulator.

Specified by:

getTypedResults in class AbstractMetric<MeanAccumulator,HLUtilityPredictMetric.Result,HLUtilityPredictMetric.Result>

Parameters:

context - The context.

Returns:

The results accumulated for this experiment, or null to emit NAs.