Create README.md

philipsoutham · Oct 8, 2015 · f9a9c0d · f9a9c0d
1 parent a56da7f
commit f9a9c0d
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# scala-fnv
+Implements FNV-1 and FNV-1a, non-cryptographic hash functions created by Glenn Fowler, Landon Curt Noll, and Phong Vo. 
+See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function. 
+
+```scala
+import com.philipsoutham.hash.FNV
+
+val data = "Hello, world!".getBytes
+
+FNV.hash32(data)  // BigInt = 3897470310
+FNV.hash32a(data) // BigInt = 3985698964
+FNV.hash64(data)  // BigInt = 7285062107457560934
+FNV.hash64a(data) // BigInt = 4094109891673226228
+```
+
+Test cases were taken from [here](http://www.isthe.com/chongo/src/fnv/test_fnv.c).