From_str for PolyRingZq #411
Merged
Conversation
This file contains 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
Marcel583
added
documentation📖
Marvin-Beckmann
approved these changes
Sep 25, 2024
| @@ -31,7 +31,7 @@ impl MatZ { | |||
| /// to the standard deviation `sigma * sqrt(2 * pi) = s` | |||
| /// | |||
| /// Returns a matrix with each entry sampled independently from the | |||
| /// specified discrete Gaussian distribution. | |||
| /// specified discrete Gaussian distribution or an error if the `n <= 1` or `s <= 0`. | |||
There was a problem hiding this comment.
Suggested change
| /// specified discrete Gaussian distribution or an error if the `n <= 1` or `s <= 0`. | |
| /// specified discrete Gaussian distribution or an error if `n <= 1` or `s <= 0`. |
| @@ -81,7 +81,9 @@ impl MatZ { | |||
| /// - `s`: specifies the Gaussian parameter, which is proportional | |||
| /// to the standard deviation `sigma * sqrt(2 * pi) = s` | |||
| /// | |||
| /// Returns a lattice vector sampled according to the discrete Gaussian distribution. | |||
| /// Returns a lattice vector sampled according to the discrete Gaussian distribution | |||
| /// or an error if the `n <= 1` or `s <= 0`, the number of rows of the `basis` and `center` differ, | |||
There was a problem hiding this comment.
Suggested change
| /// or an error if the `n <= 1` or `s <= 0`, the number of rows of the `basis` and `center` differ, | |
| /// or an error if `n <= 1` or `s <= 0`, the number of rows of the `basis` and `center` differ, |
see the others as well -> this occurs more often
Comment on lines
151
to
+152
| /// - Returns a [`MathError`] of type [`InvalidIntegerInput`](MathError::InvalidIntegerInput) | ||
| /// if the `base` is not greater than `1`. | ||
| /// if the `base` is smaller than `2`. |
There was a problem hiding this comment.
maybe look for subseuent changes in crypto
Comment on lines
+184
to
+186
| mod test_from_str { | ||
| use super::PolynomialRingZq; | ||
| use std::str::FromStr; |
There was a problem hiding this comment.
you can also call to_string on PolynomialRingZq options. Please add a test where you instantiate a PolynomialRingZq, then call to_string and then use from_str to reinitiate
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.
Description
This PR implements from_str for PolyRingZq and refactors Doc comments (casing and spacing in parameters, punctuation in Returns, Adding missing error explanations and minor spelling mistakes).
Testing
Checklist: