summaryrefslogtreecommitdiff
path: root/libguile/hash.c
diff options
context:
space:
mode:
authorMartin Grabmüller <mgrabmue@cs.tu-berlin.de>2001-03-16 10:00:17 +0000
committerMartin Grabmüller <mgrabmue@cs.tu-berlin.de>2001-03-16 10:00:17 +0000
commit5352393c556ff4e4be85cacf4b6dd32e93b24bce (patch)
tree5a0ddf5e9148dc856087dfe06ae0fad1e887c029 /libguile/hash.c
parent1543613f4bb8576a9630c724b0c896355171322b (diff)
downloadguile-5352393c556ff4e4be85cacf4b6dd32e93b24bce.tar.gz
* list.c (scm_list, scm_cons_star, scm_null_p, scm_list_p),
(scm_length, scm_append, scm_reverse, scm_list_ref), (scm_memq, scm_memv, scm_member, scm_delv_x, scm_delete_x), (scm_delq, scm_delv, scm_delete, scm_delq1_x, scm_delv1_x), (scm_delete1_x), gc.c (scm_map_free_list), (scm_free_list_length), hash.c (scm_hashq, scm_hashv), (scm_hash), hashtab.c (scm_hashq_ref, scm_hashq_set_x), (scm_hashq_remove_x, scm_hashv_ref, scm_hashv_set_x), (scm_hashv_remove_x, scm_hash_ref, scm_hash_set_x), (scm_hash_remove_x), ports.c (scm_pt_size, scm_pt_member), print.c (scm_current_pstate), scmsigs.c (scm_usleep), goops.c (scm_get_keyword, scm_sys_compute_slots): Added texinfo markup. * weaks.c (scm_weak_vector_p, scm_weak_key_hash_table_p), (scm_weak_value_hash_table_p, scm_doubly_weak_hash_table_p), rdelim.c (scm_read_delimited_x), strop.c (scm_string_index), symbols.c (scm_symbol_interned_p), numbers.c (scm_string_to_number), ports.c (scm_port_p): Corrected texinfo markup.
Diffstat (limited to 'libguile/hash.c')
-rw-r--r--libguile/hash.c46
1 files changed, 24 insertions, 22 deletions
diff --git a/libguile/hash.c b/libguile/hash.c
index f2bb819ec..4bc40d291 100644
--- a/libguile/hash.c
+++ b/libguile/hash.c
@@ -190,15 +190,16 @@ scm_ihashq (SCM obj, unsigned int 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.")
+ "Determine a hash value for @var{key} that is suitable for\n"
+ "lookups in a hashtable of size @var{size}, where @code{eq?} is\n"
+ "used as the equality predicate. The function returns an\n"
+ "integer in the range 0 to @var{size} - 1. Note that\n"
+ "@code{hashq} may use internal addresses. Thus two calls to\n"
+ "hashq where the keys are @code{eq?} are not guaranteed to\n"
+ "deliver the same value if the key object gets garbage collected\n"
+ "in between. This can happen, for example with symbols:\n"
+ "@code{(hashq 'foo n) (gc) (hashq 'foo n)} may produce two\n"
+ "different values, since @code{foo} will be garbage collected.")
#define FUNC_NAME s_scm_hashq
{
SCM_VALIDATE_INUM_MIN (2, size, 0);
@@ -225,15 +226,16 @@ scm_ihashv (SCM obj, unsigned int 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.")
+ "Determine a hash value for @var{key} that is suitable for\n"
+ "lookups in a hashtable of size @var{size}, where @code{eqv?} is\n"
+ "used as the equality predicate. The function returns an\n"
+ "integer in the range 0 to @var{size} - 1. Note that\n"
+ "@code{(hashv key)} may use internal addresses. Thus two calls\n"
+ "to hashv where the keys are @code{eqv?} are not guaranteed to\n"
+ "deliver the same value if the key object gets garbage collected\n"
+ "in between. This can happen, for example with symbols:\n"
+ "@code{(hashv 'foo n) (gc) (hashv 'foo n)} may produce two\n"
+ "different values, since @code{foo} will be garbage collected.")
#define FUNC_NAME s_scm_hashv
{
SCM_VALIDATE_INUM_MIN (2, size, 0);
@@ -253,10 +255,10 @@ scm_ihash (SCM obj, unsigned int 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.")
+ "Determine a hash value for @var{key} that is suitable for\n"
+ "lookups in a hashtable of size @var{size}, where @code{equal?}\n"
+ "is used as the equality predicate. The function returns an\n"
+ "integer in the range 0 to @var{size} - 1.")
#define FUNC_NAME s_scm_hash
{
SCM_VALIDATE_INUM_MIN (2, size, 0);