xapian-core/matcher/msetcmp.h

   1 /** @file msetcmp.h
   2  * @brief Result comparison functions.
   3  */
   4 /* Copyright (C) 2006,2007,2011,2017 Olly Betts
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
  19  * USA
  20  */
  21
  22 #ifndef XAPIAN_INCLUDED_MSETCMP_H
  23 #define XAPIAN_INCLUDED_MSETCMP_H
  24
  25 #include "api/enquireinternal.h"
  26
  27 class Result;
  28
  29 // typedef for Result comparison function.
  30 typedef bool (* MSetCmp)(const Result&, const Result&);
  31
  32 /// Select the appropriate msetcmp function.
  33 MSetCmp get_msetcmp_function(Xapian::Enquire::Internal::sort_setting sort_by,
  34                              bool sort_forward,
  35                              bool sort_value_forward);
  36
  37 #endif // XAPIAN_INCLUDED_MSETCMP_H