org.apache.mahout.cf.taste.impl.similarity

Class CachingUserSimilarity

java.lang.Object

org.apache.mahout.cf.taste.impl.similarity.CachingUserSimilarity

All Implemented Interfaces:

Refreshable, UserSimilarity

public final class CachingUserSimilarity
extends Object
implements UserSimilarity

Caches the results from an underlying UserSimilarity implementation.

Constructor Summary

Constructors

Constructor and Description
CachingUserSimilarity(UserSimilarity similarity, DataModel dataModel) Creates this on top of the given UserSimilarity.
CachingUserSimilarity(UserSimilarity similarity, int maxCacheSize) Creates this on top of the given UserSimilarity.

Method Summary

Modifier and Type	Method and Description
void	clearCacheForUser(long userID)
void	refresh(Collection<Refreshable> alreadyRefreshed) Triggers "refresh" -- whatever that means -- of the implementation.
void	setPreferenceInferrer(PreferenceInferrer inferrer) Attaches a PreferenceInferrer to the UserSimilarity implementation.
double	userSimilarity(long userID1, long userID2) Returns the degree of similarity, of two users, based on the their preferences.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingUserSimilarity

public CachingUserSimilarity(UserSimilarity similarity,
                             DataModel dataModel)
                      throws TasteException

Creates this on top of the given UserSimilarity. The cache is sized according to properties of the given DataModel.

Throws:

TasteException

CachingUserSimilarity

public CachingUserSimilarity(UserSimilarity similarity,
                             int maxCacheSize)

Creates this on top of the given UserSimilarity. The cache size is capped by the given size.

Method Detail

userSimilarity

public double userSimilarity(long userID1,
                             long userID2)
                      throws TasteException

Description copied from interface: UserSimilarity

Returns the degree of similarity, of two users, based on the their preferences.

Specified by:

userSimilarity in interface UserSimilarity

Parameters:

userID1 - first user ID

userID2 - second user ID

Returns:

similarity between the users, in [-1,1] or Double.NaN similarity is unknown

Throws:

NoSuchUserException - if either user is known to be non-existent in the data

TasteException - if an error occurs while accessing the data

setPreferenceInferrer

public void setPreferenceInferrer(PreferenceInferrer inferrer)

Description copied from interface: UserSimilarity

Attaches a PreferenceInferrer to the UserSimilarity implementation.

Specified by:

setPreferenceInferrer in interface UserSimilarity

Parameters:

inferrer - PreferenceInferrer

clearCacheForUser

public void clearCacheForUser(long userID)

refresh

public void refresh(Collection<Refreshable> alreadyRefreshed)

Description copied from interface: Refreshable

Triggers "refresh" -- whatever that means -- of the implementation. The general contract is that any Refreshable should always leave itself in a consistent, operational state, and that the refresh atomically updates internal state from old to new.

Specified by:

refresh in interface Refreshable

Parameters:

alreadyRefreshed - Refreshables that are known to have already been refreshed as a result of an initial call to a {#refresh(Collection)} method on some object. This ensure that objects in a refresh dependency graph aren't refreshed twice needlessly.