1package Xapian::PositionIterator;
2
3=head1 NAME
4
5Xapian::PositionIterator - Iterate over sets of positions.
6
7=head1 DESCRIPTION
8
9This iterator represents a stream of positions for a term. It overloads
10C<++> for advancing the iterator, or you can explicitly call the C<inc> method.
11This class also overloads C<eq>, C<ne>, C<==>, and C<!=>.
12
13=head2 Compatibility with Search::Xapian
14
15Search::Xapian overloads <""> (stringification) on this class to call
16the C<get_description> method.  Call C<get_description> explicitly instead.
17
18Search::Xapian overloads <0+> (convert to an integer) on this class to call
19the C<get_termpos> method.  Call C<get_termpos> explicitly instead.
20
21=head1 METHODS
22
23=over 4
24
25=item new
26
27Constructor. Defaults to an uninitialized iterator.
28
29=item clone
30
31=item inc
32
33Advance the iterator by one. (Called implicitly by C<++> overloading).
34
35=item skip_to <termpos>
36
37Advance the iterator to term position termpos, or the first term position after
38termpos if termpos isn't in the list of term positions being iterated.
39
40=item equal <positioniterator>
41
42Compare for equality with another Xapian::PositionIterator object. Also
43overloaded to the C<eq> and C<==> operators.
44
45=item nequal <positioniterator>
46
47Compare for inequality with another Xapian::PositionIterator object. Also
48overloaded to the C<ne> and C<!=> operators.
49
50=item get_termpos
51
52Return the term position the iterator is currently on.
53
54=item get_description
55
56Return a description of this object.
57
58=back
59
60=head1 SEE ALSO
61
62L<Xapian>,
63L<Xapian::Document>
64
65=cut
661;
67