---
name: "Search::Xapian::TermIterator"
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::TermIterator"
---

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

Iterate over sets of terms.

## NAME

Search::Xapian::TermIterator - Iterate over sets of terms.

## DESCRIPTION

This object represents a stream of terms. It overloads `"++"` for advancing the iterator, or you can explicitly call the `"inc"` method. This class also overloads `"eq"`, `"ne"`, `"=="`, `"!="`, and `""` (stringification).

## METHODS

- new

  Constructor. Defaults to a uninitialized iterator.

- clone

  - inc

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

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

- get\_termname

  Get the name of the current term.

- get\_wdf

  Return the wdf of the current term (if meaningful).

- get\_termfreq

  Return the term frequency of the current term (if meaningful).

- positionlist\_begin

  Return Search::Xapian::PositionIterator pointing to start of positionlist for current term.

- positionlist\_end

  Return Search::Xapian::PositionIterator pointing to end of positionlist for current term.

- get\_description

  Returns a string describing this object.

- equal \<termiterator\>

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

- nequal \<termiterator\>

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

## SEE ALSO

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