Git Product home page Git Product logo

fecmagic's Introduction

Welcome to fecmagic

fecmagic is a header-only C++ library which implements some FEC (forward error correction) codes and some utility functions that help developing and testing such codes.

What's in the box?

Currently, we've got the following:

  • A generic block code algorithm that works with binary matrix operations, and has a generic method of syndrome-based decoding.
  • A generic convolutional codec that is implemented using variadic templates and can be configured to work with any convolutional code.
    The encoder implements the classical "shift register" algorithm, and the decoder implements a hard-decision Viterbi algorithm.

And we have specialized codecs for:

  • Hamming(7, 4)
  • Golay(24, 12)

And for your convenience, we've also got:

  • A way to work with binary matrices efficiently
  • A way to print a number in binary
  • A way to iterate through bit mask combinations

How to use

All the algorithms are implemented in modern C++ and should compile on a C++11 compiler. The tests use the 0b notation for binary numbers, so you need C++14 to compile the tests.

Since this is a header-only library, you can simply copy the necessary header files, include them and you're good to go.

Contributions

Testing and bugreports

This code is primarily tested using GCC on Linux x86. If you find bugs or issues on other compilers or platforms, feel free to open a bug report.

Each piece of code has a small test application. Some of these (Hamming and Golay) cover all possible inputs, and some just contain basic tests to see if stuff works. These tests will be further expanded as needed.

Code

If you think you can improve on our code or add other features, your contribution is welcome. Feel free to send us a pull request. Thanks in advance! :)

License

The code is licensed to you under the terms of the MIT license.

fecmagic's People

Contributors

venemo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.