You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mahout.apache.org by sr...@apache.org on 2010/05/31 15:48:33 UTC
svn commit: r949744 - in
/mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/similarity:
ItemSimilarity.java UserSimilarity.java
Author: srowen
Date: Mon May 31 13:48:33 2010
New Revision: 949744
URL: http://svn.apache.org/viewvc?rev=949744&view=rev
Log:
MAHOUT-406 clarify documentation
Modified:
mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/similarity/ItemSimilarity.java
mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/similarity/UserSimilarity.java
Modified: mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/similarity/ItemSimilarity.java
URL: http://svn.apache.org/viewvc/mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/similarity/ItemSimilarity.java?rev=949744&r1=949743&r2=949744&view=diff
==============================================================================
--- mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/similarity/ItemSimilarity.java (original)
+++ mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/similarity/ItemSimilarity.java Mon May 31 13:48:33 2010
@@ -36,13 +36,12 @@ public interface ItemSimilarity extends
* the items.
* </p>
*
- * @param itemID1
- * first item ID
- * @param itemID2
- * second item ID
- * @return similarity between the items, in [-1,1]
- * @throws TasteException
- * if an error occurs while accessing the data
+ * @param itemID1 first item ID
+ * @param itemID2 second item ID
+ * @return similarity between the items, in [-1,1] or {@link Double#NaN} similarity is unknown
+ * @throws org.apache.mahout.cf.taste.common.NoSuchItemException
+ * if either item is known to be non-existent in the data
+ * @throws TasteException if an error occurs while accessing the data
*/
double itemSimilarity(long itemID1, long itemID2) throws TasteException;
Modified: mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/similarity/UserSimilarity.java
URL: http://svn.apache.org/viewvc/mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/similarity/UserSimilarity.java?rev=949744&r1=949743&r2=949744&view=diff
==============================================================================
--- mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/similarity/UserSimilarity.java (original)
+++ mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/similarity/UserSimilarity.java Mon May 31 13:48:33 2010
@@ -35,13 +35,12 @@ public interface UserSimilarity extends
* Returns the degree of similarity, of two users, based on the their preferences.
* </p>
*
- * @param userID1
- * first user ID
- * @param userID2
- * second user ID
- * @return similarity between the two users, in [-1,1]
- * @throws TasteException
- * if an error occurs while accessing the data
+ * @param userID1 first user ID
+ * @param userID2 second user ID
+ * @return similarity between the users, in [-1,1] or {@link Double#NaN} similarity is unknown
+ * @throws org.apache.mahout.cf.taste.common.NoSuchUserException
+ * if either user is known to be non-existent in the data
+ * @throws TasteException if an error occurs while accessing the data
*/
double userSimilarity(long userID1, long userID2) throws TasteException;
@@ -50,8 +49,7 @@ public interface UserSimilarity extends
* Attaches a {@link PreferenceInferrer} to the implementation.
* </p>
*
- * @param inferrer
- * {@link PreferenceInferrer}
+ * @param inferrer {@link PreferenceInferrer}
*/
void setPreferenceInferrer(PreferenceInferrer inferrer);