From f4e3637164e1ffd3214ca2aff7879040d33e9b07 Mon Sep 17 00:00:00 2001 From: Chris Hanson Date: Fri, 3 Mar 2017 20:31:31 -0800 Subject: [PATCH] Document string-hash-ci. --- doc/ref-manual/strings.texi | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/ref-manual/strings.texi b/doc/ref-manual/strings.texi index 9c25efa05..93fc5a770 100644 --- a/doc/ref-manual/strings.texi +++ b/doc/ref-manual/strings.texi @@ -392,17 +392,19 @@ Returns @code{#t} if @var{string} has zero length; otherwise returns @end deffn @deffn procedure string-hash string [modulus] +@deffnx procedure string-hash-ci string [modulus] @cindex hashing, of string @findex string=? +@findex string-ci=? @findex = -@code{string-hash} returns an exact non-negative integer that can be used +These procedures return an exact non-negative integer that can be used for storing the specified @var{string} in a hash table. Equal strings -(in the sense of @code{string=?}) return equal (@code{=}) hash codes, -and non-equal but similar strings are usually mapped to distinct hash -codes. +(in the sense of @code{string=?} and @code{string-ci=?} respectively) +return equal (@code{=}) hash codes, and non-equal but similar strings +are usually mapped to distinct hash codes. If the optional argument @var{modulus} is specified, it must be an -exact positive integer, and the result of @code{string-hash} is +exact positive integer, and the result of the hash computation is restricted to be less than that value. This is equivalent to calling @code{modulo} on the result, but may be faster. @end deffn -- 2.25.1