mirror of
https://github.com/cryb-to/cryb-to.git
synced 2024-12-01 10:05:41 +00:00
90 lines
2.8 KiB
Groff
90 lines
2.8 KiB
Groff
|
.\"-
|
||
|
|
.\" Copyright (c) 2015-2016 Universitetet i Oslo
|
||
|
|
.\" Copyright (c) 2016 Dag-Erling Smørgrav
|
||
|
|
.\" 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.
|
||
|
|
.\" 3. The name of the author may not be used to endorse or promote
|
||
|
|
.\" products derived from this software without specific prior written
|
||
|
|
.\" permission.
|
||
|
|
.\"
|
||
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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.
|
||
|
|
.\"
|
||
|
|
.Dd September 17, 2016
|
||
|
|
.Dt CRYB_PEARSON_HASH 3
|
||
|
|
.Os
|
||
|
|
.Sh NAME
|
||
|
|
.Nm cryb_pearson_hash ,
|
||
|
|
.Nm cryb_pearson_hash_str
|
||
|
|
.Nd hash functions
|
||
|
|
.Sh LIBRARY
|
||
|
|
.Lb libcryb-hash
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.In stddef.h
|
||
|
|
.In stdint.h
|
||
|
|
.In cryb/hash.h
|
||
|
|
.Ft uint8_t
|
||
|
|
.Fn cryb_pearson_hash "const void *data" "size_t len"
|
||
|
|
.Ft uint8_t
|
||
|
|
.Fn cryb_pearson_hash_str "const char *str"
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
The
|
||
|
|
.Fn cryb_pearson_hash
|
||
|
|
function returns an 8-bit hash of the
|
||
|
|
.Va len
|
||
|
|
first bytes of the object pointed to by
|
||
|
|
.Va data .
|
||
|
|
.Pp
|
||
|
|
The
|
||
|
|
.Fn cryb_pearson_hash_str
|
||
|
|
function returns an 8-bit hash of the NUL-terminated string pointed to
|
||
|
|
by
|
||
|
|
.Va str ,
|
||
|
|
not including the terminating NUL.
|
||
|
|
It is equivalent to calling
|
||
|
|
.Li cryb_pearson_hash(str, strlen(str)) .
|
||
|
|
.Sh IMPLEMENTATION NOTES
|
||
|
|
The
|
||
|
|
.In cryb/hash.h
|
||
|
|
header provides macros which allows these functions to be referred to
|
||
|
|
without their
|
||
|
|
.Dq Li cryb_
|
||
|
|
prefix.
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr cryb_hash 3
|
||
|
|
.Sh STANDARDS
|
||
|
|
.Rs
|
||
|
|
.%A "Pearson, Peter K."
|
||
|
|
.%D "June 1990"
|
||
|
|
.%T "Fast Hashing of Variable-Length Text Strings"
|
||
|
|
.%J "Communications of the ACM"
|
||
|
|
.%V "33"
|
||
|
|
.%N "6"
|
||
|
|
.%P "677"
|
||
|
|
.%O "doi:10.1145/78973.78978"
|
||
|
|
.Re
|
||
|
|
.Sh AUTHORS
|
||
|
|
The
|
||
|
|
.Fn cryb_pearson_hash
|
||
|
|
and
|
||
|
|
.Fn cryb_pearson_hash_str
|
||
|
|
functions and this manual page were written for the University of Oslo by
|
||
|
|
.An Dag-Erling Sm\(/orgrav Aq Mt d.e.smorgrav@usit.uio.no .
|