9ad953bdb9e1fc61fe325cebcadb9e8bc67c8954
[pazpar2-moved-to-github.git] / 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     int termno;
44     char *ccl_field;
45     struct word_entry *next;
46 };
47
48 static int word_entry_match(struct word_entry *entries, const char *norm_str,
49                             const char *rank, int *mult)
50 {
51     for (; entries; entries = entries->next)
52     {
53         if (*norm_str && !strcmp(norm_str, entries->norm_str))
54         {
55             const char *cp = 0;
56             int no_read = 0;
57             sscanf(rank, "%d%n", mult, &no_read);
58             rank += no_read;
59             while (*rank == ' ')
60                 rank++;
61             if (no_read > 0 && (cp = strchr(rank, ' ')))
62             {
63                 if ((cp - rank) == strlen(entries->ccl_field) &&
64                     memcmp(entries->ccl_field, rank, cp - rank) == 0)
65                     *mult = atoi(cp + 1);
66             }
67             return entries->termno;
68         }
69     }
70     return 0;
71 }
72
73 void relevance_countwords(struct relevance *r, struct record_cluster *cluster,
74                           const char *words, const char *rank,
75                           const char *name)
76 {
77     int *mult = cluster->term_frequency_vec_tmp;
78     const char *norm_str;
79     int i, length = 0;
80     pp2_charset_token_first(r->prt, words, 0);
81     for (i = 1; i < r->vec_len; i++)
82         mult[i] = 0;
83
84     assert(rank);
85     while ((norm_str = pp2_charset_token_next(r->prt)))
86     {
87         int local_mult = 0;
88         int res = word_entry_match(r->entries, norm_str, rank, &local_mult);
89         if (res)
90         {
91             assert(res < r->vec_len);
92             mult[res] += local_mult;
93         }
94         length++;
95     }
96
97     for (i = 1; i < r->vec_len; i++)
98     {
99         if (length > 0) /* only add if non-empty */
100             cluster->term_frequency_vecf[i] += (double) mult[i] / length;
101         cluster->term_frequency_vec[i] += mult[i];
102     }
103
104     cluster->term_frequency_vec[0] += length;
105 }
106
107 static void pull_terms(struct relevance *res, struct ccl_rpn_node *n)
108 {
109     char **words;
110     int numwords;
111     char *ccl_field;
112     int i;
113
114     switch (n->kind)
115     {
116     case CCL_RPN_AND:
117     case CCL_RPN_OR:
118     case CCL_RPN_NOT:
119     case CCL_RPN_PROX:
120         pull_terms(res, n->u.p[0]);
121         pull_terms(res, n->u.p[1]);
122         break;
123     case CCL_RPN_TERM:
124         nmem_strsplit(res->nmem, " ", n->u.t.term, &words, &numwords);
125         for (i = 0; i < numwords; i++)
126         {
127             const char *norm_str;
128
129             ccl_field = nmem_strdup_null(res->nmem, n->u.t.qual);
130
131             pp2_charset_token_first(res->prt, words[i], 0);
132             while ((norm_str = pp2_charset_token_next(res->prt)))
133             {
134                 struct word_entry **e = &res->entries;
135                 while (*e)
136                     e = &(*e)->next;
137                 *e = nmem_malloc(res->nmem, sizeof(**e));
138                 (*e)->norm_str = nmem_strdup(res->nmem, norm_str);
139                 (*e)->ccl_field = ccl_field;
140                 (*e)->termno = res->vec_len++;
141                 (*e)->next = 0;
142             }
143         }
144         break;
145     default:
146         break;
147     }
148 }
149
150 struct relevance *relevance_create_ccl(pp2_charset_fact_t pft,
151                                        struct ccl_rpn_node *query,
152                                        int rank_cluster)
153 {
154     NMEM nmem = nmem_create();
155     struct relevance *res = nmem_malloc(nmem, sizeof(*res));
156     int i;
157
158     res->nmem = nmem;
159     res->entries = 0;
160     res->vec_len = 1;
161     res->rank_cluster = rank_cluster;
162     res->prt = pp2_charset_token_create(pft, "relevance");
163
164     pull_terms(res, query);
165
166     res->doc_frequency_vec = nmem_malloc(nmem, res->vec_len * sizeof(int));
167     for (i = 0; i < res->vec_len; i++)
168         res->doc_frequency_vec[i] = 0;
169     return res;
170 }
171
172 void relevance_destroy(struct relevance **rp)
173 {
174     if (*rp)
175     {
176         pp2_charset_token_destroy((*rp)->prt);
177         nmem_destroy((*rp)->nmem);
178         *rp = 0;
179     }
180 }
181
182 void relevance_newrec(struct relevance *r, struct record_cluster *rec)
183 {
184     if (!rec->term_frequency_vec)
185     {
186         int i;
187
188         // term frequency [1,..] . [0] is total length of all fields
189         rec->term_frequency_vec =
190             nmem_malloc(r->nmem,
191                         r->vec_len * sizeof(*rec->term_frequency_vec));
192         for (i = 0; i < r->vec_len; i++)
193             rec->term_frequency_vec[i] = 0;
194
195         // term frequency divided by length of field [1,...]
196         rec->term_frequency_vecf =
197             nmem_malloc(r->nmem,
198                         r->vec_len * sizeof(*rec->term_frequency_vecf));
199         for (i = 0; i < r->vec_len; i++)
200             rec->term_frequency_vecf[i] = 0.0;
201
202         // for relevance_countwords (so we don't have to xmalloc/xfree)
203         rec->term_frequency_vec_tmp =
204             nmem_malloc(r->nmem,
205                         r->vec_len * sizeof(*rec->term_frequency_vec_tmp));
206     }
207 }
208
209 void relevance_donerecord(struct relevance *r, struct record_cluster *cluster)
210 {
211     int i;
212
213     for (i = 1; i < r->vec_len; i++)
214         if (cluster->term_frequency_vec[i] > 0)
215             r->doc_frequency_vec[i]++;
216
217     r->doc_frequency_vec[0]++;
218 }
219
220 // Prepare for a relevance-sorted read
221 void relevance_prepare_read(struct relevance *rel, struct reclist *reclist)
222 {
223     int i;
224     float *idfvec = xmalloc(rel->vec_len * sizeof(float));
225
226     reclist_enter(reclist);
227     // Calculate document frequency vector for each term.
228     for (i = 1; i < rel->vec_len; i++)
229     {
230         if (!rel->doc_frequency_vec[i])
231             idfvec[i] = 0;
232         else
233         {
234             /* add one to nominator idf(t,D) to ensure a value > 0 */
235             idfvec[i] = log((float) (1 + rel->doc_frequency_vec[0]) /
236                             rel->doc_frequency_vec[i]);
237         }
238     }
239     // Calculate relevance for each document
240     while (1)
241     {
242         int t;
243         int relevance = 0;
244         struct record_cluster *rec = reclist_read_record(reclist);
245         if (!rec)
246             break;
247         for (t = 1; t < rel->vec_len; t++)
248         {
249             float termfreq = (float) rec->term_frequency_vecf[t];
250             relevance += 100000 * termfreq * idfvec[t];
251         }
252         if (!rel->rank_cluster)
253         {
254             struct record *record;
255             int cluster_size = 0;
256
257             for (record = rec->records; record; record = record->next)
258                 cluster_size++;
259
260             relevance /= cluster_size;
261         }
262         rec->relevance_score = relevance;
263     }
264     reclist_leave(reclist);
265     xfree(idfvec);
266 }
267
268 /*
269  * Local variables:
270  * c-basic-offset: 4
271  * c-file-style: "Stroustrup"
272  * indent-tabs-mode: nil
273  * End:
274  * vim: shiftwidth=4 tabstop=8 expandtab
275  */
276