Skip to content

Commit

Permalink
Simplified library usage
Browse files Browse the repository at this point in the history 
with new direct data handling
  • Loading branch information
@Witteborn
Witteborn committed Aug 10, 2024
1 parent 2a24a9f commit bf0dc80
Show file tree
Hide file tree
Showing 7 changed files with 720 additions and 55 deletions.
210 changes: 167 additions & 43 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This project is a C# implementation of the Reed-Solomon error correction algorit

## Description

Creating and maintaining projects can be challenging. This implementation simplifies integration of Reed-Solomon error correction into your applications. Originally used privately, I decided to publish this implementation under the MIT License.
This implementation simplifies integration of Reed-Solomon error correction into your applications.

If you find this project helpful, please consider starring it and sharing it with others.

Expand All @@ -20,54 +20,178 @@ Install-Package Witteborn.ReedSolomon

Using the Reed-Solomon library is straightforward. Here's a simple example of how to encode and decode data:

### Example: Encode and Decode
### Managed Example: Byte

```csharp
using Witteborn.ReedSolomon;
using System;
using System.Linq;
Console.WriteLine("Managed Example Byte");
Console.WriteLine("--------------------");
const int dataShardCount = 4;
const int parityShardCount = 2;

class Program
// Initialize Reed-Solomon with data shards and parity shards
ReedSolomon rs = new ReedSolomon(dataShardCount, parityShardCount);

// Example data to encode
byte[] data = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 };
Console.WriteLine("Data:");
Console.WriteLine(string.Join(" ", data));

// Encode the data using ManagedEncode to produce shards
var shards = rs.ManagedEncode(data, dataShardCount, parityShardCount);

Console.WriteLine("Encoded Data:");
foreach (var shard in shards)
{
Console.WriteLine(string.Join(" ", shard));
}

// Simulate loss of one shard
shards[1] = null;

Console.WriteLine("Encoded with missing Data:");
foreach (var shard in shards)
{
if (shard == null)
{
Console.WriteLine("null");
}
else
{
Console.WriteLine(string.Join(" ", shard));
}
}

// Decode the remaining shards using ManagedDecode to recover original data
var decodedData = rs.ManagedDecode(shards, dataShardCount, parityShardCount);

Console.WriteLine("Decoded data:");
Console.WriteLine(string.Join(" ", decodedData));
```

### Managed Example: SByte

```csharp
Console.WriteLine("Managed Example SByte");
Console.WriteLine("---------------------");
const int dataShardCount = 4;
const int parityShardCount = 2;

// Initialize Reed-Solomon with data shards and parity shards
ReedSolomon rs = new ReedSolomon(dataShardCount, parityShardCount);

// Example data to encode
sbyte[] data = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 };
Console.WriteLine("Data:");
Console.WriteLine(string.Join(" ", data));

// Encode the data using ManagedEncode to produce shards
var shards = rs.ManagedEncode(data, dataShardCount, parityShardCount);

Console.WriteLine("Encoded Data:");

foreach (var shard in shards)
{
Console.WriteLine(string.Join(" ", shard));
}

// Simulate loss of one shard
shards[1] = null;

Console.WriteLine("Encoded with missing Data:");
foreach (var shard in shards)
{
if (shard == null)
{
Console.WriteLine("null");
}
else
{
Console.WriteLine(string.Join(" ", shard));
}
}

// Decode the remaining shards using ManagedDecode to recover original data
var decodedData = rs.ManagedDecode(shards, dataShardCount, parityShardCount);

Console.WriteLine("Decoded data:");
Console.WriteLine(string.Join(" ", decodedData));
```

### Manual Example: SByte

```csharp
Console.WriteLine("Example SByte");
Console.WriteLine("-------------");

const int dataShardCount = 4;
const int parityShardCount = 2;
const int shardSize = 4;

// Create the shards array with data and empty parity shards
sbyte[][] shards =
{
new sbyte[] { 0, 1, 2, 3 },
new sbyte[] { 4, 5, 6, 7 },
new sbyte[] { 8, 9, 10, 11 },
new sbyte[] { 12, 13, 14, 15 },
new sbyte[shardSize], // Parity shard 1
new sbyte[shardSize] // Parity shard 2
};

Console.WriteLine("Shards:");
foreach (var shard in shards)
{
Console.WriteLine(string.Join(" ", shard));
}

// Initialize Reed-Solomon with data shards and parity shards
ReedSolomon rs = new ReedSolomon(dataShardCount, parityShardCount);

// Encode the data with Reed-Solomon to generate parity shards
rs.EncodeParity(shards, 0, shardSize);

Console.WriteLine("Encoded data:");
foreach (var shard in shards)
{
static void Main()
Console.WriteLine(string.Join(" ", shard));
}

// Simulate loss of one shard (e.g., network transmission loss)
shards[1] = null; // Simulating the shard is lost
Console.WriteLine("Encoded with missing Data:");
foreach (var shard in shards)
{
if (shard == null)
{
Console.WriteLine("null");
}
else
{
Console.WriteLine(string.join(" ", shard));
}
}

bool[] shardPresent = shards.Select(shard => shard != null).ToArray();

//Manual null fix
for (int i = 0; i < shards.Length; i++)
{
if (shards[i] == null)
{
const int dataShardCount = 4;
const int parityShardCount = 2;
const int totalShardCount = dataShardCount + parityShardCount;
const int shardSize = 4;

// Create the shards array with data and empty parity shards
sbyte[][] shards = new sbyte[totalShardCount][]
{
new sbyte[] { 0, 1, 2, 3 },
new sbyte[] { 4, 5, 6, 7 },
new sbyte[] { 8, 9, 10, 11 },
new sbyte[] { 12, 13, 14, 15 },
new sbyte[shardSize], // Parity shard 1
new sbyte[shardSize] // Parity shard 2
};

// Initialize Reed-Solomon with data shards and parity shards
ReedSolomon rs = new ReedSolomon(dataShardCount, parityShardCount);

// Encode the data with Reed-Solomon to generate parity shards
rs.EncodeParity(shards, 0, shardSize);

// Simulate loss of one shard (e.g., network transmission loss)
shards[1] = null; // Simulating the shard is lost
bool[] shardPresent = shards.Select(shard => shard != null).ToArray();

// Decode the remaining shards to recover original data
rs.DecodeMissing(shards, shardPresent, 0, shardSize);

// Print the decoded data (should match original data)
Console.WriteLine("Decoded data:");
foreach (var shard in shards.Where(s => s != null))
{
Console.WriteLine(string.Join(" ", shard));
}
shards[i] = new sbyte[shardSize];
}
}

// Decode the remaining shards to recover original data
rs.DecodeMissing(shards, shardPresent, 0, shardSize);

// Print the decoded data (should match original data)
Console.WriteLine("Decoded data:");
foreach (var shard in shards.Where(s => s != null))
{
Console.WriteLine(string.Join(" ", shard));
}
```

## Contribution
Expand All @@ -86,4 +210,4 @@ To report security issues or vulnerabilities, refer to our [Security](./SECURITY

- **Backblaze** for the original Java implementation that inspired this project.

And a big **Thank You** to all contributors, issue reporters, and supporters who have helped make this project possible.
And a big **Thank You** to all contributors, issue reporters, and supporters who have helped make this project possible.
Loading

0 comments on commit bf0dc80

Please sign in to comment.