---
name: "Search::Xapian::PositionIterator"
section: "3pm"
platform: "linux"
package: "libsearch-xapian-perl"
version: "1.2.25.5-3+b1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Search::Xapian::PositionIterator"
---

# Search::Xapian::PositionIterator(3pm)

Iterate over sets of positions.

## NAME

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

## DESCRIPTION

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

## METHODS

- new

  Constructor. Defaults to an uninitialized iterator.

- clone

  - inc

  Advance the iterator by one. (Called implictly by `"++"` overloading).

- 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.

- equal \<term\>

  Checks if a term is the same as this term. Also overloaded to the `"eq"` and `"=="` operators.

- nequal \<term\>

  Checks if a term is different from this term. Also overloaded to the `"ne"` and `"!="` operators.

- get\_termpos

  Return the term position the iterator is currently on. Also implemented as conversion to an integer.

- get\_description

  Return a description of this object.  Also implemented as stringification.

## SEE ALSO

Search::Xapian, Search::Xapian::Document