2 * Copyright (C) 1994-1997, Index Data I/S
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.21 1997-11-18 10:05:08 adam
8 * Changed character map facility so that admin can specify character
9 * mapping files for each register type, w, p, etc.
11 * Revision 1.20 1997/10/31 12:37:55 adam
12 * Code calls xfree() instead of free().
14 * Revision 1.19 1997/10/01 11:44:06 adam
15 * Small improvement of new ranking.
17 * Revision 1.18 1997/09/24 13:36:41 adam
18 * More work on new ranking algorithm.
20 * Revision 1.17 1997/09/22 12:39:07 adam
21 * Added get_pos method for the ranked result sets.
23 * Revision 1.16 1997/09/17 12:19:23 adam
24 * Zebra version corresponds to YAZ version 1.4.
25 * Changed Zebra server so that it doesn't depend on global common_resource.
27 * Revision 1.15 1997/09/09 13:38:16 adam
28 * Partial port to WIN95/NT.
30 * Revision 1.14 1996/11/08 11:15:58 adam
31 * Compressed isam fully supported.
33 * Revision 1.13 1996/10/29 13:55:26 adam
34 * Include of zebrautl.h instead of alexutil.h.
36 * Revision 1.12 1996/10/08 13:00:40 adam
37 * Bug fix: result sets with ranked operands in boolean operations weren't
40 * Revision 1.11 1996/10/07 16:05:29 quinn
43 * Revision 1.9 1995/12/11 09:15:26 adam
44 * New set types: sand/sor/snot - ranked versions of and/or/not in
45 * ranked/semi-ranked result sets.
46 * Note: the snot not finished yet.
47 * New rset member: flag.
48 * Bug fix: r_delete in rsrel.c did free bad memory block.
50 * Revision 1.8 1995/12/05 11:25:45 adam
51 * Doesn't include math.h.
53 * Revision 1.7 1995/10/12 12:41:57 adam
54 * Private info (buf) moved from struct rset_control to struct rset.
55 * Bug fixes in relevance.
57 * Revision 1.6 1995/10/10 14:00:04 adam
58 * Function rset_open changed its wflag parameter to general flags.
60 * Revision 1.5 1995/10/06 14:38:06 adam
61 * New result set method: r_score.
62 * Local no (sysno) and score is transferred to retrieveCtrl.
64 * Revision 1.4 1995/09/14 07:48:56 adam
65 * Other score calculation.
67 * Revision 1.3 1995/09/11 15:23:40 adam
68 * More work on relevance search.
70 * Revision 1.2 1995/09/11 13:09:41 adam
71 * More work on relevance feedback.
73 * Revision 1.1 1995/09/08 14:52:42 adam
74 * Work on relevance feedback.
88 static void *r_create(const struct rset_control *sel, void *parms,
90 static RSFD r_open (RSET ct, int flag);
91 static void r_close (RSFD rfd);
92 static void r_delete (RSET ct);
93 static void r_rewind (RSFD rfd);
94 static int r_count (RSET ct);
95 static int r_read (RSFD rfd, void *buf);
96 static int r_write (RSFD rfd, const void *buf);
97 static int r_score (RSFD rfd, int *score);
99 static const rset_control control =
113 const rset_control *rset_kind_relevance = &control;
115 struct rset_rel_info {
119 int (*cmp)(const void *p1, const void *p2);
120 int (*get_pos)(const void *p);
121 char *key_buf; /* key buffer */
122 float *score_buf; /* score buffer */
123 int *sort_idx; /* score sorted index */
124 int *sysno_idx; /* sysno sorted index (ring buffer) */
125 struct rset_rel_rfd *rfd_list;
128 struct rset_rel_rfd {
132 struct rset_rel_rfd *next;
133 struct rset_rel_info *info;
136 static void add_rec (struct rset_rel_info *info, double score, void *key)
140 for (i = 0; i<info->no_rec; i++)
142 idx = info->sort_idx[i];
143 if (score <= info->score_buf[idx])
146 if (info->no_rec < info->max_rec)
147 { /* there is room for this entry */
148 for (j = info->no_rec; j > i; --j)
149 info->sort_idx[j] = info->sort_idx[j-1];
150 idx = info->sort_idx[j] = info->no_rec;
154 return; /* score too low */
157 idx = info->sort_idx[0]; /* remove this entry */
160 for (j = 0; j < i; ++j) /* make room */
161 info->sort_idx[j] = info->sort_idx[j+1];
162 info->sort_idx[j] = idx; /* allocate sort entry */
164 memcpy (info->key_buf + idx*info->key_size, key, info->key_size);
165 info->score_buf[idx] = score;
169 static struct rset_rel_info *qsort_info;
171 static int qcomp (const void *p1, const void *p2)
176 return qsort_info->cmp (qsort_info->key_buf + i1*qsort_info->key_size,
177 qsort_info->key_buf + i2*qsort_info->key_size);
180 #define NEW_RANKING 0
182 #define SCORE_SHOW 0.0 /* base score for showing up */
183 #define SCORE_COOC 0.3 /* component dependent on co-oc */
184 #define SCORE_DYN (1-(SCORE_SHOW+SCORE_COOC)) /* dynamic component of score */
186 static void relevance (struct rset_rel_info *info, rset_relevance_parms *parms)
197 char *isam_prev_buf = NULL;
200 ISPT *isam_pt = NULL;
201 ISAMC_PP *isamc_pp = NULL;
204 logf (LOG_DEBUG, "relevance");
205 isam_buf = xmalloc (parms->no_isam_positions * sizeof(*isam_buf));
206 isam_r = xmalloc (sizeof (*isam_r) * parms->no_isam_positions);
208 isam_pt = xmalloc (sizeof (*isam_pt) * parms->no_isam_positions);
210 isamc_pp = xmalloc (sizeof (*isamc_pp) * parms->no_isam_positions);
213 logf (LOG_FATAL, "No isamc or isam in rs_rel");
216 isam_tmp_buf = xmalloc (info->key_size);
217 max_tf = xmalloc (sizeof (*max_tf) * parms->no_terms);
218 tf = xmalloc (sizeof (*tf) * parms->no_terms);
220 for (i = 0; i<parms->no_terms; i++)
222 for (i = 0; i<parms->no_isam_positions; i++)
224 isam_buf[i] = xmalloc (info->key_size);
227 isam_pt[i] = is_position (parms->is, parms->isam_positions[i]);
228 max_tf [parms->term_no[i]] = is_numkeys (isam_pt[i]);
229 isam_r[i] = is_readkey (isam_pt[i], isam_buf[i]);
233 isamc_pp[i] = isc_pp_open (parms->isc, parms->isam_positions[i]);
234 max_tf [parms->term_no[i]] = isc_pp_num (isamc_pp[i]);
235 isam_r[i] = isc_pp_read (isamc_pp[i], isam_buf[i]);
237 logf (LOG_DEBUG, "max tf %d = %d", i, max_tf[i]);
244 for (i = 0; i<parms->no_isam_positions; i++)
247 (r = (*parms->cmp)(isam_buf[i], isam_buf[min])) < 1))
251 pos_tf = xmalloc (sizeof(*pos_tf) * parms->no_isam_positions);
252 isam_prev_buf = xmalloc (info->key_size);
253 fact1 = 100000/parms->no_isam_positions;
254 fact2 = 100000/(parms->no_isam_positions*parms->no_isam_positions);
256 no_occur = score_sum = 0;
257 memcpy (isam_prev_buf, isam_buf[min], info->key_size);
258 for (i = 0; i<parms->no_isam_positions; i++)
262 (*parms->cmp)(isam_buf[min], isam_prev_buf) > 1)
264 logf (LOG_LOG, "final occur = %d ratio=%d",
265 no_occur, score_sum / no_occur);
266 add_rec (info, score_sum / (10000.0*no_occur), isam_prev_buf);
269 no_occur = score_sum = 0;
270 memcpy (isam_prev_buf, isam_buf[min], info->key_size);
271 for (i = 0; i<parms->no_isam_positions; i++)
274 pos = (*parms->get_pos)(isam_buf[min]);
275 logf (LOG_LOG, "pos=%d", pos);
276 for (i = 0; i<parms->no_isam_positions; i++)
278 int d = pos - pos_tf[i];
281 if (pos_tf[i] < 0 && i != min)
286 score_sum += fact2 / d;
288 score_sum += fact1 / d;
291 logf (LOG_LOG, "score_sum = %d", score_sum);
294 isam_r[i] = is_readkey (isam_pt[i], isam_buf[i]);
296 isam_r[i] = isc_pp_read (isamc_pp[i], isam_buf[i]);
298 xfree (isam_prev_buf);
305 int co_oc, last_term; /* Number of co-occurrences */
308 /* find min with lowest sysno */
309 for (i = 0; i<parms->no_isam_positions; i++)
312 (min < 0 || (r = (*parms->cmp)(isam_buf[i], isam_buf[min])) < 2))
317 else if (!r && last_term != parms->term_no[i]) /* new occurrence */
319 last_term = parms->term_no[i];
324 memcpy (isam_tmp_buf, isam_buf[min], info->key_size);
325 /* calculate for all with those sysno */
326 for (i = 0; i < parms->no_terms; i++)
328 for (i = 0; i<parms->no_isam_positions; i++)
333 r = (*parms->cmp)(isam_buf[i], isam_tmp_buf);
336 if (r <= 1 && r >= -1)
340 tf[parms->term_no[i]]++;
342 isam_r[i] = is_readkey (isam_pt[i], isam_buf[i]);
344 isam_r[i] = isc_pp_read (isamc_pp[i], isam_buf[i]);
345 } while (isam_r[i] &&
346 (*parms->cmp)(isam_buf[i], isam_tmp_buf) <= 1);
349 /* calculate relevance value */
351 for (i = 0; i<parms->no_terms; i++)
353 score += SCORE_SHOW + SCORE_COOC*co_oc/parms->no_terms +
354 SCORE_DYN*tf[i]/max_tf[i];
355 /* if value is in the top score, then save it - don't emit yet */
356 add_rec (info, score/parms->no_terms, isam_tmp_buf);
359 for (i = 0; i<info->no_rec; i++)
360 info->sysno_idx[i] = i;
362 qsort (info->sysno_idx, info->no_rec, sizeof(*info->sysno_idx), qcomp);
363 for (i = 0; i<parms->no_isam_positions; i++)
366 is_pt_free (isam_pt[i]);
368 isc_pp_close (isamc_pp[i]);
372 xfree (isam_tmp_buf);
380 static void *r_create (const struct rset_control *sel, void *parms,
383 rset_relevance_parms *r_parms = parms;
384 struct rset_rel_info *info;
386 *flags |= RSET_FLAG_RANKED;
387 info = xmalloc (sizeof(struct rset_rel_info));
388 info->key_size = r_parms->key_size;
389 assert (info->key_size > 1);
390 info->max_rec = r_parms->max_rec;
391 assert (info->max_rec > 1);
392 info->cmp = r_parms->cmp;
393 info->get_pos = r_parms->get_pos;
395 info->key_buf = xmalloc (info->key_size * info->max_rec);
396 info->score_buf = xmalloc (sizeof(*info->score_buf) * info->max_rec);
397 info->sort_idx = xmalloc (sizeof(*info->sort_idx) * info->max_rec);
398 info->sysno_idx = xmalloc (sizeof(*info->sysno_idx) * info->max_rec);
400 info->rfd_list = NULL;
402 relevance (info, r_parms);
406 static RSFD r_open (RSET ct, int flag)
408 struct rset_rel_rfd *rfd;
409 struct rset_rel_info *info = ct->buf;
411 if (flag & RSETF_WRITE)
413 logf (LOG_FATAL, "relevance set type is read-only");
416 rfd = xmalloc (sizeof(*rfd));
418 rfd->next = info->rfd_list;
420 info->rfd_list = rfd;
425 static void r_close (RSFD rfd)
427 struct rset_rel_info *info = ((struct rset_rel_rfd*)rfd)->info;
428 struct rset_rel_rfd **rfdp;
430 for (rfdp = &info->rfd_list; *rfdp; rfdp = &(*rfdp)->next)
433 *rfdp = (*rfdp)->next;
437 logf (LOG_FATAL, "r_close but no rfd match!");
441 static void r_delete (RSET ct)
443 struct rset_rel_info *info = ct->buf;
445 assert (info->rfd_list == NULL);
446 xfree (info->key_buf);
447 xfree (info->score_buf);
448 xfree (info->sort_idx);
449 xfree (info->sysno_idx);
453 static void r_rewind (RSFD rfd)
455 struct rset_rel_rfd *p = rfd;
456 struct rset_rel_info *info = p->info;
458 if (p->flag & RSETF_SORT_RANK)
459 p->position = info->no_rec;
464 static int r_count (RSET ct)
466 struct rset_rel_info *info = ct->buf;
471 static int r_read (RSFD rfd, void *buf)
473 struct rset_rel_rfd *p = rfd;
474 struct rset_rel_info *info = p->info;
476 if (p->flag & RSETF_SORT_RANK)
478 if (p->position <= 0)
481 p->last_read_pos = info->sort_idx[p->position];
485 if (p->position == info->no_rec)
487 p->last_read_pos = info->sysno_idx[p->position];
491 info->key_buf + info->key_size * p->last_read_pos,
496 static int r_score (RSFD rfd, int *score)
498 struct rset_rel_rfd *p = rfd;
499 struct rset_rel_info *info = p->info;
501 *score = (int) (1000*info->score_buf[p->last_read_pos]);
505 static int r_write (RSFD rfd, const void *buf)
507 logf (LOG_FATAL, "relevance set type is read-only");