tree: b850e59f2f8f05ae788f43538e60ef172fe16be7 [path history] [tgz]
  1. LICENSE.txt
  2. README.md
  3. xxhash.go
  4. xxhash_amd64.go
  5. xxhash_amd64.s
  6. xxhash_other.go
  7. xxhash_safe.go
vendor/github.com/klauspost/compress/zstd/internal/xxhash/README.md

xxhash

VENDORED: Go to github.com/cespare/xxhash for original package.

GoDoc Build Status

xxhash is a Go implementation of the 64-bit xxHash algorithm, XXH64. This is a high-quality hashing algorithm that is much faster than anything in the Go standard library.

This package provides a straightforward API:

func Sum64(b []byte) uint64
func Sum64String(s string) uint64
type Digest struct{ ... }
    func New() *Digest

The Digest type implements hash.Hash64. Its key methods are:

func (*Digest) Write([]byte) (int, error)
func (*Digest) WriteString(string) (int, error)
func (*Digest) Sum64() uint64

This implementation provides a fast pure-Go implementation and an even faster assembly implementation for amd64.

Benchmarks

Here are some quick benchmarks comparing the pure-Go and assembly implementations of Sum64.

input sizepuregoasm
5 B979.66 MB/s1291.17 MB/s
100 B7475.26 MB/s7973.40 MB/s
4 KB17573.46 MB/s17602.65 MB/s
10 MB17131.46 MB/s17142.16 MB/s

These numbers were generated on Ubuntu 18.04 with an Intel i7-8700K CPU using the following commands under Go 1.11.2:

$ go test -tags purego -benchtime 10s -bench '/xxhash,direct,bytes'
$ go test -benchtime 10s -bench '/xxhash,direct,bytes'

Projects using this package