Skip to content

Reed-Solomon error correction library for C++

License

Notifications You must be signed in to change notification settings

LostInCompilation/ReedSolomon

Repository files navigation

Reed-Solomon Error Correction Library for C++

Version Platform CPP

Contents

See also: License (zlib)

Description

A simple to use and free C++20 library for Reed-Solomon Error Correction (encoding and decoding). The static library provides very easy integration in your projects and high speeds. CMake build environment is supported, as well as generating projects for VisualStudio or Xcode. Also included is a small DataChunker class, to split up large data sets into smaller pieces, which can be individually encoded, decoded and assembled again.

Getting the library

To download the library simply clone the repository:

git clone https://github.com/LostInCompilation/ReedSolomon

Compiling

Compilation of the library and examples can be done using CMake and make, or projects for VisualStudio and Xcode can be generated. Small Shell scripts are included for compiling and generating projects.

CMake

TODO

Visual Studio

TODO

Xcode

TODO

How to use it

Include the main header file of the library in your project:

#include "ReedSolomon.hpp"

TODO

Included Examples

TODO