1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2013 Index Data
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
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
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
28 #include "relevance.h"
32 #define log2(x) (log(x)/log(2))
37 int *doc_frequency_vec;
38 int *term_frequency_vec_tmp;
41 struct word_entry *entries;
42 pp2_charset_token_t prt;
52 const char *display_str;
55 struct word_entry *next;
58 static struct word_entry *word_entry_match(struct relevance *r,
60 const char *rank, int *weight)
63 struct word_entry *entries = r->entries;
64 for (; entries; entries = entries->next, i++)
66 if (*norm_str && !strcmp(norm_str, entries->norm_str))
70 sscanf(rank, "%d%n", weight, &no_read);
74 if (no_read > 0 && (cp = strchr(rank, ' ')))
76 if ((cp - rank) == strlen(entries->ccl_field) &&
77 memcmp(entries->ccl_field, rank, cp - rank) == 0)
78 *weight = atoi(cp + 1);
86 int relevance_snippet(struct relevance *r,
87 const char *words, const char *name,
93 yaz_log(YLOG_LOG, "relevance_snippet for field=%s content=%s",
96 pp2_charset_token_first(r->prt, words, 0);
98 while ((norm_str = pp2_charset_token_next(r->prt)))
100 size_t org_start, org_len;
101 struct word_entry *entries = r->entries;
105 pp2_get_org(r->prt, &org_start, &org_len);
106 for (; entries; entries = entries->next, i++)
108 yaz_log(YLOG_LOG, "Compare: %s %s", norm_str, entries->norm_str);
109 if (*norm_str && !strcmp(norm_str, entries->norm_str))
113 wrbuf_puts(w_snippet, "<match>");
115 wrbuf_xmlputs_n(w_snippet, words + org_start, org_len);
117 wrbuf_puts(w_snippet, "</match>");
122 yaz_log(YLOG_LOG, "SNIPPET match: %s", wrbuf_cstr(w_snippet));
127 void relevance_countwords(struct relevance *r, struct record_cluster *cluster,
128 const char *words, const char *rank,
131 int *w = r->term_frequency_vec_tmp;
132 const char *norm_str;
134 double lead_decay = r->lead_decay;
135 struct word_entry *e;
136 WRBUF wr = cluster->relevance_explain1;
137 int printed_about_field = 0;
139 pp2_charset_token_first(r->prt, words, 0);
140 for (e = r->entries, i = 1; i < r->vec_len; i++, e = e->next)
147 while ((norm_str = pp2_charset_token_next(r->prt)))
149 int local_weight = 0;
150 e = word_entry_match(r, norm_str, rank, &local_weight);
156 if (!printed_about_field)
158 printed_about_field = 1;
159 wrbuf_printf(wr, "field=%s content=", name);
160 if (strlen(words) > 50)
162 wrbuf_xmlputs_n(wr, words, 49);
163 wrbuf_puts(wr, " ...");
166 wrbuf_xmlputs(wr, words);
167 wrbuf_puts(wr, ";\n");
169 assert(res < r->vec_len);
170 w[res] += local_weight / (1 + log2(1 + lead_decay * length));
171 wrbuf_printf(wr, "%s: w[%d] += w(%d) / "
172 "(1+log2(1+lead_decay(%f) * length(%d)));\n",
173 e->display_str, res, local_weight, lead_decay, length);
175 if (j > 0 && r->term_pos[j])
177 int d = length + 1 - r->term_pos[j];
178 wrbuf_printf(wr, "%s: w[%d] += w[%d](%d) * follow(%f) / "
180 e->display_str, res, res, w[res],
181 r->follow_factor, d);
182 w[res] += w[res] * r->follow_factor / (1 + log2(d));
184 for (j = 0; j < r->vec_len; j++)
185 r->term_pos[j] = j < res ? 0 : length + 1;
190 for (e = r->entries, i = 1; i < r->vec_len; i++, e = e->next)
192 if (length == 0 || w[i] == 0)
194 wrbuf_printf(wr, "%s: tf[%d] += w[%d](%d)", e->display_str, i, i, w[i]);
195 switch (r->length_divide)
198 cluster->term_frequency_vecf[i] += (double) w[i];
201 wrbuf_printf(wr, " / log2(1+length(%d))", length);
202 cluster->term_frequency_vecf[i] +=
203 (double) w[i] / log2(1 + length);
206 wrbuf_printf(wr, " / length(%d)", length);
207 cluster->term_frequency_vecf[i] += (double) w[i] / length;
209 cluster->term_frequency_vec[i] += w[i];
210 wrbuf_printf(wr, " (%f);\n", cluster->term_frequency_vecf[i]);
213 cluster->term_frequency_vec[0] += length;
216 static void pull_terms(struct relevance *res, struct ccl_rpn_node *n)
229 pull_terms(res, n->u.p[0]);
230 pull_terms(res, n->u.p[1]);
233 nmem_strsplit(res->nmem, " ", n->u.t.term, &words, &numwords);
234 for (i = 0; i < numwords; i++)
236 const char *norm_str;
238 ccl_field = nmem_strdup_null(res->nmem, n->u.t.qual);
240 pp2_charset_token_first(res->prt, words[i], 0);
241 while ((norm_str = pp2_charset_token_next(res->prt)))
243 struct word_entry **e = &res->entries;
246 *e = nmem_malloc(res->nmem, sizeof(**e));
247 (*e)->norm_str = nmem_strdup(res->nmem, norm_str);
248 (*e)->ccl_field = ccl_field;
249 (*e)->termno = res->vec_len++;
250 (*e)->display_str = nmem_strdup(res->nmem, words[i]);
259 void relevance_clear(struct relevance *r)
264 for (i = 0; i < r->vec_len; i++)
265 r->doc_frequency_vec[i] = 0;
269 struct relevance *relevance_create_ccl(pp2_charset_fact_t pft,
270 struct ccl_rpn_node *query,
272 double follow_factor, double lead_decay,
275 NMEM nmem = nmem_create();
276 struct relevance *res = nmem_malloc(nmem, sizeof(*res));
281 res->rank_cluster = rank_cluster;
282 res->follow_factor = follow_factor;
283 res->lead_decay = lead_decay;
284 res->length_divide = length_divide;
285 res->prt = pp2_charset_token_create(pft, "relevance");
287 pull_terms(res, query);
289 res->doc_frequency_vec = nmem_malloc(nmem, res->vec_len * sizeof(int));
292 res->term_frequency_vec_tmp =
293 nmem_malloc(res->nmem,
294 res->vec_len * sizeof(*res->term_frequency_vec_tmp));
297 nmem_malloc(res->nmem, res->vec_len * sizeof(*res->term_pos));
299 relevance_clear(res);
303 void relevance_destroy(struct relevance **rp)
307 pp2_charset_token_destroy((*rp)->prt);
308 nmem_destroy((*rp)->nmem);
313 void relevance_newrec(struct relevance *r, struct record_cluster *rec)
315 if (!rec->term_frequency_vec)
319 // term frequency [1,..] . [0] is total length of all fields
320 rec->term_frequency_vec =
322 r->vec_len * sizeof(*rec->term_frequency_vec));
323 for (i = 0; i < r->vec_len; i++)
324 rec->term_frequency_vec[i] = 0;
326 // term frequency divided by length of field [1,...]
327 rec->term_frequency_vecf =
329 r->vec_len * sizeof(*rec->term_frequency_vecf));
330 for (i = 0; i < r->vec_len; i++)
331 rec->term_frequency_vecf[i] = 0.0;
335 void relevance_donerecord(struct relevance *r, struct record_cluster *cluster)
339 for (i = 1; i < r->vec_len; i++)
340 if (cluster->term_frequency_vec[i] > 0)
341 r->doc_frequency_vec[i]++;
343 r->doc_frequency_vec[0]++;
346 // Prepare for a relevance-sorted read
347 void relevance_prepare_read(struct relevance *rel, struct reclist *reclist)
350 float *idfvec = xmalloc(rel->vec_len * sizeof(float));
352 reclist_enter(reclist);
353 // Calculate document frequency vector for each term.
354 for (i = 1; i < rel->vec_len; i++)
356 if (!rel->doc_frequency_vec[i])
360 /* add one to nominator idf(t,D) to ensure a value > 0 */
361 idfvec[i] = log((float) (1 + rel->doc_frequency_vec[0]) /
362 rel->doc_frequency_vec[i]);
365 // Calculate relevance for each document
370 struct word_entry *e = rel->entries;
371 struct record_cluster *rec = reclist_read_record(reclist);
374 w = rec->relevance_explain2;
376 wrbuf_puts(w, "relevance = 0;\n");
377 for (i = 1; i < rel->vec_len; i++)
379 float termfreq = (float) rec->term_frequency_vecf[i];
380 int add = 100000 * termfreq * idfvec[i];
382 wrbuf_printf(w, "idf[%d] = log(((1 + total(%d))/termoccur(%d));\n",
383 i, rel->doc_frequency_vec[0],
384 rel->doc_frequency_vec[i]);
385 wrbuf_printf(w, "%s: relevance += 100000 * tf[%d](%f) * "
386 "idf[%d](%f) (%d);\n",
387 e->display_str, i, termfreq, i, idfvec[i], add);
391 if (!rel->rank_cluster)
393 struct record *record;
394 int cluster_size = 0;
396 for (record = rec->records; record; record = record->next)
399 wrbuf_printf(w, "score = relevance(%d)/cluster_size(%d);\n",
400 relevance, cluster_size);
401 relevance /= cluster_size;
405 wrbuf_printf(w, "score = relevance(%d);\n", relevance);
407 rec->relevance_score = relevance;
409 reclist_leave(reclist);
416 * c-file-style: "Stroustrup"
417 * indent-tabs-mode: nil
419 * vim: shiftwidth=4 tabstop=8 expandtab