LCOV - code coverage report
Current view: top level - weight - dicecoeffweight.cc (source / functions) Hit Total Coverage
Test: Test Coverage for xapian-core 7028d852e609 Lines: 25 31 80.6 %
Date: 2019-02-17 14:59:59 Functions: 9 11 81.8 %
Branches: 10 24 41.7 %

           Branch data     Line data    Source code
       1                 :            : /** @file dicecoeffweight.cc
       2                 :            :  * @brief Xapian::DiceCoeffWeight class
       3                 :            :  */
       4                 :            : /* Copyright (C) 2018 Guruprasad Hegde
       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 USA
      19                 :            :  */
      20                 :            : 
      21                 :            : #include <config.h>
      22                 :            : 
      23                 :            : #include "xapian/weight.h"
      24                 :            : 
      25                 :            : #include "xapian/error.h"
      26                 :            : 
      27                 :            : using namespace std;
      28                 :            : 
      29                 :            : namespace Xapian {
      30                 :            : 
      31                 :            : DiceCoeffWeight *
      32                 :         62 : DiceCoeffWeight::clone() const
      33                 :            : {
      34                 :         62 :     return new DiceCoeffWeight();
      35                 :            : }
      36                 :            : 
      37                 :            : void
      38                 :         48 : DiceCoeffWeight::init(double factor_)
      39                 :            : {
      40         [ +  + ]:         48 :     if (factor_ == 0.0) {
      41                 :            :         // This object is for the term-independent contribution, and that's
      42                 :            :         // always zero for this scheme.
      43                 :         16 :         return;
      44                 :            :     }
      45                 :            : 
      46                 :         32 :     factor = get_wqf() * factor_;
      47                 :            : 
      48                 :            :     // Upper bound computation:
      49                 :            :     // dice_coeff(q, d) = 2.0 * (q ∩ d) / (|q| + |d|)
      50                 :            :     // To maximize the result minimize the denominator, hence
      51                 :            :     // |q|= 1, |d| = lower bound on unique term.
      52                 :            :     // FIXME lower bound on unique term is not tracked in database,
      53                 :            :     // hence keeping its value as 1, this will not give a tight bound.
      54                 :            :     // Plan to fix in future.
      55                 :         32 :     double uniqtermlen_lb = 1;
      56                 :         32 :     upper_bound = factor * (2.0 / (get_query_length() + uniqtermlen_lb));
      57                 :            : }
      58                 :            : 
      59                 :            : string
      60                 :       1432 : DiceCoeffWeight::name() const
      61                 :            : {
      62         [ +  - ]:       1432 :     return "Xapian::DiceCoeffWeight";
      63                 :            : }
      64                 :            : 
      65                 :            : string
      66                 :       1427 : DiceCoeffWeight::short_name() const
      67                 :            : {
      68         [ +  - ]:       1427 :     return "dicecoeff";
      69                 :            : }
      70                 :            : 
      71                 :            : string
      72                 :          8 : DiceCoeffWeight::serialise() const
      73                 :            : {
      74                 :          8 :     return string();
      75                 :            : }
      76                 :            : 
      77                 :            : DiceCoeffWeight *
      78                 :          6 : DiceCoeffWeight::unserialise(const string & s) const
      79                 :            : {
      80         [ +  + ]:          6 :     if (rare(!s.empty()))
      81                 :            :         throw Xapian::SerialisationError("Extra data in "
      82 [ +  - ][ +  - ]:          1 :                 "DiceCoeffWeight::unserialise()");
                 [ +  - ]
      83                 :          5 :     return new DiceCoeffWeight;
      84                 :            : }
      85                 :            : 
      86                 :            : double
      87                 :         84 : DiceCoeffWeight::get_sumpart(Xapian::termcount wdf, Xapian::termcount,
      88                 :            :                              Xapian::termcount uniqterms) const
      89                 :            : {
      90         [ -  + ]:         84 :     if (wdf == 0) return 0.0;
      91                 :         84 :     return factor * 2.0 / (get_query_length() + uniqterms);
      92                 :            : }
      93                 :            : 
      94                 :            : double
      95                 :         64 : DiceCoeffWeight::get_maxpart() const
      96                 :            : {
      97                 :         64 :     return upper_bound;
      98                 :            : }
      99                 :            : 
     100                 :            : double
     101                 :          0 : DiceCoeffWeight::get_sumextra(Xapian::termcount, Xapian::termcount) const
     102                 :            : {
     103                 :          0 :     return 0;
     104                 :            : }
     105                 :            : 
     106                 :            : double
     107                 :         16 : DiceCoeffWeight::get_maxextra() const
     108                 :            : {
     109                 :         16 :     return 0;
     110                 :            : }
     111                 :            : 
     112                 :            : DiceCoeffWeight *
     113                 :          0 : DiceCoeffWeight::create_from_parameters(const char * p) const
     114                 :            : {
     115         [ #  # ]:          0 :     if (*p != '\0')
     116                 :            :         throw InvalidArgumentError("No parameters are required for "
     117 [ #  # ][ #  # ]:          0 :                 "DiceCoeffWeight");
                 [ #  # ]
     118                 :          0 :     return new Xapian::DiceCoeffWeight;
     119                 :            : }
     120                 :            : 
     121                 :            : }

Generated by: LCOV version 1.11