src/relevance.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2012 Index Data
   3
   4 Pazpar2 is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 */
  19
  20 #if HAVE_CONFIG_H
  21 #include <config.h>
  22 #endif
  23
  24 #include <assert.h>
  25 #include <math.h>
  26 #include <stdlib.h>
  27
  28 #include "relevance.h"
  29 #include "session.h"
  30
  31 struct relevance
  32 {
  33     int *doc_frequency_vec;
  34     int vec_len;
  35     struct word_entry *entries;
  36     pp2_charset_token_t prt;
  37     int rank_cluster;
  38     NMEM nmem;
  39 };
  40
  41 struct word_entry {
  42     const char *norm_str;
  43     const char *display_str;
  44     int termno;
  45     char *ccl_field;
  46     struct word_entry *next;
  47 };
  48
  49 static int word_entry_match(struct word_entry *entries, const char *norm_str,
  50                             const char *rank, int *mult)
  51 {
  52     for (; entries; entries = entries->next)
  53     {
  54         if (*norm_str && !strcmp(norm_str, entries->norm_str))
  55         {
  56             const char *cp = 0;
  57             int no_read = 0;
  58             sscanf(rank, "%d%n", mult, &no_read);
  59             rank += no_read;
  60             while (*rank == ' ')
  61                 rank++;
  62             if (no_read > 0 && (cp = strchr(rank, ' ')))
  63             {
  64                 if ((cp - rank) == strlen(entries->ccl_field) &&
  65                     memcmp(entries->ccl_field, rank, cp - rank) == 0)
  66                     *mult = atoi(cp + 1);
  67             }
  68             return entries->termno;
  69         }
  70     }
  71     return 0;
  72 }
  73
  74 void relevance_countwords(struct relevance *r, struct record_cluster *cluster,
  75                           const char *words, const char *rank,
  76                           const char *name)
  77 {
  78     int *mult = cluster->term_frequency_vec_tmp;
  79     const char *norm_str;
  80     int i, length = 0;
  81     struct word_entry *e = r->entries;
  82     WRBUF w = cluster->relevance_explain1;
  83
  84     pp2_charset_token_first(r->prt, words, 0);
  85     for (i = 1; i < r->vec_len; i++)
  86         mult[i] = 0;
  87
  88     assert(rank);
  89     while ((norm_str = pp2_charset_token_next(r->prt)))
  90     {
  91         int local_mult = 0;
  92         int res = word_entry_match(r->entries, norm_str, rank, &local_mult);
  93         if (res)
  94         {
  95             assert(res < r->vec_len);
  96             mult[res] += local_mult;
  97         }
  98         length++;
  99     }
 100
 101     for (i = 1; i < r->vec_len; i++)
 102     {
 103         if (length > 0 && mult[i] > 0) /* only add if non-empty */
 104         {
 105             wrbuf_printf(w, "%s: field=%s vecf[%d] += mult(%d) / length(%d);\n",
 106                          e->display_str, name, i, mult[i], length);
 107             cluster->term_frequency_vecf[i] += (double) mult[i] / length;
 108         }
 109         cluster->term_frequency_vec[i] += mult[i];
 110         e = e->next;
 111     }
 112
 113     cluster->term_frequency_vec[0] += length;
 114 }
 115
 116 static void pull_terms(struct relevance *res, struct ccl_rpn_node *n)
 117 {
 118     char **words;
 119     int numwords;
 120     char *ccl_field;
 121     int i;
 122
 123     switch (n->kind)
 124     {
 125     case CCL_RPN_AND:
 126     case CCL_RPN_OR:
 127     case CCL_RPN_NOT:
 128     case CCL_RPN_PROX:
 129         pull_terms(res, n->u.p[0]);
 130         pull_terms(res, n->u.p[1]);
 131         break;
 132     case CCL_RPN_TERM:
 133         nmem_strsplit(res->nmem, " ", n->u.t.term, &words, &numwords);
 134         for (i = 0; i < numwords; i++)
 135         {
 136             const char *norm_str;
 137
 138             ccl_field = nmem_strdup_null(res->nmem, n->u.t.qual);
 139
 140             pp2_charset_token_first(res->prt, words[i], 0);
 141             while ((norm_str = pp2_charset_token_next(res->prt)))
 142             {
 143                 struct word_entry **e = &res->entries;
 144                 while (*e)
 145                     e = &(*e)->next;
 146                 *e = nmem_malloc(res->nmem, sizeof(**e));
 147                 (*e)->norm_str = nmem_strdup(res->nmem, norm_str);
 148                 (*e)->ccl_field = ccl_field;
 149                 (*e)->termno = res->vec_len++;
 150                 (*e)->display_str = nmem_strdup(res->nmem, words[i]);
 151                 (*e)->next = 0;
 152             }
 153         }
 154         break;
 155     default:
 156         break;
 157     }
 158 }
 159
 160 struct relevance *relevance_create_ccl(pp2_charset_fact_t pft,
 161                                        struct ccl_rpn_node *query,
 162                                        int rank_cluster)
 163 {
 164     NMEM nmem = nmem_create();
 165     struct relevance *res = nmem_malloc(nmem, sizeof(*res));
 166     int i;
 167
 168     res->nmem = nmem;
 169     res->entries = 0;
 170     res->vec_len = 1;
 171     res->rank_cluster = rank_cluster;
 172     res->prt = pp2_charset_token_create(pft, "relevance");
 173
 174     pull_terms(res, query);
 175
 176     res->doc_frequency_vec = nmem_malloc(nmem, res->vec_len * sizeof(int));
 177     for (i = 0; i < res->vec_len; i++)
 178         res->doc_frequency_vec[i] = 0;
 179     return res;
 180 }
 181
 182 void relevance_destroy(struct relevance **rp)
 183 {
 184     if (*rp)
 185     {
 186         pp2_charset_token_destroy((*rp)->prt);
 187         nmem_destroy((*rp)->nmem);
 188         *rp = 0;
 189     }
 190 }
 191
 192 void relevance_newrec(struct relevance *r, struct record_cluster *rec)
 193 {
 194     if (!rec->term_frequency_vec)
 195     {
 196         int i;
 197
 198         // term frequency [1,..] . [0] is total length of all fields
 199         rec->term_frequency_vec =
 200             nmem_malloc(r->nmem,
 201                         r->vec_len * sizeof(*rec->term_frequency_vec));
 202         for (i = 0; i < r->vec_len; i++)
 203             rec->term_frequency_vec[i] = 0;
 204
 205         // term frequency divided by length of field [1,...]
 206         rec->term_frequency_vecf =
 207             nmem_malloc(r->nmem,
 208                         r->vec_len * sizeof(*rec->term_frequency_vecf));
 209         for (i = 0; i < r->vec_len; i++)
 210             rec->term_frequency_vecf[i] = 0.0;
 211
 212         // for relevance_countwords (so we don't have to xmalloc/xfree)
 213         rec->term_frequency_vec_tmp =
 214             nmem_malloc(r->nmem,
 215                         r->vec_len * sizeof(*rec->term_frequency_vec_tmp));
 216     }
 217 }
 218
 219 void relevance_donerecord(struct relevance *r, struct record_cluster *cluster)
 220 {
 221     int i;
 222
 223     for (i = 1; i < r->vec_len; i++)
 224         if (cluster->term_frequency_vec[i] > 0)
 225             r->doc_frequency_vec[i]++;
 226
 227     r->doc_frequency_vec[0]++;
 228 }
 229
 230 // Prepare for a relevance-sorted read
 231 void relevance_prepare_read(struct relevance *rel, struct reclist *reclist)
 232 {
 233     int i;
 234     float *idfvec = xmalloc(rel->vec_len * sizeof(float));
 235
 236     reclist_enter(reclist);
 237     // Calculate document frequency vector for each term.
 238     for (i = 1; i < rel->vec_len; i++)
 239     {
 240         if (!rel->doc_frequency_vec[i])
 241             idfvec[i] = 0;
 242         else
 243         {
 244             /* add one to nominator idf(t,D) to ensure a value > 0 */
 245             idfvec[i] = log((float) (1 + rel->doc_frequency_vec[0]) /
 246                             rel->doc_frequency_vec[i]);
 247         }
 248     }
 249     // Calculate relevance for each document
 250     while (1)
 251     {
 252         int relevance = 0;
 253         WRBUF w;
 254         struct word_entry *e = rel->entries;
 255         struct record_cluster *rec = reclist_read_record(reclist);
 256         if (!rec)
 257             break;
 258         w = rec->relevance_explain2;
 259         wrbuf_rewind(w);
 260         for (i = 1; i < rel->vec_len; i++)
 261         {
 262             float termfreq = (float) rec->term_frequency_vecf[i];
 263             int add = 100000 * termfreq * idfvec[i];
 264
 265             wrbuf_printf(w, "idf[%d] = log(((1 + total(%d))/termoccur(%d));\n",
 266                          i, rel->doc_frequency_vec[0],
 267                          rel->doc_frequency_vec[i]);
 268             wrbuf_printf(w, "%s: relevance += 100000 * vecf[%d](%f) * "
 269                          "idf[%d](%f) (%d);\n",
 270                          e->display_str, i, termfreq, i, idfvec[i], add);
 271             relevance += add;
 272             e = e->next;
 273         }
 274         if (!rel->rank_cluster)
 275         {
 276             struct record *record;
 277             int cluster_size = 0;
 278
 279             for (record = rec->records; record; record = record->next)
 280                 cluster_size++;
 281
 282             wrbuf_printf(w, "score = relevance(%d)/cluster_size(%d);\n",
 283                          relevance, cluster_size);
 284             relevance /= cluster_size;
 285         }
 286         else
 287         {
 288             wrbuf_printf(w, "score = relevance(%d);\n", relevance);
 289         }
 290         rec->relevance_score = relevance;
 291     }
 292     reclist_leave(reclist);
 293     xfree(idfvec);
 294 }
 295
 296 /*
 297  * Local variables:
 298  * c-basic-offset: 4
 299  * c-file-style: "Stroustrup"
 300  * indent-tabs-mode: nil
 301  * End:
 302  * vim: shiftwidth=4 tabstop=8 expandtab
 303  */
 304