Data.HashFunction.Interfaces 3.1.2

<img src="https://github.com/user-attachments/assets/fc94c7e0-96c6-4dfd-a728-0fd15656b5a4">

Data.HashFunction

This project was originally maintained at brandondahler/Data.HashFunction before 05/11/2022 (PT). It is maintained by Deskasoft International since then. Join our Discord at https://discord.gg/PrKery9 to discuss about our projects.

Data.HashFunction is a C# library to create a common interface to non-cryptographic hash functions and provide implementations of public hash functions. It is licensed under the permissive and OSI approved MIT license.

All functionality of the library is tested using xUnit. A primary requirement for each release is 100% code coverage by these tests.

All code within the libarary is commented using Visual Studio-compatible XML comments.

Documentation Page

The new documentation page is available at https://deskasoft.dev/projects/data.hashfunction/.

Status

Master

NuGet

Name	Normal
Data.HashFunction.BernsteinHash
Data.HashFunction.Blake2
Data.HashFunction.Blake3
Data.HashFunction.BuzHash
Data.HashFunction.CityHash
Data.HashFunction.CRC
Data.HashFunction.ELF64
Data.HashFunction.FNV
Data.HashFunction.HashAlgorithm
Data.HashFunction.Jenkins
Data.HashFunction.MurmurHash
Data.HashFunction.Pearson
Data.HashFunction.SpookyHash
Data.HashFunction.xxHash

Implementations

All implementation packages depend on the Data.HashFunction.Interfaces and Data.HashFunction.Core NuGet packages.

The following hash functions have been implemented from the most reliable reference that could be found.

• Bernstein Hash
  • BernsteinHash - Original
  • ModifiedBernsteinHash - Minor update that is said to result in better distribution
• Blake2
  • Blake2b
• Blake3
  • Blake3 (through https://github.com/xoofx/Blake3.NET - does not require the mentioned project)
• BuzHash
  • BuzHashBase - Abstract implementation, there is no authoritative implementation
  • DefaultBuzHash - Concrete implementation, uses 256 random 64-bit integers
• CityHash
• CRC
  • CRC - Generalized implementation to allow any CRC parameters between 1 and 64 bits.
  • CRCStandards - 71 implementations on top of CRC that use the parameters defined by their respective standard. Standards and their parameters provided by CRC RevEng's catalogue.
• ELF64
• FNV
  • FNV1Base - Abstract base of the FNV-1 algorithms
  • FNV1 - Original
  • FNV1a - Minor variation of FNV-1
• Hash Algorithm Wrapper
  • HashAlgorithmWrapper - Wraps existing instance of a .Net HashAlgorithm
  • HashAlgorithmWrapper<HashAlgorithmT> - Wraps a managed instance of a .Net HashAlgorithm
• Jenkins
  • JenkinsOneAtATime - Original
  • JenkinsLookup2 - Improvement upon One-at-a-Time hash function
  • JenkinsLookup3 - Further improvement upon Jenkins' Lookup2 hash function
• Murmur Hash
  • MurmurHash1 - Original
  • MurmurHash2 - Improvement upon MurmurHash1
  • MurmurHash3 - Further improvement upon MurmurHash2, addresses minor flaws
• Pearson hashing
  • PearsonBase - Abstract implementation, there is no authoritative implementation
  • WikipediaPearson - Concrete implementation, uses values from Wikipedia article
• SpookyHash
  • SpookyHashV1 - Original
  • SpookyHashV2 - Improvement upon SpookyHashV1, fixes bug in original specification
• xxHash
  • xxHash - Original and 64-bit version.

Each family of hash functions is contained within its own project and NuGet package.

Usage

The usage for all hash functions has been standardized and is accessible via the System.Data.HashFunction.IHashFunction and System.Data.HashFunction.IHashFunctionAsync interfaces. The core package, Data.HashFunction.Core, only contains abstract hash function implementations and base functionality for the library. In order to use a specific hashing algorithms, you will need to reference its implementation packages.

IHashFunction implementations should be immutable and stateles. All IHashFunction methods and members should be thread safe.

using System;
using System.Data.HashFunction;
using System.Data.HashFunction.Jenkins;

public class Program
{
    public static readonly IJenkinsOneAtATime _jenkinsOneAtATime = JenkinsOneAtATimeFactory.Instance.Create();
    public static void Main()
    {
        var hashValue = _jenkinsOneAtATime.ComputeHash("foobar");

        Console.WriteLine(hashValue.AsHexString());
    }
}

Release Notes

See Release Notes wiki page.

Versioning Guarantees

This library generally abides by Semantic Versioning. Packages are published in MAJOR.MINOR.PATCH version format.

Patch component

An increment of the PATCH component always indicates that an internal-only change was made, generally a bug fix. These changes will not affect the public-facing API in any way, and are always guaranteed to be forward/backwards-compatible with your codebase, any pre-compiled dependencies of your codebase.

Minor component

An increment of the MINOR component indicates that some addition was made to the library, and this addition may not be backwards-compatible with prior versions.

Major component

An increment of the MAJOR component indicates that breaking changes have been made to the library; consumers should check the release notes to determine what changes need to be made.

Contributing

Feel free to propose changes, notify of issues, or contribute code using GitHub! Submit issues and/or pull requests as necessary.

There are no special requirements for change proposal or issue notifications.

Code contributions should follow existing code's methodologies and style, along with XML comments for all public and protected namespaces, classes, and functions added.

License

Data.HashFunction is released under the terms of the MIT license. See LICENSE for more information or see http://opensource.org/licenses/MIT.