rset/rsprox.c

   1 /* $Id: rsprox.c,v 1.27 2005-04-26 10:09:38 adam Exp $
   2    Copyright (C) 1995-2005
   3    Index Data ApS
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
  19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.
  21 */
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <assert.h>
  27
  28 #include <idzebra/util.h>
  29 #include <rset.h>
  30
  31 #ifndef RSET_DEBUG
  32 #define RSET_DEBUG 0
  33 #endif
  34
  35 static RSFD r_open (RSET ct, int flag);
  36 static void r_close (RSFD rfd);
  37 static void r_delete (RSET ct);
  38 static int r_forward(RSFD rfd, void *buf, TERMID *term, const void *untilbuf);
  39 static int r_read (RSFD rfd, void *buf, TERMID *term);
  40 static int r_write (RSFD rfd, const void *buf);
  41 static void r_pos (RSFD rfd, double *current, double *total);
  42 static void r_get_terms(RSET ct, TERMID *terms, int maxterms, int *curterm);
  43
  44 static const struct rset_control control =
  45 {
  46     "prox",
  47     r_delete,
  48     r_get_terms,
  49     r_open,
  50     r_close,
  51     r_forward,
  52     r_pos,
  53     r_read,
  54     r_write,
  55 };
  56
  57 struct rset_prox_info {
  58     RSET *rset;   /* array of 'child' rsets */
  59     int rset_no;  /* how many of them */
  60     int ordered;
  61     int exclusion;
  62     int relation;
  63     int distance;
  64 };
  65
  66 struct rset_prox_rfd {
  67     RSFD *rfd;
  68     char **buf;  /* lookahead key buffers */
  69     char *more;  /* more in each lookahead? */
  70     TERMID *terms; /* lookahead terms */
  71     zint hits;
  72 };
  73
  74
  75 RSET rsprox_create( NMEM nmem, const struct key_control *kcontrol, int scope,
  76                     int rset_no, RSET *rset,
  77                     int ordered, int exclusion,
  78                     int relation, int distance)
  79 {
  80     RSET rnew = rset_create_base(&control, nmem, kcontrol, scope,0);
  81     struct rset_prox_info *info;
  82     info = (struct rset_prox_info *) nmem_malloc(rnew->nmem,sizeof(*info));
  83     info->rset = nmem_malloc(rnew->nmem,rset_no * sizeof(*info->rset));
  84     memcpy(info->rset, rset,
  85            rset_no * sizeof(*info->rset));
  86     info->rset_no = rset_no;
  87     info->ordered = ordered;
  88     info->exclusion = exclusion;
  89     info->relation = relation;
  90     info->distance = distance;
  91     rnew->priv = info;
  92     return rnew;
  93 }
  94
  95 static void r_delete (RSET ct)
  96 {
  97     struct rset_prox_info *info = (struct rset_prox_info *) ct->priv;
  98     int i;
  99
 100     for (i = 0; i<info->rset_no; i++)
 101         rset_delete(info->rset[i]);
 102 }
 103
 104 static RSFD r_open (RSET ct, int flag)
 105 {
 106     struct rset_prox_info *info = (struct rset_prox_info *) ct->priv;
 107     RSFD rfd;
 108     struct rset_prox_rfd *p;
 109     int i;
 110
 111     if (flag & RSETF_WRITE)
 112     {
 113         yaz_log(YLOG_FATAL, "prox set type is read-only");
 114         return NULL;
 115     }
 116     rfd = rfd_create_base(ct);
 117     if (rfd->priv)
 118         p=(struct rset_prox_rfd *)(rfd->priv);
 119     else {
 120         p = (struct rset_prox_rfd *) nmem_malloc(ct->nmem,sizeof(*p));
 121         rfd->priv = p;
 122         p->more = nmem_malloc (ct->nmem,sizeof(*p->more) * info->rset_no);
 123         p->buf = nmem_malloc(ct->nmem,sizeof(*p->buf) * info->rset_no);
 124         p->terms = nmem_malloc(ct->nmem,sizeof(*p->terms) * info->rset_no);
 125         for (i = 0; i < info->rset_no; i++)
 126         {
 127             p->buf[i] = nmem_malloc(ct->nmem,ct->keycontrol->key_size);
 128             p->terms[i] = 0;
 129         }
 130         p->rfd = nmem_malloc(ct->nmem,sizeof(*p->rfd) * info->rset_no);
 131     }
 132     yaz_log(YLOG_DEBUG,"rsprox (%s) open [%p] n=%d",
 133             ct->control->desc, rfd, info->rset_no);
 134
 135     for (i = 0; i < info->rset_no; i++) {
 136         p->rfd[i] = rset_open (info->rset[i], RSETF_READ);
 137         p->more[i] = rset_read (p->rfd[i], p->buf[i], &p->terms[i]);
 138     }
 139     p->hits = 0;
 140     return rfd;
 141 }
 142
 143 static void r_close (RSFD rfd)
 144 {
 145     struct rset_prox_info *info = (struct rset_prox_info *)(rfd->rset->priv);
 146     struct rset_prox_rfd *p=(struct rset_prox_rfd *)(rfd->priv);
 147
 148     int i;
 149     for (i = 0; i<info->rset_no; i++)
 150         rset_close (p->rfd[i]);
 151     rfd_delete_base(rfd);
 152 }
 153
 154 static int r_forward (RSFD rfd, void *buf, TERMID *term, const void *untilbuf)
 155 {
 156     struct rset_prox_info *info = (struct rset_prox_info *)(rfd->rset->priv);
 157     struct rset_prox_rfd *p=(struct rset_prox_rfd *)(rfd->priv);
 158     const struct key_control *kctrl = rfd->rset->keycontrol;
 159     int cmp = 0;
 160     int i;
 161
 162     if (untilbuf)
 163     {
 164         /* it is enough to forward first one. Other will follow. */
 165         if ( p->more[0] &&   /* was: cmp >=2 */
 166            ((kctrl->cmp)(untilbuf, p->buf[0]) >= rfd->rset->scope) )
 167             p->more[0] = rset_forward(p->rfd[0], p->buf[0],
 168                                       &p->terms[0], untilbuf);
 169     }
 170     if (info->ordered && info->relation == 3 && info->exclusion == 0
 171         && info->distance == 1)
 172     {
 173         while (p->more[0])
 174         {
 175             for (i = 1; i < info->rset_no; i++)
 176             {
 177                 if (!p->more[i])
 178                 {
 179                     p->more[0] = 0; /* saves us a goto out of while loop. */
 180                     break;
 181                 }
 182                 cmp = (*kctrl->cmp) (p->buf[i], p->buf[i-1]);
 183                 if (cmp >= rfd->rset->scope )  /* cmp>1 */
 184                 {
 185                     p->more[i-1] = rset_forward (p->rfd[i-1],
 186                                                  p->buf[i-1],
 187                                                  &p->terms[i-1],
 188                                                  p->buf[i]);
 189                     break;
 190                 }
 191                 else if ( cmp>0 ) /* cmp == 1*/
 192                 {
 193                     if ((*kctrl->getseq)(p->buf[i-1]) +1 !=
 194                         (*kctrl->getseq)(p->buf[i]))
 195                     { /* FIXME - We need more flexible multilevel stuff */
 196                         p->more[i-1] = rset_read ( p->rfd[i-1], p->buf[i-1],
 197                                                    &p->terms[i-1]);
 198                         break;
 199                     }
 200                 }
 201                 else
 202                 {
 203                     p->more[i] = rset_forward (p->rfd[i],
 204                                   p->buf[i], &p->terms[i], p->buf[i-1]);
 205                     break;
 206                 }
 207             }
 208             if (i == info->rset_no)
 209             {
 210                 memcpy (buf, p->buf[0], kctrl->key_size);
 211                 if (term)
 212                     *term = p->terms[0];
 213                 p->more[0] = rset_read (p->rfd[0], p->buf[0], &p->terms[0]);
 214                 p->hits++;
 215                 return 1;
 216             }
 217         }
 218     }
 219     else if (info->rset_no == 2)
 220     {
 221         while (p->more[0] && p->more[1])
 222         {
 223             int cmp = (*kctrl->cmp)(p->buf[0], p->buf[1]);
 224             if ( cmp <= - rfd->rset->scope) /* cmp<-1*/
 225                 p->more[0] = rset_forward (p->rfd[0], p->buf[0],
 226                                            &p->terms[0],p->buf[1]);
 227             else if ( cmp >= rfd->rset->scope ) /* cmp>1 */
 228                 p->more[1] = rset_forward (p->rfd[1], p->buf[1],
 229                                            &p->terms[1],p->buf[0]);
 230             else
 231             {
 232                 zint seqno[500]; /* FIXME - why 500 ?? */
 233                 int n = 0;
 234
 235                 seqno[n++] = (*kctrl->getseq)(p->buf[0]);
 236                 while ((p->more[0] = rset_read (p->rfd[0],
 237                                         p->buf[0], &p->terms[0])) >= -1 &&
 238                        p->more[0] <= -1)
 239                     if (n < 500)
 240                         seqno[n++] = (*kctrl->getseq)(p->buf[0]);
 241
 242                 for (i = 0; i<n; i++)
 243                 {
 244                     zint diff = (*kctrl->getseq)(p->buf[1]) - seqno[i];
 245                     int excl = info->exclusion;
 246                     if (!info->ordered && diff < 0)
 247                         diff = -diff;
 248                     switch (info->relation)
 249                     {
 250                     case 1:      /* < */
 251                         if (diff < info->distance && diff >= 0)
 252                             excl = !excl;
 253                         break;
 254                     case 2:      /* <= */
 255                         if (diff <= info->distance && diff >= 0)
 256                             excl = !excl;
 257                         break;
 258                     case 3:      /* == */
 259                         if (diff == info->distance && diff >= 0)
 260                             excl = !excl;
 261                         break;
 262                     case 4:      /* >= */
 263                         if (diff >= info->distance && diff >= 0)
 264                             excl = !excl;
 265                         break;
 266                     case 5:      /* > */
 267                         if (diff > info->distance && diff >= 0)
 268                             excl = !excl;
 269                         break;
 270                     case 6:      /* != */
 271                         if (diff != info->distance && diff >= 0)
 272                             excl = !excl;
 273                         break;
 274                     }
 275                     if (excl)
 276                     {
 277                         memcpy (buf, p->buf[1], kctrl->key_size);
 278                         if (term)
 279                             *term = p->terms[1];
 280                         p->more[1] = rset_read ( p->rfd[1], p->buf[1],
 281                                                  &p->terms[1]);
 282                         p->hits++;
 283                         return 1;
 284                     }
 285                 }
 286                 p->more[1] = rset_read (p->rfd[1], p->buf[1], &p->terms[1]);
 287             }
 288         }
 289     }
 290     return 0;
 291 }
 292
 293
 294 static int r_read (RSFD rfd, void *buf, TERMID *term)
 295 {
 296     return r_forward(rfd, buf, term, 0);
 297 }
 298
 299 static int r_write (RSFD rfd, const void *buf)
 300 {
 301     yaz_log(YLOG_FATAL, "prox set type is read-only");
 302     return -1;
 303 }
 304
 305 static void r_pos (RSFD rfd, double *current, double *total)
 306 {
 307     struct rset_prox_info *info = (struct rset_prox_info *)(rfd->rset->priv);
 308     struct rset_prox_rfd *p = (struct rset_prox_rfd *)(rfd->priv);
 309     int i;
 310     double r = 0.0;
 311     double cur, tot = -1.0;
 312     double scur = 0.0, stot = 0.0;
 313
 314     yaz_log(YLOG_DEBUG, "rsprox_pos");
 315
 316     for (i = 0; i < info->rset_no; i++)
 317     {
 318         rset_pos(p->rfd[i],  &cur, &tot);
 319         if (tot>0) {
 320             scur += cur;
 321             stot += tot;
 322         }
 323     }
 324     if (tot <0) {  /* nothing found */
 325         *current = -1;
 326         *total = -1;
 327     } else if (tot < 1) { /* most likely tot==0 */
 328         *current = 0;
 329         *total = 0;
 330     } else {
 331         r = scur/stot;
 332         *current = (double) p->hits;
 333         *total=*current/r ;
 334     }
 335     yaz_log(YLOG_DEBUG,"prox_pos: [%d] %0.1f/%0.1f= %0.4f ",
 336                     i,*current, *total, r);
 337 }
 338
 339
 340
 341 static void r_get_terms(RSET ct, TERMID *terms, int maxterms, int *curterm)
 342 {
 343     struct rset_prox_info *info =
 344               (struct rset_prox_info *) ct->priv;
 345     int i;
 346     for (i = 0; i<info->rset_no; i++)
 347         rset_getterms(info->rset[i], terms, maxterms, curterm);
 348 }
 349