2 * Copyright (C) 1994-1995, Index Data I/S
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.14 1996-11-08 11:15:58 adam
8 * Compressed isam fully supported.
10 * Revision 1.13 1996/10/29 13:55:26 adam
11 * Include of zebrautl.h instead of alexutil.h.
13 * Revision 1.12 1996/10/08 13:00:40 adam
14 * Bug fix: result sets with ranked operands in boolean operations weren't
17 * Revision 1.11 1996/10/07 16:05:29 quinn
20 * Revision 1.9 1995/12/11 09:15:26 adam
21 * New set types: sand/sor/snot - ranked versions of and/or/not in
22 * ranked/semi-ranked result sets.
23 * Note: the snot not finished yet.
24 * New rset member: flag.
25 * Bug fix: r_delete in rsrel.c did free bad memory block.
27 * Revision 1.8 1995/12/05 11:25:45 adam
28 * Doesn't include math.h.
30 * Revision 1.7 1995/10/12 12:41:57 adam
31 * Private info (buf) moved from struct rset_control to struct rset.
32 * Bug fixes in relevance.
34 * Revision 1.6 1995/10/10 14:00:04 adam
35 * Function rset_open changed its wflag parameter to general flags.
37 * Revision 1.5 1995/10/06 14:38:06 adam
38 * New result set method: r_score.
39 * Local no (sysno) and score is transferred to retrieveCtrl.
41 * Revision 1.4 1995/09/14 07:48:56 adam
42 * Other score calculation.
44 * Revision 1.3 1995/09/11 15:23:40 adam
45 * More work on relevance search.
47 * Revision 1.2 1995/09/11 13:09:41 adam
48 * More work on relevance feedback.
50 * Revision 1.1 1995/09/08 14:52:42 adam
51 * Work on relevance feedback.
64 static void *r_create(const struct rset_control *sel, void *parms,
66 static RSFD r_open (RSET ct, int flag);
67 static void r_close (RSFD rfd);
68 static void r_delete (RSET ct);
69 static void r_rewind (RSFD rfd);
70 static int r_count (RSET ct);
71 static int r_read (RSFD rfd, void *buf);
72 static int r_write (RSFD rfd, const void *buf);
73 static int r_score (RSFD rfd, int *score);
75 static const rset_control control =
89 const rset_control *rset_kind_relevance = &control;
91 struct rset_rel_info {
95 int (*cmp)(const void *p1, const void *p2);
96 char *key_buf; /* key buffer */
97 float *score_buf; /* score buffer */
98 int *sort_idx; /* score sorted index */
99 int *sysno_idx; /* sysno sorted index (ring buffer) */
100 struct rset_rel_rfd *rfd_list;
103 struct rset_rel_rfd {
107 struct rset_rel_rfd *next;
108 struct rset_rel_info *info;
111 static void add_rec (struct rset_rel_info *info, double score, void *key)
115 for (i = 0; i<info->no_rec; i++)
117 idx = info->sort_idx[i];
118 if (score <= info->score_buf[idx])
121 if (info->no_rec < info->max_rec)
122 { /* there is room for this entry */
123 for (j = info->no_rec; j > i; --j)
124 info->sort_idx[j] = info->sort_idx[j-1];
125 idx = info->sort_idx[j] = info->no_rec;
129 return; /* score too low */
132 idx = info->sort_idx[0]; /* remove this entry */
135 for (j = 0; j < i; ++j) /* make room */
136 info->sort_idx[j] = info->sort_idx[j+1];
137 info->sort_idx[j] = idx; /* allocate sort entry */
139 memcpy (info->key_buf + idx*info->key_size, key, info->key_size);
140 info->score_buf[idx] = score;
144 static struct rset_rel_info *qsort_info;
146 static int qcomp (const void *p1, const void *p2)
151 return qsort_info->cmp (qsort_info->key_buf + i1*qsort_info->key_size,
152 qsort_info->key_buf + i2*qsort_info->key_size);
155 #define SCORE_SHOW 0.0 /* base score for showing up */
156 #define SCORE_COOC 0.3 /* component dependent on co-oc */
157 #define SCORE_DYN (1-(SCORE_SHOW+SCORE_COOC)) /* dynamic component of score */
159 static void relevance (struct rset_rel_info *info, rset_relevance_parms *parms)
165 ISPT *isam_pt = NULL;
166 ISAMC_PP *isamc_pp = NULL;
169 logf (LOG_DEBUG, "relevance");
170 isam_buf = xmalloc (parms->no_isam_positions * sizeof(*isam_buf));
171 isam_r = xmalloc (sizeof (*isam_r) * parms->no_isam_positions);
173 isam_pt = xmalloc (sizeof (*isam_pt) * parms->no_isam_positions);
175 isamc_pp = xmalloc (sizeof (*isamc_pp) * parms->no_isam_positions);
178 logf (LOG_FATAL, "No isamc or isam in rs_rel");
181 isam_tmp_buf = xmalloc (info->key_size);
182 max_tf = xmalloc (sizeof (*max_tf) * parms->no_terms);
183 tf = xmalloc (sizeof (*tf) * parms->no_terms);
185 for (i = 0; i<parms->no_terms; i++)
187 for (i = 0; i<parms->no_isam_positions; i++)
189 isam_buf[i] = xmalloc (info->key_size);
192 isam_pt[i] = is_position (parms->is, parms->isam_positions[i]);
193 max_tf [parms->term_no[i]] = is_numkeys (isam_pt[i]);
194 isam_r[i] = is_readkey (isam_pt[i], isam_buf[i]);
198 isamc_pp[i] = isc_pp_open (parms->isc, parms->isam_positions[i]);
199 max_tf [parms->term_no[i]] = isc_pp_num (isamc_pp[i]);
200 isam_r[i] = isc_pp_read (isamc_pp[i], isam_buf[i]);
202 logf (LOG_DEBUG, "max tf %d = %d", i, max_tf[i]);
208 int co_oc, last_term; /* Number of co-occurrences */
211 /* find min with lowest sysno */
212 for (i = 0; i<parms->no_isam_positions; i++)
215 (min < 0 || (r = (*parms->cmp)(isam_buf[i], isam_buf[min])) < 2))
220 else if (!r && last_term != parms->term_no[i]) /* new occurrence */
222 last_term = parms->term_no[i];
227 memcpy (isam_tmp_buf, isam_buf[min], info->key_size);
228 /* calculate for all with those sysno */
229 for (i = 0; i < parms->no_terms; i++)
231 for (i = 0; i<parms->no_isam_positions; i++)
236 r = (*parms->cmp)(isam_buf[i], isam_tmp_buf);
239 if (r <= 1 && r >= -1)
243 tf[parms->term_no[i]]++;
245 isam_r[i] = is_readkey (isam_pt[i], isam_buf[i]);
247 isam_r[i] = isc_pp_read (isamc_pp[i], isam_buf[i]);
248 } while (isam_r[i] &&
249 (*parms->cmp)(isam_buf[i], isam_tmp_buf) <= 1);
252 /* calculate relevance value */
254 for (i = 0; i<parms->no_terms; i++)
256 score += SCORE_SHOW + SCORE_COOC*co_oc/parms->no_terms +
257 SCORE_DYN*tf[i]/max_tf[i];
258 /* if value is in the top score, then save it - don't emit yet */
259 add_rec (info, score/parms->no_terms, isam_tmp_buf);
261 for (i = 0; i<info->no_rec; i++)
262 info->sysno_idx[i] = i;
264 qsort (info->sysno_idx, info->no_rec, sizeof(*info->sysno_idx), qcomp);
265 for (i = 0; i<parms->no_isam_positions; i++)
268 is_pt_free (isam_pt[i]);
270 isc_pp_close (isamc_pp[i]);
274 xfree (isam_tmp_buf);
282 static void *r_create (const struct rset_control *sel, void *parms,
285 rset_relevance_parms *r_parms = parms;
286 struct rset_rel_info *info;
288 *flags |= RSET_FLAG_RANKED;
289 info = xmalloc (sizeof(struct rset_rel_info));
290 info->key_size = r_parms->key_size;
291 assert (info->key_size > 1);
292 info->max_rec = r_parms->max_rec;
293 assert (info->max_rec > 1);
294 info->cmp = r_parms->cmp;
296 info->key_buf = xmalloc (info->key_size * info->max_rec);
297 info->score_buf = xmalloc (sizeof(*info->score_buf) * info->max_rec);
298 info->sort_idx = xmalloc (sizeof(*info->sort_idx) * info->max_rec);
299 info->sysno_idx = xmalloc (sizeof(*info->sysno_idx) * info->max_rec);
301 info->rfd_list = NULL;
303 relevance (info, r_parms);
307 static RSFD r_open (RSET ct, int flag)
309 struct rset_rel_rfd *rfd;
310 struct rset_rel_info *info = ct->buf;
312 if (flag & RSETF_WRITE)
314 logf (LOG_FATAL, "relevance set type is read-only");
317 rfd = xmalloc (sizeof(*rfd));
319 rfd->next = info->rfd_list;
321 info->rfd_list = rfd;
326 static void r_close (RSFD rfd)
328 struct rset_rel_info *info = ((struct rset_rel_rfd*)rfd)->info;
329 struct rset_rel_rfd **rfdp;
331 for (rfdp = &info->rfd_list; *rfdp; rfdp = &(*rfdp)->next)
334 *rfdp = (*rfdp)->next;
338 logf (LOG_FATAL, "r_close but no rfd match!");
342 static void r_delete (RSET ct)
344 struct rset_rel_info *info = ct->buf;
346 assert (info->rfd_list == NULL);
347 xfree (info->key_buf);
348 xfree (info->score_buf);
349 xfree (info->sort_idx);
350 xfree (info->sysno_idx);
354 static void r_rewind (RSFD rfd)
356 struct rset_rel_rfd *p = rfd;
357 struct rset_rel_info *info = p->info;
359 if (p->flag & RSETF_SORT_RANK)
360 p->position = info->no_rec;
365 static int r_count (RSET ct)
367 struct rset_rel_info *info = ct->buf;
372 static int r_read (RSFD rfd, void *buf)
374 struct rset_rel_rfd *p = rfd;
375 struct rset_rel_info *info = p->info;
377 if (p->flag & RSETF_SORT_RANK)
379 if (p->position <= 0)
382 p->last_read_pos = info->sort_idx[p->position];
386 if (p->position == info->no_rec)
388 p->last_read_pos = info->sysno_idx[p->position];
392 info->key_buf + info->key_size * p->last_read_pos,
397 static int r_score (RSFD rfd, int *score)
399 struct rset_rel_rfd *p = rfd;
400 struct rset_rel_info *info = p->info;
402 *score = (int) (1000*info->score_buf[p->last_read_pos]);
406 static int r_write (RSFD rfd, const void *buf)
408 logf (LOG_FATAL, "relevance set type is read-only");