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

java.lang.Object
  extended by org.apache.mahout.cf.taste.impl.similarity.AbstractItemSimilarity
      extended by org.apache.mahout.cf.taste.impl.similarity.UncenteredCosineSimilarity
All Implemented Interfaces:
Refreshable, ItemSimilarity, UserSimilarity

public final class UncenteredCosineSimilarity
extends AbstractItemSimilarity

An implementation of the cosine similarity. The result is the cosine of the angle formed between the two preference vectors.

Note that this similarity does not "center" its data, shifts the user's preference values so that each of their means is 0. For this behavior, use PearsonCorrelationSimilarity, which actually is mathematically equivalent for centered data.


Constructor Summary
UncenteredCosineSimilarity(DataModel dataModel)
           
UncenteredCosineSimilarity(DataModel dataModel, Weighting weighting)
           
 
Method Summary
 double[] itemSimilarities(long itemID1, long[] itemID2s)
          A bulk-get version of ItemSimilarity.itemSimilarity(long, long).
 double itemSimilarity(long itemID1, long itemID2)
           Returns the degree of similarity, of two items, based on the preferences that users have expressed for the items.
 void refresh(Collection<Refreshable> alreadyRefreshed)
           Triggers "refresh" -- whatever that means -- of the implementation.
 void setPreferenceInferrer(PreferenceInferrer inferrer)
           Attaches a PreferenceInferrer to the UserSimilarity implementation.
 String toString()
           
 double userSimilarity(long userID1, long userID2)
           Returns the degree of similarity, of two users, based on the their preferences.
 
Methods inherited from class org.apache.mahout.cf.taste.impl.similarity.AbstractItemSimilarity
allSimilarItemIDs, getDataModel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UncenteredCosineSimilarity

public UncenteredCosineSimilarity(DataModel dataModel)
                           throws TasteException
Throws:
IllegalArgumentException - if DataModel does not have preference values
TasteException

UncenteredCosineSimilarity

public UncenteredCosineSimilarity(DataModel dataModel,
                                  Weighting weighting)
                           throws TasteException
Throws:
IllegalArgumentException - if DataModel does not have preference values
TasteException
Method Detail

setPreferenceInferrer

public final 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

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

itemSimilarity

public final double itemSimilarity(long itemID1,
                                   long itemID2)
                            throws TasteException
Description copied from interface: ItemSimilarity

Returns the degree of similarity, of two items, based on the preferences that users have expressed for the items.

Specified by:
itemSimilarity in interface ItemSimilarity
Parameters:
itemID1 - first item ID
itemID2 - second item ID
Returns:
similarity between the items, in [-1,1] or Double.NaN similarity is unknown
Throws:
NoSuchItemException - if either item is known to be non-existent in the data
TasteException - if an error occurs while accessing the data

itemSimilarities

public double[] itemSimilarities(long itemID1,
                                 long[] itemID2s)
                          throws TasteException
Description copied from interface: ItemSimilarity

A bulk-get version of ItemSimilarity.itemSimilarity(long, long).

Specified by:
itemSimilarities in interface ItemSimilarity
Parameters:
itemID1 - first item ID
itemID2s - second item IDs to compute similarity with
Returns:
similarity between itemID1 and other items
Throws:
NoSuchItemException - if any item is known to be non-existent in the data
TasteException - if an error occurs while accessing the data

refresh

public final 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
Overrides:
refresh in class AbstractItemSimilarity
Parameters:
alreadyRefreshed - Refreshables that are known to have already been refreshed as a result of an initial call to a Refreshable.refresh(Collection) method on some object. This ensure that objects in a refresh dependency graph aren't refreshed twice needlessly.

toString

public final String toString()
Overrides:
toString in class Object


Copyright © 2008–2014 The Apache Software Foundation. All rights reserved.