Skip to content

Commit

Permalink
update document
Browse files Browse the repository at this point in the history
  • Loading branch information
flier committed May 9, 2017
1 parent d87a101 commit a8d2d1a
Showing 1 changed file with 33 additions and 15 deletions.
48 changes: 33 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Travis CI Status](https://travis-ci.org/flier/pyfasthash.svg?branch=master)](https://travis-ci.org/flier/pyfasthash)
# Introduction [![Travis CI Status](https://travis-ci.org/flier/pyfasthash.svg?branch=master)](https://travis-ci.org/flier/pyfasthash)

pyhash is a python non-cryptographic hash library. It provide several common hash algorithms with C/C++ implementation for performance.

Expand All @@ -17,20 +17,38 @@
2805756500L
```

Note: Please use pyhash to install it from pypi
# Installation

Please use pyhash to install it from pypi

```bash
$sudo easy_install pyhash
$sudo pip install pyhash
```

Notes: `pyhash` depends on `Boost` library to build

- Ubuntu

> sudo apt-get install libboost-all-dev
- CentOS

> sudo yum install boost-devel
- OSX

> brew install boost
# Algorithms

pyhash support the following hash algorithms

* [FNV](http://isthe.com/chongo/tech/comp/fnv/) (Fowler-Noll-Vo) hash
- [FNV](http://isthe.com/chongo/tech/comp/fnv/) (Fowler-Noll-Vo) hash
- fnv1_32
- fnv1a_32
- fnv1_64
- fnv1a_64
* [MurmurHash](http://code.google.com/p/smhasher/) 1/2/3
- [MurmurHash](http://code.google.com/p/smhasher/) 1/2/3
- murmur1_32
- murmur1_aligned_32
- murmur2_32
Expand All @@ -42,37 +60,37 @@ pyhash support the following hash algorithms
- murmur3_32
- murmur3_x86_128
- murmur3_x64_128
* [lookup3](http://burtleburtle.net/bob/hash/doobs.html)
- [lookup3](http://burtleburtle.net/bob/hash/doobs.html)
- lookup3 # base on sys.byteorder
- lookup3_little
- lookup3_big
* [SuperFastHash](http://www.azillionmonkeys.com/qed/hash.html)
- [SuperFastHash](http://www.azillionmonkeys.com/qed/hash.html)
- super_fast_hash
* [City Hash](https://code.google.com/p/cityhash/)
- [City Hash](https://code.google.com/p/cityhash/)
_ city_32
- city_64
- city_128
- city_crc_128
* [Spooky Hash](http://burtleburtle.net/bob/hash/spooky.html)
- [Spooky Hash](http://burtleburtle.net/bob/hash/spooky.html)
- spooky_32
- spooky_64
- spooky_128
* [FarmHash](https://github.com/google/farmhash)
- [FarmHash](https://github.com/google/farmhash)
- farm_32
- farm_64
- farm_128
* [MetroHash](https://github.com/jandrewrogers/MetroHash)
- [MetroHash](https://github.com/jandrewrogers/MetroHash)
- metro_64
- metro_128
- metro_crc_64
- metro_crc_128
* [MumHash](https://github.com/vnmakarov/mum-hash)
- [MumHash](https://github.com/vnmakarov/mum-hash)
- mum_64 **NEW!**
* [T1Hash](https://github.com/leo-yuriev/t1ha)
- [T1Hash](https://github.com/leo-yuriev/t1ha)
- t1_32 **NEW!**
- t1_32_be **NEW!**
- t1_64 **NEW!**
- t1_64_be **NEW!**
* [XXHash](https://github.com/Cyan4973/xxHash)
- [XXHash](https://github.com/Cyan4973/xxHash)
- xx_32 **NEW!**
- xx_64 **NEW!**
- xx_64 **NEW!**

0 comments on commit a8d2d1a

Please sign in to comment.