STH1123.ReedSolomon 2.1.0

dotnet add package STH1123.ReedSolomon --version 2.1.0
NuGet\Install-Package STH1123.ReedSolomon -Version 2.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="STH1123.ReedSolomon" Version="2.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add STH1123.ReedSolomon --version 2.1.0
#r "nuget: STH1123.ReedSolomon, 2.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install STH1123.ReedSolomon as a Cake Addin
#addin nuget:?package=STH1123.ReedSolomon&version=2.1.0

// Install STH1123.ReedSolomon as a Cake Tool
#tool nuget:?package=STH1123.ReedSolomon&version=2.1.0

A .NET implementation of the Reed-Solomon algorithm, supporting error, erasure and errata correction.

Uses code from the Reed-Solomon component of the ZXing.Net project and code I've ported to C#, from the python code at Wikiversity.

Code examples

Create a representation of a Galois field:

GenericGF field = new GenericGF(285, 256, 0);

Reed-Solomon encoding:

Create an instance of the ReedSolomonEncoder class, specifying the Galois field to use:

ReedSolomonEncoder rse = new ReedSolomonEncoder(field);

To encode the string "Hello World" with 9 ecc symbols, 9 null-values must be appended to store the ecc symbols:

int[] data = new int[] { 0x48, 0x65, 0x6C, 0x6C, 0x6F, 0x20, 0x57, 0x6F, 0x72, 0x6C, 0x64, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };

Call the Encode() method of the ReedSolomonEncoder class to encode data with Reed-Solomon:

rse.Encode(data, 9);

The data variable now contains:

0x48, 0x65, 0x6C, 0x6C, 0x6F, 0x20, 0x57, 0x6F, 0x72, 0x6C, 0x64, 0x40, 0x86, 0x08, 0xD5, 0x2C, 0xAE, 0xB5, 0x8F, 0x83

Reed-Solomon decoding:

Previous data variable with some errors:

data = new int[] { 0x00, 0x02, 0x02, 0x02, 0x02, 0x02, 0x57, 0x6F, 0x72, 0x6C, 0x64, 0x40, 0x86, 0x08, 0xD5, 0x2C, 0xAE, 0xB5, 0x8F, 0x83 };

Providing the locations of some erasures:

int[] erasures = new int[] { 0, 1, 2 };

Create an instance of the ReedSolomonDecoder class, specifying the Galois field to use:

ReedSolomonDecoder rsd = new ReedSolomonDecoder(field);

Call the Decode() method of the ReedSolomonDecoder class to decode (correct) data with Reed-Solomon:

if (rsd.Decode(data, 9, erasures))
{
    // Data corrected.
}
else
{
    // Too many errors/erasures to correct.
}

The data variable now contains:

0x48, 0x65, 0x6C, 0x6C, 0x6F, 0x20, 0x57, 0x6F, 0x72, 0x6C, 0x64, 0x40, 0x86, 0x08, 0xD5, 0x2C, 0xAE, 0xB5, 0x8F, 0x83
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.1 is compatible.  netstandard1.2 was computed.  netstandard1.3 was computed.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 was computed.  netstandard2.1 was computed. 
.NET Framework net20 is compatible.  net35 was computed.  net40 is compatible.  net403 was computed.  net45 was computed.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Windows Phone wpa81 was computed. 
Windows Store netcore was computed.  netcore45 was computed.  netcore451 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETFramework 2.0

    • No dependencies.
  • .NETFramework 4.0

    • No dependencies.
  • .NETStandard 1.1

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on STH1123.ReedSolomon:

Package Downloads
BrightChain.Engine

BrightChain: The Revolution(ary) Network

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.0 13,822 4/5/2020