Merge branch 'master' of ssh://git.indexdata.com/home/git/pub/pazpar2
[pazpar2-moved-to-github.git] / src / relevance.c
1 /* This file is part of Pazpar2.
2    Copyright (C) 2006-2011 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_relevance_token_t prt;
37     NMEM nmem;
38 };
39
40
41 struct word_entry {
42     const char *norm_str;
43     int termno;
44     struct word_entry *next;
45 };
46
47 static void add_word_entry(NMEM nmem, 
48                            struct word_entry **entries,
49                            const char *norm_str,
50                            int term_no)
51 {
52     struct word_entry *ne = nmem_malloc(nmem, sizeof(*ne));
53     ne->norm_str = nmem_strdup(nmem, norm_str);
54     ne->termno = term_no;
55     
56     ne->next = *entries;
57     *entries = ne;
58 }
59
60
61 int word_entry_match(struct word_entry *entries, const char *norm_str)
62 {
63     for (; entries; entries = entries->next)
64     {
65         if (!strcmp(norm_str, entries->norm_str))
66             return entries->termno;
67     }
68     return 0;
69 }
70
71 static struct word_entry *build_word_entries(pp2_relevance_token_t prt,
72                                              NMEM nmem,
73                                              const char **terms)
74 {
75     int termno = 1; /* >0 signals THERE is an entry */
76     struct word_entry *entries = 0;
77     const char **p = terms;
78
79     for (; *p; p++)
80     {
81         const char *norm_str;
82
83         pp2_relevance_first(prt, *p, 0);
84         while ((norm_str = pp2_relevance_token_next(prt)))
85             add_word_entry(nmem, &entries, norm_str, termno);
86         termno++;
87     }
88     return entries;
89 }
90
91 void relevance_countwords(struct relevance *r, struct record_cluster *cluster,
92                           const char *words, int multiplier, const char *name)
93 {
94     int *mult = cluster->term_frequency_vec_tmp;
95     const char *norm_str;
96     int i, length = 0;
97
98     pp2_relevance_first(r->prt, words, 0);
99     for (i = 1; i < r->vec_len; i++)
100         mult[i] = 0;
101
102     while ((norm_str = pp2_relevance_token_next(r->prt)))
103     {
104         int res = word_entry_match(r->entries, norm_str);
105         if (res)
106         {
107             assert(res < r->vec_len);
108             mult[res] += multiplier;
109         }
110         length++;
111     }
112
113     for (i = 1; i < r->vec_len; i++)
114     {
115         if (length > 0) /* only add if non-empty */
116             cluster->term_frequency_vecf[i] += (double) mult[i] / length;
117         cluster->term_frequency_vec[i] += mult[i];
118     }
119
120     cluster->term_frequency_vec[0] += length;
121 }
122
123 struct relevance *relevance_create(pp2_charset_t pct,
124                                    NMEM nmem, const char **terms)
125 {
126     struct relevance *res = nmem_malloc(nmem, sizeof(struct relevance));
127     const char **p;
128     int i;
129
130     for (p = terms, i = 0; *p; p++, i++)
131         ;
132     res->vec_len = ++i;
133     res->doc_frequency_vec = nmem_malloc(nmem, res->vec_len * sizeof(int));
134     memset(res->doc_frequency_vec, 0, res->vec_len * sizeof(int));
135     res->nmem = nmem;
136     res->prt = pp2_relevance_tokenize(pct);
137     res->entries = build_word_entries(res->prt, nmem, terms);
138     return res;
139 }
140
141 void relevance_destroy(struct relevance **rp)
142 {
143     if (*rp)
144     {
145         pp2_relevance_token_destroy((*rp)->prt);
146         *rp = 0;
147     }
148 }
149
150 void relevance_newrec(struct relevance *r, struct record_cluster *rec)
151 {
152     if (!rec->term_frequency_vec)
153     {
154         int i;
155
156         // term frequency [1,..] . [0] is total length of all fields
157         rec->term_frequency_vec =
158             nmem_malloc(r->nmem,
159                         r->vec_len * sizeof(*rec->term_frequency_vec));
160         for (i = 0; i < r->vec_len; i++)
161             rec->term_frequency_vec[i] = 0;
162         
163         // term frequency divided by length of field [1,...]
164         rec->term_frequency_vecf =
165             nmem_malloc(r->nmem,
166                         r->vec_len * sizeof(*rec->term_frequency_vecf));
167         for (i = 0; i < r->vec_len; i++)
168             rec->term_frequency_vecf[i] = 0.0;
169         
170         // for relevance_countwords (so we don't have to xmalloc/xfree)
171         rec->term_frequency_vec_tmp =
172             nmem_malloc(r->nmem,
173                         r->vec_len * sizeof(*rec->term_frequency_vec_tmp));
174     }
175 }
176
177
178 void relevance_donerecord(struct relevance *r, struct record_cluster *cluster)
179 {
180     int i;
181
182     for (i = 1; i < r->vec_len; i++)
183         if (cluster->term_frequency_vec[i] > 0)
184             r->doc_frequency_vec[i]++;
185
186     r->doc_frequency_vec[0]++;
187 }
188
189 // Prepare for a relevance-sorted read
190 void relevance_prepare_read(struct relevance *rel, struct reclist *reclist)
191 {
192     int i;
193     float *idfvec = xmalloc(rel->vec_len * sizeof(float));
194
195     reclist_enter(reclist);
196     // Calculate document frequency vector for each term.
197     for (i = 1; i < rel->vec_len; i++)
198     {
199         if (!rel->doc_frequency_vec[i])
200             idfvec[i] = 0;
201         else
202         {
203             // This conditional may be terribly wrong
204             // It was there to address the situation where vec[0] == vec[i]
205             // which leads to idfvec[i] == 0... not sure about this
206             // Traditional TF-IDF may assume that a word that occurs in every
207             // record is irrelevant, but this is actually something we will
208             // see a lot
209             if ((idfvec[i] = log((float) rel->doc_frequency_vec[0] /
210                             rel->doc_frequency_vec[i])) < 0.0000001)
211                 idfvec[i] = 1;
212         }
213     }
214     // Calculate relevance for each document
215
216     while (1)
217     {
218         int t;
219         int relevance = 0;
220         struct record_cluster *rec = reclist_read_record(reclist);
221         if (!rec)
222             break;
223         for (t = 1; t < rel->vec_len; t++)
224         {
225             float termfreq;
226 #if 1
227             termfreq = (float) rec->term_frequency_vecf[t];
228 #else
229             if (rec->term_frequency_vec[0])
230             {
231                 termfreq = (float)
232                     rec->term_frequency_vec[t] / rec->term_frequency_vec[0] ;
233             }
234             else
235                 termfreq = 0.0;
236 #endif
237             relevance += 100000 * (termfreq * idfvec[t] + 0.0000005);  
238         }
239         rec->relevance_score = relevance;
240     }
241     reclist_leave(reclist);
242     xfree(idfvec);
243 }
244
245 /*
246  * Local variables:
247  * c-basic-offset: 4
248  * c-file-style: "Stroustrup"
249  * indent-tabs-mode: nil
250  * End:
251  * vim: shiftwidth=4 tabstop=8 expandtab
252  */
253