org.grouplens.lenskit.eval.traintest

Class LenskitTestUser

java.lang.Object

org.grouplens.lenskit.eval.traintest.AbstractTestUser

org.grouplens.lenskit.eval.traintest.LenskitTestUser

All Implemented Interfaces:

TestUser

public class LenskitTestUser
extends AbstractTestUser

A user in a test set, with the results of their recommendations or predictions.

Constructor Summary

Constructors

Constructor and Description
LenskitTestUser(LenskitRecommender rec, UserHistory<Event> testData) Construct a new test user.

Method Summary

Modifier and Type	Method and Description
SparseVector	getPredictions() Get the user's predictions.
List<ScoredId>	getRecommendations(int n, ItemSelector candSel, ItemSelector exclSel) Get the user's recommendations.
LenskitRecommender	getRecommender() Get the recommender
UserHistory<Event>	getTestHistory() Return this user's test history.
UserHistory<Event>	getTrainHistory() Return this user's training history.

Methods inherited from class org.grouplens.lenskit.eval.traintest.AbstractTestUser

getTestRatings, getUserId

Methods inherited from class java.lang.Object

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

Constructor Detail

LenskitTestUser

public LenskitTestUser(LenskitRecommender rec,
                       UserHistory<Event> testData)

Construct a new test user.

Parameters:

rec - The LensKit recommender.

testData - The user history to test.

Method Detail

getTrainHistory

public UserHistory<Event> getTrainHistory()

Description copied from interface: TestUser

Return this user's training history.

Returns:

The history of the user from the training/query set.

getTestHistory

public UserHistory<Event> getTestHistory()

Description copied from interface: TestUser

Return this user's test history.

Returns:

The history of the user from the test set.

getPredictions

public SparseVector getPredictions()

Description copied from interface: TestUser

Get the user's predictions.

Returns:

The predictions of the user's preference for items, or null if the algorithmInfo does not support rating prediction.

getRecommendations

public List<ScoredId> getRecommendations(int n,
                                         ItemSelector candSel,
                                         ItemSelector exclSel)

Description copied from interface: TestUser

Get the user's recommendations.

Parameters:

n - The number of recommendations to generate.

candSel - The candidate selector.

exclSel - The exclude selector.

Returns:

Some recommendations for the user, or null if the recommender does not support recommendation.

See Also:

ItemRecommender.recommend(long, int, java.util.Set, java.util.Set)

getRecommender

public LenskitRecommender getRecommender()

Description copied from interface: TestUser

Get the recommender

Returns:

The recommender.