Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
added warning about `DoubleWidth` digests
fixed open string in `Package.swift` code
  • Loading branch information
crichez authored Feb 3, 2022
1 parent fc93389 commit bed36fe
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To depend on it, include it in your `Package.swift` dependencies:

```swift
.package(
name: "FowlerNollVo:,
name: "FowlerNollVo",
url: "https://github.com/crichez/swift-fowler-noll-vo",
.upToNextMinor(from: "0.1.0")),
```
Expand Down Expand Up @@ -67,6 +67,15 @@ The following hasher types are built-in:
* `FNV512` & `FNV512a`
* `FNV1024` & `FNV1024a`

**Note:** `FNV128` and hashers with larger digests all use `DoubleWidth`
from [the swift numerics project](https://github.com/apple/swift-numerics).
That code was included in this project under its original Apache 2.0 license,
and is still considered experimental.

Although performance from 32 to 64-bit digests is similar,
performance quickly degrades with larger digests. Getting a 1024-bit digest
from 64 bits of input data takes around 0.33 seconds on a M1 MacBook Pro.

### Usage

```swift
Expand Down

0 comments on commit bed36fe

Please sign in to comment.