blockcoding.hpp

Go to the documentation of this file.

// toolboxes/comm/include/nk/comm/coding/blockcoding.hpp
//
// Block linear coding — Error Correction Codes section of the
// Communications Toolbox. Generator / parity-check matrix construction
// (hammgen, gen2par, cyclgen) and cyclic generator polynomials
// (cyclpoly), plus the block encoder / decoder (encode / decode).
//
// Everything here is GF(2) (binary) arithmetic on plain double matrices —
// no Galois-field object type is required. BCH / Reed-Solomon (which need
// a GF(2^m) `gf` array type) are a documented gap.
 
#pragma once
 
#include <memory_resource>
#include <string>
#include <nk/value/value.hpp>
 
namespace nk::comm {

 

Value gen2par(const Value &mat, std::pmr::memory_resource *mr = nullptr);

struct HammgenResult {
    Value     h;  
    Value     g;  
    long long n;  
    long long k;  
};

HammgenResult hammgen(long long m, const Value &primPoly = Value::Empty,
                      std::pmr::memory_resource *mr = nullptr);

Value cyclpoly(long long n, long long k, const std::string &opt = "",
               std::pmr::memory_resource *mr = nullptr);

struct CyclgenResult {
    Value     h;  
    Value     g;  
    long long k;  
};

CyclgenResult cyclgen(long long n, const Value &genpoly,
                      const std::string &opt = "system",
                      std::pmr::memory_resource *mr = nullptr);

struct EncodeResult {
    Value     code;   
    long long added;  
};

EncodeResult encode(const Value &msg, long long n, long long k,
                    const std::string &method = "hamming/binary",
                    const Value &opt = Value::Empty,
                    std::pmr::memory_resource *mr = nullptr);

struct DecodeResult {
    Value msg;   
    Value err;   
};

DecodeResult decode(const Value &code, long long n, long long k,
                    const std::string &method = "hamming/binary",
                    const Value &opt = Value::Empty,
                    std::pmr::memory_resource *mr = nullptr);

Value syndtable(const Value &H, std::pmr::memory_resource *mr = nullptr);
 

} // namespace nk::comm