.\"   Part of publib.
.\"  
.\"   Copyright (c) 1994-2006 Lars Wirzenius.  All rights reserved.
.\"  
.\"   Redistribution and use in source and binary forms, with or without
.\"   modification, are permitted provided that the following conditions
.\"   are met:
.\"  
.\"   1. Redistributions of source code must retain the above copyright
.\"      notice, this list of conditions and the following disclaimer.
.\"  
.\"   2. Redistributions in binary form must reproduce the above
.\"      copyright notice, this list of conditions and the following
.\"      disclaimer in the documentation and/or other materials provided
.\"      with the distribution.
.\"  
.\"   THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
.\"   OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\"   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\"   ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
.\"   DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\"   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
.\"   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\"   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
.\"   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\"   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
.\"   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"  
.\" part of publib
.\" "@(#)publib-strutil:$Id: strhash.3,v 1.1 1994/06/20 20:30:13 liw Exp $"
.\"
.TH STRHASH 3pub "C Programmer's Manual" Publib "C Programmer's Manual"
.SH NAME
strhash \- hash function for strings
.SH SYNOPSIS
.nf
#include <publib.h>
unsigned long \fBstrhash\fR(const char *\fIs\fR);
.SH DESCRIPTION
\fIstrhash\fR is a hash function for strings.  It uses an algorithm
that tries to be good in most cases, but it is often possible to use
a better algorithm that takes better into account the characteristics
of the data for a given application.  However, \fIstrhash\fR often
good enough; test it before spending time to develop a better one.
.SH "RETURN VALUE"
\fIstrhash\fR returns the computed hash value.  Note that the value
is not scaled into any particular range (all values that an unsigned
long can take are possible).  The caller will have to do the scaling
himself.
.SH "SEE ALSO"
publib(3), hashtab(3)
.SH AUTHOR
Lars Wirzenius (lars.wirzenius@helsinki.fi)