.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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::ValueCountMatchSpy 3pm"
.TH Xapian::ValueCountMatchSpy 3pm 2024-03-08 "perl v5.38.2" "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::ValueCountMatchSpy \- Class for counting the frequencies of values in the matching documents.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Search::Xapian qw(:all);
\&
\&  my $db = Search::Xapian::Database\->new( \*(Aq[DATABASE DIR]\*(Aq );
\&  my $enq = $db\->enquire( \*(Aq[QUERY TERM]\*(Aq );
\&  my $spy = Search::Xapian::ValueCountMatchSpy\->new(0);
\&  $enq\->add_matchspy($spy);
\&  my $mset = $enq\->get_mset(0, 10, 10000);
\&
\&  print "Match spy registered " . $spy\->get_total() . " documents\en";
\&
\&  my $end = $spy\->values_end();
\&  for (my $it = $spy\->values_begin(); $it != $end; $it++) {
\&    print $it\->get_termname() . " \- " . $it\->get_termfreq();
\&  }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Class for counting the frequencies of values in the matching documents.
Wraps Xapian::ValueCountMatchSpy
.SH METHODS
.IX Header "METHODS"
.IP new 4
.IX Item "new"
Constructor. Either takes no parameters, or a single valueno parameter identifying the slot.
.IP get_total 4
.IX Item "get_total"
Return the total number of documents tallied.
.IP values_begin 4
.IX Item "values_begin"
Get an iterator over the values seen in the slot.
.IP values_end 4
.IX Item "values_end"
End iterator corresponding to \fBvalues_begin()\fR.
.IP "top_values_begin <maxvalues>" 4
.IX Item "top_values_begin <maxvalues>"
Get an iterator over the most frequent values seen in the slot.
.IP "top_values_end <maxvalues>" 4
.IX Item "top_values_end <maxvalues>"
End iterator corresponding to \fBtop_values_begin()\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Search::Xapian,
Search::Xapian::MatchSpy