Prepare for PartRanker

Author: glorieux-f

common/src/java/com/github/oeuvres/alix/lucene/FlucNum.java

@@ -397,12 +397,11 @@ public int numBytes()
      *
      * @param start        inclusive focus start value
      * @param end          inclusive focus end value
-     * @param policy       policy for incomplete extremity parts
+     * @param policy       policy for incomplete extremity parts, default is {@link PartialExtremityPolicy#ABSORB}
      * @param acceptedDocs optional accepted-documents bitset; {@code null} means
      *                     all documents with a value are accepted
      * @return document partition aligned by global Lucene doc id
      * @throws IOException              if dense-cache construction fails
-     * @throws NullPointerException     if {@code policy == null}
      * @throws IllegalArgumentException if the focus interval is invalid, outside
      *                                  the field value range, creates too many
      *                                  parts for byte storage, or if

common/src/java/com/github/oeuvres/alix/lucene/Partition.java

@@ -59,7 +59,7 @@ public final class Partition
     private final byte[] docPart;
 
     /** Number of accepted documents per part. */
-    private final int[] docs;
+    private final int[] partDocs;
 
     /** Optional focus part, or {@link #NO_FOCUS}. */
     private final int focusPart;
@@ -108,7 +108,7 @@ public final class Partition
         this.partCount = partCount;
         this.focusPart = focusPart;
         this.docPart = new byte[maxDoc];
-        this.docs = new int[partCount];
+        this.partDocs = new int[partCount];
 
         Arrays.fill(docPart, NO_PART);
     }
@@ -154,19 +154,6 @@ public byte[] docPartRef()
         return docPart;
     }
 
-    /**
-     * Returns the number of accepted documents in one part.
-     *
-     * @param part part id
-     * @return document count for the part
-     * @throws IllegalArgumentException if {@code part} is out of range
-     */
-    public int docs(final int part)
-    {
-        checkPart(part);
-        return docs[part];
-    }
-
     /**
      * Returns the focus part.
      *
@@ -207,6 +194,34 @@ public int partCount()
         return partCount;
     }
 
+    /**
+     * Returns the number of accepted documents in one part.
+     *
+     * @param part part id
+     * @return document count for the part
+     * @throws IllegalArgumentException if {@code part} is out of range
+     */
+    public int partDocs(final int part)
+    {
+        checkPart(part);
+        return partDocs[part];
+    }
+
+    /**
+     * Returns the internal part to document count array.
+     *
+     * <p>
+     * This method is intended for hot loops. The returned array must not be
+     * modified.
+     * </p>
+     *
+     * @return internal array indexed by part id
+     */
+    public int[] partDocsRef()
+    {
+        return partDocs;
+    }
+    
     /**
      * Returns a compact textual summary.
      *
@@ -219,7 +234,7 @@ public String toString()
             + "{maxDoc=" + maxDoc
             + ", partCount=" + partCount
             + ", focusPart=" + focusPart
-            + ", docs=" + Arrays.toString(docs)
+            + ", docs=" + Arrays.toString(partDocs)
             + '}';
     }
 
@@ -272,7 +287,7 @@ void reject(final int docId)
         final byte oldPart = docPart[docId];
         if (oldPart == NO_PART) return;
 
-        docs[oldPart]--;
+        partDocs[oldPart]--;
         docPart[docId] = NO_PART;
     }
 
@@ -301,10 +316,10 @@ void set(final int docId, final int part)
         if (oldPart == newPart) return;
 
         if (oldPart != NO_PART) {
-            docs[oldPart]--;
+            partDocs[oldPart]--;
         }
 
         docPart[docId] = newPart;
-        docs[newPart]++;
+        partDocs[newPart]++;
     }
 }

common/src/java/com/github/oeuvres/alix/lucene/terms/TopTerms.java

@@ -486,7 +486,7 @@ public TopTerms partScore(
 
         initFocus();
         this.focusTokens = partTokens[focusPart];
-        this.focusDocs = partition.docs(focusPart);
+        this.focusDocs = partition.partDocs(focusPart);
 
         final int vocabSize = fieldStats.vocabSize();
         final double[] termScores = new double[vocabSize];
@@ -523,7 +523,7 @@ public TopTerms partScore(
                     partTokens, 
                     focusPart,
                     focusDocsForTerm,
-                    partition.docs(focusPart)
+                    partition.partDocs(focusPart)
                 );
                 if (!Double.isNaN(s)) {
                     termScores[termId] = s;