lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Franco Callari (JIRA)" <>
Subject [jira] [Created] (LUCENE-4314) The specification of DocIdSetIterator is needlessly ambiguous.
Date Mon, 20 Aug 2012 02:28:37 GMT
Franco Callari created LUCENE-4314:

             Summary: The specification of DocIdSetIterator is needlessly ambiguous.
                 Key: LUCENE-4314
             Project: Lucene - Core
          Issue Type: Improvement
          Components: core/search
    Affects Versions: 4.0-BETA, 3.6.1
         Environment: All
            Reporter: Franco Callari

Quoth Lucene at

     "Advances to the first beyond (see NOTE below) the current whose document
      number is greater than or equal to <i>target</i>. [...]
      NOTE:</b> when <code> target &le; current</code> implementations
may opt
      not to advance beyond their current {@link #docID()}."

However, the same specification contradictorily states that advance must behave as if written:

     int advance(int target) {
       int doc;
       while ((doc = nextDoc()) < target) {}
       return doc;

That is, with at least one call to nextDoc() always made, unconditionally.

This ambiguity can lead to unexpected behavior. In fact, arguably every user of this interface
that does not test after every call whether the iterator has exhausted AND has advanced is

For example, I myself had one experimental implementation (coded against a previous Lucene
release) that caused an infinite loop in because, following the above specification,
it "opted" not to move the iterator when advance(target) was called with target < current.

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:!default.jspa
For more information on JIRA, see:


To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message