Skip to content

Commit

Permalink
Reworded the correction/detection section a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
geky committed Oct 26, 2024
1 parent f9c15fa commit adb76b7
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,14 +350,15 @@ Using CRCs for error-correction has two big caveats:
1. For _any_ error-correcting code, attempting to _correct_ errors
reduces the code's ability to _detect_ errors.

In the HD=4 example, when we assumed 1 bit-error, if there were
actually 3 bit-errors, we would have assumed wrong and "corrected" to
the wrong codeword.
In the HD=4 example, we assumed 1 bit-error. If we were wrong and
there were actually 3 bit-errors, we would have "corrected" to the
wrong codeword.

In practice this isn't _that_ big of a problem. 1 bit-errors are
usually much more common than 3 bit-errors, and at 4 bit-errors you're
going to have a collision anyways. Still, this tradeoff is good to be
aware of.
going to have a collision anyways.

Still, it's good to be aware of this tradeoff.

ramcrc32bd's [`error_correction`][error-correction] config option lets
you control exactly how many bit-errors to attempt to repair in case
Expand Down

0 comments on commit adb76b7

Please sign in to comment.