https://github.com/lostincompilation/reedsolomon

Reed-Solomon error correction library for C++
https://github.com/lostincompilation/reedsolomon

error-correcting-codes error-correction reed-solomon

Last synced: 6 months ago
JSON representation

Reed-Solomon error correction library for C++

• Host: GitHub
• URL: https://github.com/lostincompilation/reedsolomon
• Owner: LostInCompilation
• License: zlib
• Created: 2024-06-10T22:07:26.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-22T03:29:42.000Z (over 1 year ago)
• Last Synced: 2025-04-12T22:56:49.938Z (6 months ago)
• Topics: error-correcting-codes, error-correction, reed-solomon
• Language: C++
• Homepage:
• Size: 1.04 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Reed-Solomon Error Correction Library for C++

![Version](https://img.shields.io/badge/Version-V1.0-brightgreen?style=flat&&logo=framework) ![Platform](https://img.shields.io/badge/Platform-Windows%20%7C%20Linux%20%7C%20macOS%20-blue?style=flat&&logo=Platform.sh) ![CPP](https://img.shields.io/badge/Language-C++20-orange?style=flat&&logo=C%2b%2b)

## Contents

- [Description](#description)

- [Getting the library](#getting-the-library)

- [Compiling](#compiling)

    - [CMake](#cmake)

    - [Visual Studio](#visual-studio)

    - [Xcode](#xcode)

- [How to use it](#how-to-use-it)

- [Included examples](#included-examples)

*See also: [License (zlib)](LICENSE.md)*

## 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:

```cpp

#include "ReedSolomon.hpp"

```

TODO

## Included Examples

TODO