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

Documentation of KZGSettings (Branch das) #439

Open
b-wagn opened this issue Jun 18, 2024 · 0 comments
Open

Documentation of KZGSettings (Branch das) #439

b-wagn opened this issue Jun 18, 2024 · 0 comments

Comments

@b-wagn
Copy link

b-wagn commented Jun 18, 2024

Note: this issue is about this branch.

When reading the code, I felt that the different fields related to roots of unity in KZGSettings (here) are a bit confusing.
This includes the fields roots_of_unity, expanded_roots_of_unity, and reverse_roots_of_unity.

As a result, it is a bit hard to understand code that uses these fields, or to modify code properly if needed.
For example, here are some questions that I can not immediately resolve from the documentation.
A better documentation and more consistent naming could help to identify what they are.
The main questions that the comments/naming should address for each field are the following:

  • Is the field related to a blob or to an extended blob?
  • How long is the field, i.e., how many elements does it contain?
  • Are these roots in reverse bit ordering or not?
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

1 participant