*** empty log message ***
[bpt/guile.git] / libguile / hash.c
index b902ea1..3d55c69 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995,1996, 1997 Free Software Foundation, Inc.
+/*     Copyright (C) 1995,1996,1997 Free Software Foundation, Inc.
  * 
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * If you write modifications of your own for GUILE, it is your choice
  * whether to permit this exception to apply to your modifications.
  * If you do not wish that, delete this exception notice.  */
+
+/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
+   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
+
 \f
 
 #include <stdio.h>
 #include "_scm.h"
 #include "chars.h"
 
+#include "validate.h"
 #include "hash.h"
 \f
 
@@ -53,36 +58,46 @@ extern double floor();
 
 
 unsigned long
-scm_hasher(obj, n, d)
-     SCM obj;
-     unsigned long n;
-     scm_sizet d;
+scm_hasher(SCM obj, unsigned long n, scm_sizet d)
 {
   switch (7 & (int) obj) {
-  case 2: case 6:              /* SCM_INUMP(obj) */
-    return SCM_INUM(obj) % n;
+  case 2: 
+  case 6:
+    return SCM_INUM(obj) % n;   /* SCM_INUMP(obj) */
   case 4:
-    if SCM_ICHRP(obj)
-      return (unsigned)(scm_downcase(SCM_ICHR(obj))) % n;
+    if SCM_CHARP(obj)
+      return (unsigned)(scm_downcase(SCM_CHAR(obj))) % n;
     switch ((int) obj) {
 #ifndef SICP
-    case (int) SCM_EOL: d = 256; break;
+    case (int) SCM_EOL: 
+      d = 256; 
+      break;
 #endif
-    case (int) SCM_BOOL_T: d = 257; break;
-    case (int) SCM_BOOL_F: d = 258; break;
-    case (int) SCM_EOF_VAL: d = 259; break;
-    default: d = 263;          /* perhaps should be error */
+    case (int) SCM_BOOL_T: 
+      d = 257; 
+      break;
+    case (int) SCM_BOOL_F: 
+      d = 258; 
+      break;
+    case (int) SCM_EOF_VAL: 
+      d = 259; 
+      break;
+    default: 
+      d = 263;         /* perhaps should be error */
     }
     return d % n;
-  default: return 263 % n;     /* perhaps should be error */
+  default: 
+    return 263 % n;    /* perhaps should be error */
   case 0:
     switch SCM_TYP7(obj) {
-    default: return 263 % n;
+    default: 
+      return 263 % n;
     case scm_tc7_smob:
       switch SCM_TYP16(obj) {
       case scm_tcs_bignums:
-      bighash: return SCM_INUM(scm_modulo(obj, SCM_MAKINUM(n)));
-      default: return 263 % n;
+        return SCM_INUM(scm_modulo(obj, SCM_MAKINUM(n)));
+      default: 
+       return 263 % n;
 #ifdef SCM_FLOATS
       case scm_tc16_flo:
        if SCM_REALP(obj) {
@@ -90,7 +105,7 @@ scm_hasher(obj, n, d)
          if (floor(r)==r) {
            obj = scm_inexact_to_exact (obj);
            if SCM_IMP(obj) return SCM_INUM(obj) % n;
-           goto bighash;
+           return SCM_INUM(scm_modulo(obj, SCM_MAKINUM(n)));
          }
        }
        obj = scm_number_to_string(obj, SCM_MAKINUM(10));
@@ -120,12 +135,15 @@ scm_hasher(obj, n, d)
            return h;
          }
       }
-    case scm_tcs_cons_imcar: case scm_tcs_cons_nimcar:
+    case scm_tcs_cons_imcar: 
+    case scm_tcs_cons_nimcar:
       if (d) return (scm_hasher(SCM_CAR(obj), n, d/2)+scm_hasher(SCM_CDR(obj), n, d/2)) % n;
       else return 1;
     case scm_tc7_port:
-      return ((SCM_RDNG & SCM_CAR(obj)) ? 260 : 261) % n;
-    case scm_tcs_closures: case scm_tc7_contin: case scm_tcs_subrs:
+      return ((SCM_RDNG & SCM_UNPACK_CAR(obj)) ? 260 : 261) % n;
+    case scm_tcs_closures: 
+    case scm_tc7_contin: 
+    case scm_tcs_subrs:
       return 262 % n;
     }
   }
@@ -136,77 +154,87 @@ scm_hasher(obj, n, d)
 
 
 unsigned int
-scm_ihashq (obj, n)
-     SCM obj;
-     unsigned int n;
+scm_ihashq (SCM obj, unsigned int n)
 {
   return (((unsigned int) obj) >> 1) % n;
 }
 
 
-SCM_PROC(s_hashq, "hashq", 2, 0, 0, scm_hashq);
-
-SCM
-scm_hashq(obj, n)
-     SCM obj;
-     SCM n;
+SCM_DEFINE (scm_hashq, "hashq", 2, 0, 0,
+           (SCM key, SCM size),
+           "Determine a hash value for KEY that is suitable for lookups in\n"
+           "a hashtable of size SIZE, where eq? is used as the equality\n"
+           "predicate.  The function returns an integer in the range 0 to\n"
+           "SIZE - 1.  NOTE that `hashq' may use internal addresses.\n"
+           "Thus two calls to hashq where the keys are eq? are not\n"
+           "guaranteed to deliver the same value if the key object gets\n"
+           "garbage collected in between.  This can happen, for example\n"
+           "with symbols:  (hashq 'foo n) (gc) (hashq 'foo n) may produce two\n" 
+           "different values, since 'foo will be garbage collected.")
+#define FUNC_NAME s_scm_hashq
 {
-  SCM_ASSERT(SCM_INUMP(n) && 0 <= n, n, SCM_ARG2, s_hashq);
-  return SCM_MAKINUM(scm_ihashq (obj, SCM_INUM (n)));
+  SCM_VALIDATE_INUM_MIN (2, size, 0);
+  return SCM_MAKINUM (scm_ihashq (key, SCM_INUM (size)));
 }
+#undef FUNC_NAME
 
 
 \f
 
 
 unsigned int
-scm_ihashv (obj, n)
-     SCM obj;
-     unsigned int n;
+scm_ihashv (SCM obj, unsigned int n)
 {
-  if (SCM_ICHRP(obj))
-    return ((unsigned int)(scm_downcase(SCM_ICHR(obj)))) % n; /* downcase!?!! */
+  if (SCM_CHARP(obj))
+    return ((unsigned int)(scm_downcase(SCM_CHAR(obj)))) % n; /* downcase!?!! */
 
-  if (SCM_NIMP(obj) && SCM_NUMP(obj))
+  if (SCM_NUMP(obj))
     return (unsigned int) scm_hasher(obj, n, 10);
   else
     return ((unsigned int)obj) % n;
 }
 
 
-SCM_PROC(s_hashv, "hashv", 2, 0, 0, scm_hashv);
-
-SCM
-scm_hashv(obj, n)
-     SCM obj;
-     SCM n;
+SCM_DEFINE (scm_hashv, "hashv", 2, 0, 0,
+           (SCM key, SCM size),
+           "Determine a hash value for KEY that is suitable for lookups in\n"
+           "a hashtable of size SIZE, where eqv? is used as the equality\n"
+           "predicate.  The function returns an integer in the range 0 to\n"
+           "SIZE - 1.  NOTE that (hashv key) may use internal addresses.\n"
+           "Thus two calls to hashv where the keys are eqv? are not\n"
+           "guaranteed to deliver the same value if the key object gets\n"
+           "garbage collected in between.  This can happen, for example\n"
+           "with symbols:  (hashv 'foo n) (gc) (hashv 'foo n) may produce two\n" 
+           "different values, since 'foo will be garbage collected.")
+#define FUNC_NAME s_scm_hashv
 {
-  SCM_ASSERT(SCM_INUMP(n) && 0 <= n, n, SCM_ARG2, s_hashv);
-  return SCM_MAKINUM(scm_ihashv (obj, SCM_INUM (n)));
+  SCM_VALIDATE_INUM_MIN (2, size, 0);
+  return SCM_MAKINUM (scm_ihashv (key, SCM_INUM (size)));
 }
+#undef FUNC_NAME
 
 
 \f
 
 
 unsigned int
-scm_ihash (obj, n)
-     SCM obj;
-     unsigned int n;
+scm_ihash (SCM obj, unsigned int n)
 {
   return (unsigned int)scm_hasher (obj, n, 10);
 }
 
-SCM_PROC(s_hash, "hash", 2, 0, 0, scm_hash);
-
-SCM
-scm_hash(obj, n)
-     SCM obj;
-     SCM n;
+SCM_DEFINE (scm_hash, "hash", 2, 0, 0,
+           (SCM key, SCM size),
+           "Determine a hash value for KEY that is suitable for lookups in\n"
+           "a hashtable of size SIZE, where equal? is used as the equality\n"
+           "predicate.  The function returns an integer in the range 0 to\n"
+           "SIZE - 1.")
+#define FUNC_NAME s_scm_hash
 {
-  SCM_ASSERT(SCM_INUMP(n) && 0 <= n, n, SCM_ARG2, s_hash);
-  return SCM_MAKINUM(scm_ihash(obj, SCM_INUM(n)));
+  SCM_VALIDATE_INUM_MIN (2, size, 0);
+  return SCM_MAKINUM (scm_ihash (key, SCM_INUM (size)));
 }
+#undef FUNC_NAME
 
 
 \f