.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Xapian::PostingIterator 3pm"
.TH Xapian::PostingIterator 3pm 2024-03-08 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Search::Xapian::PostingIterator \- Iterate over the list of documents indexed
by a term.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This iterator represents a stream of documents indexed by a term. It overloads
\&\f(CW\*(C`++\*(C'\fR for advancing the iterator, or you can explicitly call the \f(CW\*(C`inc\*(C'\fR method.
This class also overloads \f(CW\*(C`eq\*(C'\fR, \f(CW\*(C`ne\*(C'\fR, \f(CW\*(C`==\*(C'\fR, \f(CW\*(C`!=\*(C'\fR, and \f(CW""\fR
(stringification).
.SH METHODS
.IX Header "METHODS"
.IP new 4
.IX Item "new"
Constructor. Defaults to an uninitialized iterator.
.IP clone 4
.IX Item "clone"
.PD 0
.IP inc 4
.IX Item "inc"
.PD
Advance the iterator by one. (Called implictly by \f(CW\*(C`++\*(C'\fR overloading).
.IP "skip_to <tname>" 4
.IX Item "skip_to <tname>"
Skip the iterator to term tname, or the first term after tname if tname
isn't in the list of terms being iterated.
.IP get_docid 4
.IX Item "get_docid"
Get the unique id of this document.
.IP get_wdf 4
.IX Item "get_wdf"
Return the wdf of the current term (if meaningful).
.IP positionlist_begin 4
.IX Item "positionlist_begin"
Return Search::Xapian::PositionIterator pointing to start of positionlist for current term.
.IP positionlist_end 4
.IX Item "positionlist_end"
Return Search::Xapian::PositionIterator pointing to end of positionlist for current term.
.IP get_doclength 4
.IX Item "get_doclength"
Get the length of the document at the current position in the postlist.
.Sp
This information may be stored in the postlist, in which case this lookup
should be extremely fast (indeed, not require further disk access). If the
information is not present in the postlist, it will be retrieved from the
database, at a greater performance cost.
.IP "equal <term>" 4
.IX Item "equal <term>"
Checks if a term is the same as this term. Also overloaded to the \f(CW\*(C`eq\*(C'\fR
and \f(CW\*(C`==\*(C'\fR operators.
.IP "nequal <term>" 4
.IX Item "nequal <term>"
Checks if a term is different from this term. Also overloaded to the \f(CW\*(C`ne\*(C'\fR
and \f(CW\*(C`!=\*(C'\fR operators.
.IP get_description 4
.IX Item "get_description"
Return a description of this object.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Search::Xapian,
Search::Xapian::Database