docs: fix coset index little-endian and correct panic conditions#188
Open
radik878 wants to merge 1 commit into
Open
docs: fix coset index little-endian and correct panic conditions#188radik878 wants to merge 1 commit into
radik878 wants to merge 1 commit into
Conversation
radik878
commented
Sep 14, 2025
- Switch documentation from big-endian to little-endian (LSB-first) for query_position_to_coset and query_position_to_coset_elements. Implementation uses pow_le and tests use to_bits_le, so docs must reflect little-endian to avoid misuse.
- Correct “Panics” sections: functions require at least (self.dim - coset_dim) bits; extra higher bits are ignored. Previous docs incorrectly referenced equality to coset_dim/self.dim.
- Clarify elements returns up to offset*g^{coset_size-1} (off-by-one in doc) and reword coset step comment for precision.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.