Documentation for multi-opening methods #129
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
…tions; shifted batch_open into a more logical position
Antonio95
requested review from
Pratyush,
mmagician and
weikengchen
and removed request for
a team
mmagician
reviewed
Oct 25, 2023
src/lib.rs
Outdated
Comment on lines
250
to
258
| /// Behaviour is undefined if `query_set` contains the entries with the | ||
| /// same point label but different actual points. | ||
| /// | ||
| /// The opening challenges are independent for each batch of polynomials. | ||
| /// | ||
| /// The default implementation achieves this by rearranging the queries in | ||
| /// order to gather (i.e. batch) all polynomials that should be queried at | ||
| /// the same point, then opening their commitments simultaneously with a | ||
| /// single call to `open` (per point) |
There was a problem hiding this comment.
@Antonio95 as you pointed out offline, I think this indeed belongs to the inline comment of the default implementation rather than on the trait.
There was a problem hiding this comment.
Agreed. Done! thanks
Co-authored-by: mmagician <marcin.gorny.94@protonmail.com>
mmagician
added a commit
to NP-Eng/poly-commit
that referenced
this pull request
Nov 15, 2023
* added documentation for batch_{check, open} and {check, open} combinations; shifted batch_open into a more logical position
* Update src/lib.rs
Co-authored-by: mmagician <marcin.gorny.94@protonmail.com>
* moved description of default implementations into function body
---------
Co-authored-by: mmagician <marcin.gorny.94@protonmail.com>
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
Added documentation for
batch_open,batch_check,open_combinationsandcheck_combinations, as well as an auxiliary method.The
batch_openmethod has been moved to a more logical place inside thelib.rsfile (yielding the method order from the preceding sentence).Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
Pendingsection inCHANGELOG.mdFiles changedin the Github PR explorer