Timerix/DTLib.XXHash
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Melnik Alexander 2018-09-29 13:57:02 +03:00
parent bc27b27f18
commit 77d44019c6
2 changed files with 17 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -46,33 +46,25 @@ This benchmark was launched on a **Windows 10 (10.0.16299.309)**. The reference
## Comparison between С# and C implementation
| Method | Language | 1KB Time | 1MB Time | 1GB Time |
|--------|---------:|----------:|----------:|----------:|
| Hash32 | C# | 185.1 ns | 170.6 us | 193.6 ms |
| Hash32 | C | 183.5 ns | 170.1 us | 190.8 ms |
| Hash64 | C# | 117.3 ns | 87.1 us | 116.9 ms |
| Hash64 | C | 104.8 ns | 85.3 us | 114.1 ms |
| Method | Platform | Language | 1KB Time | 1MB Time | 1GB Time | Speed | Difference |
|--------|---------:|---------:|----------:|----------:|----------:|----------:|-----------:|
| Hash32 | x64 | C# | 185.1 ns | 170.6 us | 193.6 ms | 5.16 GB/s | 1.4 % |
| Hash32 | x64 | C | 183.5 ns | 170.1 us | 190.8 ms | 5.16 GB/s | 1.4 % |
| Hash64 | x64 | C# | 117.3 ns | 87.1 us | 116.9 ms | 5.16 GB/s | 2.4 % |
| Hash64 | x64 | C | 104.8 ns | 85.3 us | 114.1 ms | 5.16 GB/s | 2.4 % |
## Defference
| Method | Platform | Language | Size | Time | Speed | Difference |
|--------|---------:|---------:|-----:|----------:|----------:|-----------:|
| Hash32 | x64 | C# | 1GB | 193.6 ms | 5.16 GB/s | 1.4 % |
| Hash32 | x64 | C | 1GB | 190.8 ms | 5.24 GB/s | 1.4 % |
| Hash64 | x64 | C# | 1GB | 116.9 ms | 8.55 GB/s | 2.4 % |
| Hash64 | x64 | C | 1GB | 114.1 ms | 8.76 GB/s | 2.4 % |
## Api
```cs
public static uint ComputeHash(byte[] data, int length, uint seed = 0) { throw null; }
public static uint ComputeHash(Span<byte> data, int length, uint seed = 0) { throw null; }
public static uint ComputeHash(Stream stream, int bufferSize = 4096, uint seed = 0) { throw null; }
public static async Task<uint> ComputeHashAsync(Stream stream, int bufferSize = 4096, uint seed = 0) { throw null; }
public static async ValueTask<uint> ComputeHashAsync(Stream stream, int bufferSize = 4096, uint seed = 0) { throw null; }
public static ulong ComputeHash(byte[] data, int length, ulong seed = 0) { throw null; }
public static ulong ComputeHash(Span<byte> data, int length, ulong seed = 0) { throw null; }
public static ulong ComputeHash(Stream stream, int bufferSize = 8192, ulong seed = 0) { throw null; }
public static async Task<ulong> ComputeHashAsync(Stream stream, int bufferSize = 8192, ulong seed = 0) { throw null; }
public static async ValueTask<ulong> ComputeHashAsync(Stream stream, int bufferSize = 8192, ulong seed = 0) { throw null; }
```
## Examples
@ -81,12 +73,14 @@ A few examples of how to use api
byte[] data = Encoding.UTF8.GetBytes("veni vidi vici");
ulong h64_1 = xxHash64.ComputeHash(data, data.Length);
ulong h64_2 = xxHash64.ComputeHash(new MemoryStream(data));
ulong h64_3 = await xxHash64.ComputeHashAsync(new MemoryStream(data));
ulong h64_2 = xxHash64.ComputeHash(new Span<byte>(data), data.Length);
ulong h64_3 = xxHash64.ComputeHash(new MemoryStream(data));
ulong h64_4 = await xxHash64.ComputeHashAsync(new MemoryStream(data));
uint h32_1 = xxHash32.ComputeHash(data, data.Length);
uint h32_2 = xxHash32.ComputeHash(new MemoryStream(data));
uint h32_3 = await xxHash32.ComputeHashAsync(new MemoryStream(data));
uint h32_2 = xxHash32.ComputeHash(new Span<byte>(data), data.Length);
uint h32_3 = xxHash32.ComputeHash(new MemoryStream(data));
uint h32_4 = await xxHash32.ComputeHashAsync(new MemoryStream(data));
```
---
<p align="center">

3
src/Standart.Hash.xxHash/Standart.Hash.xxHash.csproj
View File

@ -17,4 +17,7 @@
<PackageReference Include="System.Memory" Version="$(SystemMemory)" />
<PackageReference Include="System.Threading.Tasks.Extensions" Version="$(SystemTasks)" />
</ItemGroup>
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
</PropertyGroup>
</Project>