From 16818fcd3bd63606d0c38d87e3124e24b124071c Mon Sep 17 00:00:00 2001 From: Dmitriy Ryajov Date: Sun, 27 Mar 2022 14:46:42 -0600 Subject: [PATCH] add TODO for usage --- README.md | 52 +--------------------------------------------------- 1 file changed, 1 insertion(+), 51 deletions(-) diff --git a/README.md b/README.md index 307158c..24e4446 100644 --- a/README.md +++ b/README.md @@ -76,57 +76,7 @@ So, on macOS, when running `nimble test` of nim-leopard or compiling a project t ## Usage -```nim -import leopard - -# Initialize Leopard-RS -leoInit() - -var - N: Positive - data: seq[seq[byte]] - -# RS(256,239) :: 239 data symbols, 17 parity symbols -assert RS(256,239).data == 239 -assert RS(256,239).parity == 17 - -# Choose some N for symbolBytes -N = 1 -# For RS(256,239) fill data such that -assert data.len == 239 -for i in data: assert i.len == N * 64 - -# Encode -let - parityData = RS(256,239).encode data - -assert parityData.isOk -assert parityData.get.len == 17 - -# Poke up to 17 holes total in data and parityData -var - daWithHoles = data - paWithHoles = parityData.get - -daWithHoles[9] = @[] -daWithHoles[53] = @[] -daWithHoles[208] = @[] -# ... -paWithHoles[1] = @[] -paWithHoles[4] = @[] -# ... - -# Decode -let - recoveredData = RS(256,239).decode(daWithHoles, paWithHoles, (N * 64).uint) - -if recoveredData.isOk: - assert recoveredData.get == data - assert recoveredData.get != daWithHoles -else: - # More than 17 holes were poked - assert recoveredData.error.code == LeopardNeedMoreData -``` +TODO ### OpenMP