.\" -*- 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::MultiValueSorter 3pm"
.TH Xapian::MultiValueSorter 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::MultiValueSorter \- allows sorting by a several values.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Results are ordered by the first value.  In the event of a tie, the
second is used.  If this is the same for both, the third is used, and
so on.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Search::Xapian;
\&
\&  my $db = new Search::Xapian::Database("/path/to/db");
\&  my $enq = new Search::Xapian::Enquire($db);
\&  my $sorter = new Search::Xapian::MultiValueSorter(1, 3, 5);
\&  $enq\->set_sort_by_key($sorter);
.Ve
.SH METHODS
.IX Header "METHODS"
.IP "new [<value>...]" 4
.IX Item "new [<value>...]"
Construct and add the values listed.
.IP "add <value> [<forward>]" 4
.IX Item "add <value> [<forward>]"
Add another value to sort on.  By default, values sort forwards, unless forward
is specified and is false.
.SH REFERENCE
.IX Header "REFERENCE"
.Vb 1
\&  https://xapian.org/docs/sourcedoc/html/classXapian_1_1MultiValueSorter.html
.Ve