1Xapian::PositionIteratoUrs(e3r)Contributed Perl DocumentXaatpiioann::PositionIterator(3)
2
3
4

NAME

6       Search::Xapian::PositionIterator - Iterate over sets of positions.
7

DESCRIPTION

9       This iterator represents a stream of positions for a term. It overloads
10       "++" for advancing the iterator, or you can explicitly call the "inc"
11       method.  This class also overloads "eq", "ne", "==", "!=", ""
12       (stringification) and "0+" (conversion to an integer).
13

METHODS

15       new Constructor. Defaults to an uninitialized iterator.
16
17       clone
18       inc Advance the iterator by one. (Called implictly by "++"
19           overloading).
20
21       skip_to <termpos>
22           Skip the iterator to term position termpos, or the first term
23           position after termpos if termpos isn't in the list of term
24           positions being iterated.
25
26       equal <term>
27           Checks if a term is the same as this term. Also overloaded to the
28           "eq" and "==" operators.
29
30       nequal <term>
31           Checks if a term is different from this term. Also overloaded to
32           the "ne" and "!=" operators.
33
34       get_termpos
35           Return the term position the iterator is currently on. Also
36           implemented as conversion to an integer.
37
38       get_description
39           Return a description of this object.  Also implemented as
40           stringification.
41

SEE ALSO

43       Search::Xapian, Search::Xapian::Document
44
45
46
47perl v5.36.0                      2022-07-22       Xapian::PositionIterator(3)