ConsistentHash

KO | EN

gitlite — search

#react #golang #rust #deep-learning #linux #docker #nodejs #macos #java #windows #vue #awesome-list #mcp #openai

(★ 10)

High performance Ring Consistent Hash implementation

ConsistentHash Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![_Consistent_Hash🪐](https://user-images.githubusercontent.com/16527376/147839020-5e88c335-6275-44ab-9614-e77badd9a7d0.png)

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/MrLederer/ConsistentHash/build-and-unit-tests)
![Azure DevOps coverage](https://img.shields.io/azure-devops/coverage/carmellederer/ConsistentHash/2)
![Nuget](https://img.shields.io/nuget/v/ConsistentHash)

A high performance, immutable, light-weight, dependency-free, ring consistent hash library.
## 💻 Usage
### Construction
```csharp
var nodeToWeight = new Dictionary<string, int>()
{
 { "NodeA", 100 },
 { "NodeB", 150 },
};
var hasher = ConsistentHash.Create(nodeToWeight);
```

### Hashing
```csharp
var node = hasher.Hash(Guid.NewGuid());
// node = "NodeB"
```
### AddOrSet / AddOrSetRange
```csharp
// {NodeA: 100, NodeB: 150}
hasher = hasher.AddOrSet(node: "NodeA", weight: 200); 
// {NodeA: 200, NodeB: 150}
hasher = hasher.AddOrSetRange(new Dictionary<string, int>() { { "NodeC", 500 }, {"NodeD", 35 } });
// {NodeA: 200, NodeB: 150, NodeC: 500, NodeD: 35}
hasher = hasher.AddOrSet(node: "NodeC", weight: 0);
// {NodeA: 200, NodeB: 150, NodeD: 35}
hasher = hasher.AddOrSet(node: "NodeD", weight: -100);
// {NodeA: 200, NodeB: 150}
```

### Remove / RemoveRange
```csharp
// {NodeA: 200, NodeB: 150, NodeC: 500, NodeD: 35}
hasher = hasher.Remove("NodeA");
// {NodeB: 150, NodeC: 500, NodeD: 35}
hasher = hasher.Remove("NonExistingNode");
// {NodeB: 150, NodeC: 500, NodeD: 35}
hasher = hasher.RemoveRange(new[] { "NodeC", "NodeD" });
// {NodeB: 150}
```

# 🌟 Features
* **High performance** - Internally uses GetHashCode and XxHash for mapping nodes to values, and RadixSort for sorting
* **Deterministic** - Given particular node/weight pairs, and hash key, the hash result will be identical.
* **Immutable** 
* **Handles collisions** in a deterministic manner (WIP)
* **Thoroughly tested**
* **Zero dependencies**
* **Super light weight**

## ⚡️ Performance 
### 📉 API runtime and memory
*Operation*|*Runtime*|*Memory usage*|*Details*
--- | --- | --- | :--
Hash | O(log(N)) | n/a | N = Number of nodes
Construction | O(&sum;ni=0Ni) | O(&sum;ni=0Ni) | Ni = Weight defined for node i
AddOrSetRange | O(&sum;ni=0Ni) | O(&sum;ni=0Ni) | Ni = Weight defined for node i
RemoveRange | O(&sum;ni=0Ni) | O(&sum;ni=0Ni) | Ni = Weight defined for node i
Update | O(&sum;ni=0Ni) | O(&sum;ni=0Ni) | Ni = Weight defined for node i
Contains | O(1) | n/a |
TryGetWeight | O(1) | n/a |
Equals | O(N) | n/a | N = Number of nodes

NOTE: Any altering call creates a new instance, so costing sum of all weights.

### 📊 Distribution Benchmarks (WIP)
## 📃 License
ConsistentHash🪐 is free and open-source software licensed under the [GNU General Public License](https://www.gnu.org/licenses/gpl-3.0.en.html)

ConsistentHash

ConsistentHash Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ConsistentHash

ConsistentHash Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README