extended-hamming-code v1.0.1

extended-hamming-code

extended hamming code allows you to encode and decode binary strings, it has not any dependencies.Works only with binary strings. For example '101010'.

extended means first index of code handle odd-even of all code.

It is UMD module. It means it capable of working in AMD, CommonJS-like, nodejs, browrser environments. For more information go to UMD.

usage

npm install extended-hamming-code -S

import ExtendHammingCode from 'extended-hamming-code';

const {
  encode,
  decode,
} = ExtendHammingCode.setConfig({
  pow: 4
})

Options

relation of 'pow' and size :

example

when we set 4 to pow，we will get 16, 11 hamming code's encode and decode methord.

in this case, maximum encode 11 bit. when encode too long like this case below. str will be splited as many parts，and be encoded for each of them. join each other and return.

import ExtendHammingCode from 'extended-hamming-code';

const {
  encode,
  decode,
} = ExtendHammingCode.setConfig({
  pow: 4
})

const str = '1010101010101010101010101010101010';
const encodeRes = encode(str);
const decodeRes = decode(encodeRes);
const {
  code,
  correct,
  originCode,
  decodeResult,
} = decodeRes;
console.log(`encode:${str}, `, encodeRes);
console.log(`decode:${encodeRes}, `, decodeRes);
console.log('is correct?', correct, code === str)

result of decode: