xapian-bindings/perl/Xapian/TradWeight.pm

   1 package Xapian::TradWeight;
   2
   3 =head1 NAME
   4
   5 Xapian::TradWeight - Traditional Probabilistic Weighting scheme.
   6
   7 =head1 DESCRIPTION
   8
   9 Traditional Probabilistic Weighting scheme, as described by the early papers
  10 on Probabilistic Retrieval.  BM25 generally gives better results.
  11
  12 This class is deprecated - use C<BM25Weight(k, 0, 0, 1, 0)> instead (which it
  13 is equivalent to).
  14
  15 =head1 METHODS
  16
  17 =over 4
  18
  19 =item new
  20
  21 Constructor. Either takes no parameters, or a single non-negative parameter k.
  22 If k isn't specified, the default value used is 1.
  23
  24 =back
  25
  26 =head1 SEE ALSO
  27
  28 L<Xapian>,
  29 L<Xapian::Enquire>
  30
  31 =cut
  32 1;