Skip to content

Commit

Permalink
README.md - More references to the code
Browse files Browse the repository at this point in the history
Even if they can't be links they at least encourage the reader to look
at the code. I personally think the code does a lot to remove the magic
of the overall math.

Also fixed the reference to ramrsbd_find_λ...
  • Loading branch information
geky committed Oct 31, 2024
1 parent 098cc99 commit ce16c13
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ The actual algorithm itself is relatively simple:
shift $C(i)$ every step of the algorithm, we usually don't need to
track $m$ explicitly.

This is all implemented in `ramrsbd_find_l`.
This is all implemented in `ramrsbd_find_λ`.

#### Solving binary LFSRs for fun

Expand Down Expand Up @@ -1299,6 +1299,9 @@ Unless of course we had enough errors to end up overcorrecting to a
different codeword, but there's not much we can do in that case. No
error-correction is perfect.

This is all implemented in `ramrsbd_read`, if you're curious what it
looks like in code.

## Tricks

Heavy math aside, there are a couple minor implementation tricks worth
Expand Down

0 comments on commit ce16c13

Please sign in to comment.