You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2012/08/16 21:45:03 UTC

svn commit: r1374009 - in /lucene/dev/trunk/lucene/core/src/java/org/apache/lucene: search/FuzzyTermsEnum.java util/FuzzySet.java

Author: rmuir
Date: Thu Aug 16 19:45:03 2012
New Revision: 1374009

URL: http://svn.apache.org/viewvc?rev=1374009&view=rev
Log:
javadocs

Modified:
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/FuzzySet.java

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java?rev=1374009&r1=1374008&r2=1374009&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java Thu Aug 16 19:45:03 2012
@@ -398,12 +398,17 @@ public class FuzzyTermsEnum extends Term
     return scale_factor;
   }
   
-  /** @lucene.internal */
+  /**
+   * reuses compiled automata across different segments,
+   * because they are independent of the index
+   * @lucene.internal */
   public static interface LevenshteinAutomataAttribute extends Attribute {
     public List<CompiledAutomaton> automata();
   }
     
-  /** @lucene.internal */
+  /** 
+   * Stores compiled automata as a list (indexed by edit distance)
+   * @lucene.internal */
   public static final class LevenshteinAutomataAttributeImpl extends AttributeImpl implements LevenshteinAutomataAttribute {
     private final List<CompiledAutomaton> automata = new ArrayList<CompiledAutomaton>();
       

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/FuzzySet.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/FuzzySet.java?rev=1374009&r1=1374008&r2=1374009&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/FuzzySet.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/FuzzySet.java Thu Aug 16 19:45:03 2012
@@ -48,6 +48,11 @@ public class FuzzySet {
   
   public static final int FUZZY_SERIALIZATION_VERSION=1;
   
+  /**
+   * Result from {@link FuzzySet#contains(BytesRef)}:
+   * can never return definitively YES (always MAYBE), 
+   * but can sometimes definitely return NO.
+   */
   public enum ContainsResult {
     MAYBE, NO
   };