it.unimi.dsi.mg4j.search.score
Interface ScoredDocumentIterator

All Superinterfaces:
DocumentIterator, IntIterator, Iterator

public interface ScoredDocumentIterator
extends DocumentIterator

A document iterator with additional methods that return the score of the current document, either with respect to a specified index (score(Index)), or globally (score()).

Note that the score methods must be called just after the DocumentIterator.nextDocument() method, and calling one of those method may inhibit calls to DocumentIterator.intervalIterator(Index) and such (this is implementation dependent, though).


Method Summary
 double score()
          Returns the overall score of the current document.
 double score(Index index)
          Returns the score of the current document with respect to the given index.
 
Methods inherited from interface it.unimi.dsi.mg4j.search.DocumentIterator
document, indices, intervalIterator, intervalIterator, intervalIterators, nextDocument, skipTo
 
Methods inherited from interface it.unimi.dsi.fastutil.ints.IntIterator
nextInt, skip
 
Methods inherited from interface java.util.Iterator
hasNext, next, remove
 

Method Detail

score

public double score(Index index)
Returns the score of the current document with respect to the given index.

Returns:
the score of the current document.

score

public double score()
Returns the overall score of the current document.

Returns:
the score of the current document.