org.grouplens.lenskit.baseline

Class AbstractBaselinePredictor

java.lang.Object

org.grouplens.lenskit.baseline.AbstractBaselinePredictor

All Implemented Interfaces:

Serializable, BaselinePredictor

Direct Known Subclasses:

ConstantPredictor, ItemMeanPredictor, ItemUserMeanPredictor, LeastSquaresPredictor, UserMeanPredictor

public abstract class AbstractBaselinePredictor
extends Object
implements BaselinePredictor

Abstract implementation of BaselinePredictor.

Author:

GroupLens Research

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractBaselinePredictor()

Method Summary

Methods

Modifier and Type	Method and Description
MutableSparseVector	predict(long user, Collection<Long> items) Generate baseline predictions for several items into a new vector.
void	predict(long user, MutableSparseVector output) Predict method that scores into an existing mutable sparse vector.
MutableSparseVector	predict(long user, SparseVector ratings, Collection<Long> items) Generate baseline predictions for several items into a new vector.
void	predict(long user, SparseVector ratings, MutableSparseVector output) Predict method that scores into an existing mutable sparse vector.
void	predict(long user, SparseVector ratings, MutableSparseVector output, boolean predictSet) Predict method that scores into an existing mutable sparse vector.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.grouplens.lenskit.baseline.BaselinePredictor

predict

Constructor Detail

AbstractBaselinePredictor

public AbstractBaselinePredictor()

Method Detail

predict

public MutableSparseVector predict(long user,
                          SparseVector ratings,
                          Collection<Long> items)

Generate baseline predictions for several items into a new vector.

Implements new-vector predict in terms of predict(long, SparseVector, MutableSparseVector).

Specified by:

predict in interface BaselinePredictor

Parameters:

user - The user ID.

ratings - The user's ratings.

items - The items to score.

Returns:

A new sparse vector containing the baseline predictions for items.

predict

public void predict(long user,
           SparseVector ratings,
           MutableSparseVector output)

Predict method that scores into an existing mutable sparse vector.

Delegates to predict(long, SparseVector, MutableSparseVector, boolean) with predictSet of true.

Specified by:

predict in interface BaselinePredictor

Parameters:

user - The user ID.

ratings - The user's ratings.

output - The output vector. All items in the key domain are scored.

See Also:

RatingPredictor.score(UserHistory, MutableSparseVector)

predict

public void predict(long user,
           SparseVector ratings,
           MutableSparseVector output,
           boolean predictSet)

Predict method that scores into an existing mutable sparse vector.

Delegates to BaselinePredictor.predict(long, MutableSparseVector, boolean).

Specified by:

predict in interface BaselinePredictor

Parameters:

user - The user ID.

ratings - The user's ratings.

output - The output vector. All items in the key domain are scored

predictSet - If true, predict all items; otherwise, only predict items that are not set..

See Also:

RatingPredictor.score(UserHistory, MutableSparseVector)

predict

public MutableSparseVector predict(long user,
                          Collection<Long> items)

Generate baseline predictions for several items into a new vector.

Delegates to predict(long, MutableSparseVector).

Specified by:

predict in interface BaselinePredictor

Parameters:

user - The user ID.

items - The items to score.

Returns:

A new sparse vector containing the baseline predictions for items.

predict

public void predict(long user,
           MutableSparseVector output)

Predict method that scores into an existing mutable sparse vector.

Delegates to BaselinePredictor.predict(long, MutableSparseVector, boolean) with predictSet of true.

Specified by:

predict in interface BaselinePredictor

Parameters:

user - The user ID.

output - The output vector. All items in the key domain are scored.

See Also:

RatingPredictor.score(UserHistory, MutableSparseVector)