Metadata-Version: 2.1
Name: errcode
Version: 0.1.0
Summary: Error Detecting/Correcting Codes
Home-page: http://github.com/zhiqingxiao/errcode/
Author: Zhiqing Xiao
Author-email: xzq.xiaozhiqing@gmail.com
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Science/Research
Description-Content-Type: text/markdown

errcode: A Toolbox for Error Correcting/Detecting Codes
=======================

`errcode` is a package for classical error-correcting codes and error-detecting codes.

### API

`max_size(arity:int|list[int]=2, repeat:int=1, direction:int|list[int]=1, correct:int=0, detect:Optional[int]=None) -> int|range`

## Usage Examples

```
from errcode import max_size
print(max_size(arity=2, repeat=6, correct=4))
print(max_size(arity=[5, -3, 4], detect=1))
```

