[lucene] branch main updated: LUCENE-4198: add format description for term impacts to javadocs (#115)

[to...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tomoko pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/lucene.git


The following commit(s) were added to refs/heads/main by this push:
     new c33d211  LUCENE-4198: add format description for term impacts to javadocs (#115)
c33d211 is described below

commit c33d211d2aa3e8fc613b7d434b7a782675aac31a
Author: Tomoko Uchida <to...@gmail.com>
AuthorDate: Tue May 4 10:45:54 2021 +0900

    LUCENE-4198: add format description for term impacts to javadocs (#115)
---
 .../lucene/codecs/lucene90/Lucene90PostingsFormat.java    | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/Lucene90PostingsFormat.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/Lucene90PostingsFormat.java
index e073a28..77dc662 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/Lucene90PostingsFormat.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/Lucene90PostingsFormat.java
@@ -172,10 +172,13 @@ import org.apache.lucene.util.packed.PackedInts;
  *         <li>SkipLevel --&gt; &lt;SkipDatum&gt; <sup>TrimmedDocFreq/(PackedBlockSize^(Level +
  *             1))</sup>
  *         <li>SkipDatum --&gt; DocSkip, DocFPSkip, &lt;PosFPSkip, PosBlockOffset, PayLength?,
- *             PayFPSkip?&gt;?, SkipChildLevelPointer?
+ *             PayFPSkip?&gt;?, ImpactLength, &lt;CompetitiveFreqDelta, CompetitiveNormDelta?&gt;
+ *             <sup>ImpactCount</sup>, SkipChildLevelPointer?
  *         <li>PackedDocDeltaBlock, PackedFreqBlock --&gt; {@link PackedInts PackedInts}
- *         <li>DocDelta, Freq, DocSkip, DocFPSkip, PosFPSkip, PosBlockOffset, PayByteUpto, PayFPSkip
- *             --&gt; {@link DataOutput#writeVInt VInt}
+ *         <li>DocDelta, Freq, DocSkip, DocFPSkip, PosFPSkip, PosBlockOffset, PayByteUpto,
+ *             PayFPSkip, ImpactLength, CompetitiveFreqDelta --&gt; {@link DataOutput#writeVInt
+ *             VInt}
+ *         <li>CompetitiveNormDelta --&gt; {@link DataOutput#writeZLong ZLong}
  *         <li>SkipChildLevelPointer --&gt; {@link DataOutput#writeVLong VLong}
  *         <li>Footer --&gt; {@link CodecUtil#writeFooter CodecFooter}
  *       </ul>
@@ -235,6 +238,10 @@ import org.apache.lucene.util.packed.PackedInts;
  *             and stored as a difference sequence.
  *         <li>PayByteUpto indicates the start offset of the current payload. It is equivalent to
  *             the sum of the payload lengths in the current block up to PosBlockOffset
+ *         <li>ImpactLength is the total length of CompetitiveFreqDelta and CompetitiveNormDelta
+ *             pairs. CompetitiveFreqDelta and CompetitiveNormDelta are used to safely skip score
+ *             calculation for uncompetitive documents; See {@link
+ *             org.apache.lucene.codecs.CompetitiveImpactAccumulator} for more details.
  *       </ul>
  * </dl>
  *
@@ -299,7 +306,7 @@ import org.apache.lucene.util.packed.PackedInts;
  *       positions. Some payloads and offsets will be separated out into .pos file, for performance
  *       reasons.
  *       <ul>
- *         <li>PayFile(.pay): --&gt; Header, &lt;TermPayloads, TermOffsets?&gt;
+ *         <li>PayFile(.pay): --&gt; Header, &lt;TermPayloads?, TermOffsets?&gt;
  *             <sup>TermCount</sup>, Footer
  *         <li>Header --&gt; {@link CodecUtil#writeIndexHeader IndexHeader}
  *         <li>TermPayloads --&gt; &lt;PackedPayLengthBlock, SumPayLength, PayData&gt;