Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modification of documentation for convolutional encoding #16

Closed
icyveins7 opened this issue Feb 13, 2018 · 0 comments
Closed

Modification of documentation for convolutional encoding #16

icyveins7 opened this issue Feb 13, 2018 · 0 comments
Assignees

Comments

@icyveins7
Copy link

The Trellis function has the argument for the generator polynomial marked as

g_matrix : 2D ndarray of ints (octal representation)

i.e. base 8 polynomial. This is extremely misleading as the actual argument expected is that of a standard base 10 integer (the function calls the utility function dec2bin). This doesn't cause problems in the examples as the polynomials used there are less than 8, but upon implementing anything with longer memory the output was all wrong and caused a big headache.

Suggestion: amend the documentation to denote g_matrix as base 10.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants