.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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::PositionIterator 3"
.TH Xapian::PositionIterator 3 2024-09-01 "perl v5.40.0" "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::PositionIterator \- Iterate over sets of positions.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This iterator represents a stream of positions for 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, \f(CW""\fR
(stringification) and \f(CW\*(C`0+\*(C'\fR (conversion to an integer).
.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 <termpos>" 4
.IX Item "skip_to <termpos>"
Skip the iterator to term position termpos, or the first term position after
termpos if termpos isn't in the list of term positions being iterated.
.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_termpos 4
.IX Item "get_termpos"
Return the term position the iterator is currently on. Also implemented as
conversion to an integer.
.IP get_description 4
.IX Item "get_description"
Return a description of this object.  Also implemented as stringification.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Search::Xapian,
Search::Xapian::Document