lib/libc/stdlib/mi_vector_hash.3

   1 .\"     $NetBSD: mi_vector_hash.3,v 1.1 2009/07/20 17:03:37 joerg Exp $
   2 .\"
   3 .\" Copyright (c) 2009 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Joerg Sonnenberger.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd July 13, 2009
  31 .Dt MI_VECTOR_HASH 3
  32 .Os
  33 .Sh NAME
  34 .Nm mi_vector_hash
  35 .Nd fast 32bit hash functions
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In stdlib.h
  40 .Ft void
  41 .Fn mi_vector_hash "const void * restrict key" "size_t len" \
  42     "uint32_t seed" "uint32_t hashes[3]"
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 function computes three 32-bit hash values of the memory area starting at
  47 .Fa key
  48 with length
  49 .Fa len .
  50 .Pp
  51 The output is identical on all architectures and only depends on
  52 .Fa key
  53 and
  54 .Fa seed .
  55 .Sh IMPLEMENTATION NOTES
  56 An optimised code path is used if
  57 .Fa key
  58 is aligned on a 32-bit boundary.
  59 .Sh HISTORY
  60 The
  61 .Nm
  62 function appeared in
  63 .Nx 6.0 .
  64 .Sh AUTHORS
  65 The hash function has been created by Bob Jenkins.