Refactoring: Improve poly-commitment docs & decrease confusing variable names #2811
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.
This is a no-op docs/naming refactoring commit that does the following:
combine_polys
topoly-commitment/src/utils.rs
(there was a comment left by someone that this is a good idea; I agree)combine_polys
and related structs, likePolynomialsToCombine
.combine_polys
: "omegas" was used which is (1) only used once in the whole repo, and (2) is absolutely not descriptive, since it has no r. Was replaced byhiding/non_hiding
functions, that are actually operating over the integer expressing the number of chunks, not the size of the domain as the previous variable implied."xi"
, which was a very rarely used term to callpolyscale
, also known asu
(not to be confused with the three otheru
s int he code). Usedpolyscale
instead.xi
is used more on the ocaml side, but my plan is to remove it from there too. See the justification below.Parent
mina
PR:On
xi
and justification for not using it:xi = polyscale = v
andr = evalscale = u
which is a /pain/ for someone trying to make sense of what's happening. What's even worse, the termu
means at least two other things: a generator in the IPA procedure, and the IPA challenge.xi/r
pair of these three, for the following reasons:u
andv
.u
andv
(with references topolyscale
andevalscale
).proof-systems
except some 10 lines usesu/v
orpolyscale/evalscale
.r
is a terribly overloaded variable name, which probably means about 5 things across the codebase already (e.g.r
inschnorr.ml
orsignature.ml
, e.g.l
andr
inplonk_constraint_system.ml
). So I'm strongly against using it as a global identifier if possible.polyscale
. I think it's acceptable to keep two notations, one concise-mathematical, one globally-identifiable and code-friendly. So one mathematical notation should go, andxi / r
is the most ambiguous of the two and least used.