X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Frelevance.c;h=a002a7b631eec74f076d89b28821febe9e1f8e9c;hb=446f32183265d59ee79e2859376c598fa24408e0;hp=4597c675803a90d32de66d493fa2b62ba644ee5a;hpb=1feb0a041e752e096256750c1ec0e8e00f1c30e5;p=pazpar2-moved-to-github.git

diff --git a/src/relevance.c b/src/relevance.c
index 4597c67..a002a7b 100644
--- a/src/relevance.c
+++ b/src/relevance.c
@@ -1,248 +1,342 @@
-/*
- * $Id: relevance.c,v 1.2 2006-12-20 22:18:33 adam Exp $
- */
+/* This file is part of Pazpar2.
+   Copyright (C) 2006-2012 Index Data
+
+Pazpar2 is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
-#include <ctype.h>
+*/
+
+#if HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include <assert.h>
 #include <math.h>
 #include <stdlib.h>
 
 #include "relevance.h"
-#include "pazpar2.h"
+#include "session.h"
 
 struct relevance
 {
     int *doc_frequency_vec;
+    int *term_frequency_vec_tmp;
     int vec_len;
-    struct word_trie *wt;
+    struct word_entry *entries;
+    pp2_charset_token_t prt;
+    int rank_cluster;
+    int follow_boost;
+    int lead_boost;
+    int length_divide;
     NMEM nmem;
 };
 
-// We use this data structure to recognize terms in input records,
-// and map them to record term vectors for counting.
-struct word_trie
-{
-    struct
-    {
-        struct word_trie *child;
-        int termno;
-    } list[26];
+struct word_entry {
+    const char *norm_str;
+    const char *display_str;
+    int termno;
+    int follow_boost;
+    char *ccl_field;
+    struct word_entry *next;
 };
 
-static struct word_trie *create_word_trie_node(NMEM nmem)
+static int word_entry_match(struct relevance *r, const char *norm_str,
+                            const char *rank, int *mult)
 {
-    struct word_trie *res = nmem_malloc(nmem, sizeof(struct word_trie));
-    int i;
-    for (i = 0; i < 26; i++)
+    int i = 1;
+    struct word_entry *entries = r->entries;
+    for (; entries; entries = entries->next, i++)
     {
-        res->list[i].child = 0;
-        res->list[i].termno = -1;
-    }
-    return res;
-}
-
-static void word_trie_addterm(NMEM nmem, struct word_trie *n, const char *term, int num)
-{
-    while (*term) {
-        int c = tolower(*term);
-        if (c < 'a' || c > 'z')
-            term++;
-        else
+        if (*norm_str && !strcmp(norm_str, entries->norm_str))
         {
-            c -= 'a';
-            if (!*(++term))
-                n->list[c].termno = num;
-            else
+            int extra = r->follow_boost;
+            struct word_entry *e_follow = entries;
+            const char *cp = 0;
+            int no_read = 0;
+            sscanf(rank, "%d%n", mult, &no_read);
+            rank += no_read;
+            while (*rank == ' ')
+                rank++;
+            if (no_read > 0 && (cp = strchr(rank, ' ')))
             {
-                if (!n->list[c].child)
-                {
-                    struct word_trie *new = create_word_trie_node(nmem);
-                    n->list[c].child = new;
-                }
-                word_trie_addterm(nmem, n->list[c].child, term, num);
+                if ((cp - rank) == strlen(entries->ccl_field) &&
+                    memcmp(entries->ccl_field, rank, cp - rank) == 0)
+                    *mult = atoi(cp + 1);
             }
-            break;
+            (*mult) += entries->follow_boost;
+            while ((e_follow = e_follow->next) != 0 && extra > 0)
+            {
+                e_follow->follow_boost = extra--;
+            }
+            return entries->termno;
         }
+        entries->follow_boost = 0;
     }
+    return 0;
 }
 
-#define raw_char(c) (((c) >= 'a' && (c) <= 'z') ? (c) - 'a' : -1)
-
-static int word_trie_match(struct word_trie *t, const char *word, int len, int *skipped)
+void relevance_countwords(struct relevance *r, struct record_cluster *cluster,
+                          const char *words, const char *rank,
+                          const char *name)
 {
-    int c = raw_char(tolower(*word));
+    int *mult = r->term_frequency_vec_tmp;
+    const char *norm_str;
+    int i, length = 0;
+    int lead_mult = r->lead_boost;
+    struct word_entry *e;
+    WRBUF w = cluster->relevance_explain1;
 
-    if (!len)
-        return 0;
+    pp2_charset_token_first(r->prt, words, 0);
+    for (e = r->entries, i = 1; i < r->vec_len; i++, e = e->next)
+    {
+        mult[i] = 0;
+        e->follow_boost = 0;
+    }
 
-    word++; len--;
-    (*skipped)++;
-    if (!len || raw_char(*word) < 0)
+    assert(rank);
+    while ((norm_str = pp2_charset_token_next(r->prt)))
     {
-        if (t->list[c].termno > 0)
-            return t->list[c].termno;
-        else
-            return 0;
+        int local_mult = 0;
+        int res = word_entry_match(r, norm_str, rank, &local_mult);
+        if (res)
+        {
+            assert(res < r->vec_len);
+            mult[res] += local_mult + lead_mult;
+        }
+        if (lead_mult > 0)
+            --lead_mult;
+        length++;
     }
-    else
+
+    for (e = r->entries, i = 1; i < r->vec_len; i++, e = e->next)
     {
-        if (t->list[c].child)
+        if (length == 0 || mult[i] == 0)
+            continue;
+        wrbuf_printf(w, "%s: field=%s vecf[%d] += mult(%d)",
+                     e->display_str, name, i, mult[i]);
+        switch (r->length_divide)
         {
-            return word_trie_match(t->list[c].child, word, len, skipped);
+        case 0:
+            wrbuf_printf(w, ";\n");
+            cluster->term_frequency_vecf[i] += (double) mult[i];
+            break;
+        case 1:
+            wrbuf_printf(w, " / log2(1+length(%d));\n", length);
+            cluster->term_frequency_vecf[i] +=
+                (double) mult[i] / log2(1 + length);
+            break;
+        case 2:
+            wrbuf_printf(w, " / length(%d);\n", length);
+            cluster->term_frequency_vecf[i] += (double) mult[i] / length;
         }
-        else
-            return 0;
+        cluster->term_frequency_vec[i] += mult[i];
     }
 
+    cluster->term_frequency_vec[0] += length;
 }
 
-
-static struct word_trie *build_word_trie(NMEM nmem, const char **terms)
+static void pull_terms(struct relevance *res, struct ccl_rpn_node *n)
 {
-    struct word_trie *res = create_word_trie_node(nmem);
-    const char **p;
+    char **words;
+    int numwords;
+    char *ccl_field;
     int i;
 
-    for (i = 1, p = terms; *p; p++, i++)
-        word_trie_addterm(nmem, res, *p, i);
-    return res;
+    switch (n->kind)
+    {
+    case CCL_RPN_AND:
+    case CCL_RPN_OR:
+    case CCL_RPN_NOT:
+    case CCL_RPN_PROX:
+        pull_terms(res, n->u.p[0]);
+        pull_terms(res, n->u.p[1]);
+        break;
+    case CCL_RPN_TERM:
+        nmem_strsplit(res->nmem, " ", n->u.t.term, &words, &numwords);
+        for (i = 0; i < numwords; i++)
+        {
+            const char *norm_str;
+
+            ccl_field = nmem_strdup_null(res->nmem, n->u.t.qual);
+
+            pp2_charset_token_first(res->prt, words[i], 0);
+            while ((norm_str = pp2_charset_token_next(res->prt)))
+            {
+                struct word_entry **e = &res->entries;
+                while (*e)
+                    e = &(*e)->next;
+                *e = nmem_malloc(res->nmem, sizeof(**e));
+                (*e)->norm_str = nmem_strdup(res->nmem, norm_str);
+                (*e)->ccl_field = ccl_field;
+                (*e)->termno = res->vec_len++;
+                (*e)->display_str = nmem_strdup(res->nmem, words[i]);
+                (*e)->next = 0;
+            }
+        }
+        break;
+    default:
+        break;
+    }
 }
 
-struct relevance *relevance_create(NMEM nmem, const char **terms, int numrecs)
+struct relevance *relevance_create_ccl(pp2_charset_fact_t pft,
+                                       struct ccl_rpn_node *query,
+                                       int rank_cluster,
+                                       int follow_boost, int lead_boost,
+                                       int length_divide)
 {
-    struct relevance *res = nmem_malloc(nmem, sizeof(struct relevance));
-    const char **p;
+    NMEM nmem = nmem_create();
+    struct relevance *res = nmem_malloc(nmem, sizeof(*res));
     int i;
 
-    for (p = terms, i = 0; *p; p++, i++)
-        ;
-    res->vec_len = ++i;
-    res->doc_frequency_vec = nmem_malloc(nmem, res->vec_len * sizeof(int));
-    bzero(res->doc_frequency_vec, res->vec_len * sizeof(int));
     res->nmem = nmem;
-    res->wt = build_word_trie(nmem, terms);
+    res->entries = 0;
+    res->vec_len = 1;
+    res->rank_cluster = rank_cluster;
+    res->follow_boost = follow_boost;
+    res->lead_boost = lead_boost;
+    res->length_divide = length_divide;
+    res->prt = pp2_charset_token_create(pft, "relevance");
+
+    pull_terms(res, query);
+
+    res->doc_frequency_vec = nmem_malloc(nmem, res->vec_len * sizeof(int));
+    for (i = 0; i < res->vec_len; i++)
+        res->doc_frequency_vec[i] = 0;
+
+    // worker array
+    res->term_frequency_vec_tmp =
+        nmem_malloc(res->nmem,
+                    res->vec_len * sizeof(*res->term_frequency_vec_tmp));
     return res;
 }
 
-void relevance_newrec(struct relevance *r, struct record *rec)
+void relevance_destroy(struct relevance **rp)
 {
-    if (!rec->term_frequency_vec)
+    if (*rp)
     {
-        rec->term_frequency_vec = nmem_malloc(r->nmem, r->vec_len * sizeof(int));
-        bzero(rec->term_frequency_vec, r->vec_len * sizeof(int));
+        pp2_charset_token_destroy((*rp)->prt);
+        nmem_destroy((*rp)->nmem);
+        *rp = 0;
     }
 }
 
-
-// FIXME. The definition of a word is crude here.. should support
-// some form of localization mechanism?
-void relevance_countwords(struct relevance *r, struct record *head,
-        const char *words, int len, int multiplier)
+void relevance_newrec(struct relevance *r, struct record_cluster *rec)
 {
-    while (len)
+    if (!rec->term_frequency_vec)
     {
-        char c;
-        int res;
-        int skipped;
-        while (len && (c = raw_char(tolower(*words))) < 0)
-        {
-            words++;
-            len--;
-        }
-        if (!len)
-            return;
-        skipped = 0;
-        if ((res = word_trie_match(r->wt, words, len, &skipped)))
-        {
-            words += skipped;
-            len -= skipped;
-            head->term_frequency_vec[res] += multiplier;
-        }
-        else
-        {
-            while (len && (c = raw_char(tolower(*words))) >= 0)
-            {
-                words++;
-                len--;
-            }
-        }
-        head->term_frequency_vec[0]++;
+        int i;
+
+        // term frequency [1,..] . [0] is total length of all fields
+        rec->term_frequency_vec =
+            nmem_malloc(r->nmem,
+                        r->vec_len * sizeof(*rec->term_frequency_vec));
+        for (i = 0; i < r->vec_len; i++)
+            rec->term_frequency_vec[i] = 0;
+
+        // term frequency divided by length of field [1,...]
+        rec->term_frequency_vecf =
+            nmem_malloc(r->nmem,
+                        r->vec_len * sizeof(*rec->term_frequency_vecf));
+        for (i = 0; i < r->vec_len; i++)
+            rec->term_frequency_vecf[i] = 0.0;
     }
 }
 
-void relevance_donerecord(struct relevance *r, struct record *head)
+void relevance_donerecord(struct relevance *r, struct record_cluster *cluster)
 {
     int i;
 
     for (i = 1; i < r->vec_len; i++)
-        if (head->term_frequency_vec[i] > 0)
+        if (cluster->term_frequency_vec[i] > 0)
             r->doc_frequency_vec[i]++;
 
     r->doc_frequency_vec[0]++;
 }
 
-#ifdef FLOAT_REL
-static int comp(const void *p1, const void *p2)
-{
-    float res;
-    struct record **r1 = (struct record **) p1;
-    struct record **r2 = (struct record **) p2;
-    res = (*r2)->relevance - (*r1)->relevance;
-    if (res > 0)
-        return 1;
-    else if (res < 0)
-        return -1;
-    else
-        return 0;
-}
-#else
-static int comp(const void *p1, const void *p2)
-{
-    struct record **r1 = (struct record **) p1;
-    struct record **r2 = (struct record **) p2;
-    return (*r2)->relevance - (*r1)->relevance;
-}
-#endif
-
-// Prepare for a relevance-sorted read of up to num entries
+// Prepare for a relevance-sorted read
 void relevance_prepare_read(struct relevance *rel, struct reclist *reclist)
 {
     int i;
     float *idfvec = xmalloc(rel->vec_len * sizeof(float));
 
+    reclist_enter(reclist);
     // Calculate document frequency vector for each term.
     for (i = 1; i < rel->vec_len; i++)
     {
         if (!rel->doc_frequency_vec[i])
             idfvec[i] = 0;
         else
-            idfvec[i] = log((float) rel->doc_frequency_vec[0] / rel->doc_frequency_vec[i]);
+        {
+            /* add one to nominator idf(t,D) to ensure a value > 0 */
+            idfvec[i] = log((float) (1 + rel->doc_frequency_vec[0]) /
+                            rel->doc_frequency_vec[i]);
+        }
     }
     // Calculate relevance for each document
-    for (i = 0; i < reclist->num_records; i++)
+    while (1)
     {
-        int t;
-        struct record *rec = reclist->flatlist[i];
-        float relevance;
-        relevance = 0;
-        for (t = 1; t < rel->vec_len; t++)
+        int relevance = 0;
+        WRBUF w;
+        struct word_entry *e = rel->entries;
+        struct record_cluster *rec = reclist_read_record(reclist);
+        if (!rec)
+            break;
+        w = rec->relevance_explain2;
+        wrbuf_rewind(w);
+        for (i = 1; i < rel->vec_len; i++)
         {
-            float termfreq;
-            if (!rec->term_frequency_vec[0])
-                break;
-            termfreq = (float) rec->term_frequency_vec[t] / rec->term_frequency_vec[0];
-            relevance += termfreq * idfvec[t];
+            float termfreq = (float) rec->term_frequency_vecf[i];
+            int add = 100000 * termfreq * idfvec[i];
+
+            wrbuf_printf(w, "idf[%d] = log(((1 + total(%d))/termoccur(%d));\n",
+                         i, rel->doc_frequency_vec[0],
+                         rel->doc_frequency_vec[i]);
+            wrbuf_printf(w, "%s: relevance += 100000 * vecf[%d](%f) * "
+                         "idf[%d](%f) (%d);\n",
+                         e->display_str, i, termfreq, i, idfvec[i], add);
+            relevance += add;
+            e = e->next;
+        }
+        if (!rel->rank_cluster)
+        {
+            struct record *record;
+            int cluster_size = 0;
+
+            for (record = rec->records; record; record = record->next)
+                cluster_size++;
+
+            wrbuf_printf(w, "score = relevance(%d)/cluster_size(%d);\n",
+                         relevance, cluster_size);
+            relevance /= cluster_size;
         }
-        rec->relevance = (int) (relevance * 100000);
+        else
+        {
+            wrbuf_printf(w, "score = relevance(%d);\n", relevance);
+        }
+        rec->relevance_score = relevance;
     }
-    qsort(reclist->flatlist, reclist->num_records, sizeof(struct record*), comp);
-    reclist->pointer = 0;
+    reclist_leave(reclist);
     xfree(idfvec);
 }
 
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab
  */
+