add: primitives FiniteField and PrimeField

[supragya]

No description provided.

[coderabbitai]

Walkthrough

This update introduces two new modules to the primitives library: finitefield and primefield. The finitefield.rs file defines the FiniteField trait, which sets up the framework for arithmetic operations in a finite field, while primefield.rs introduces a PrimeField struct for elements in a prime-order field, including functions for compile-time prime checking and primitive root finding.

Changes

File	Change Summary
primitives/src/lib.rs	Added new modules finitefield and primefield
primitives/src/finitefield.rs	Introduced FiniteField trait defining arithmetic operations and properties for finite fields
primitives/src/primefield.rs	Added PrimeField struct, compile-time prime checking functions, multiplicative generator methods, and quadratic residue checks

Poem

In the land of code where numbers play,
Fields of prime now lead the way,
Finite rules and traits align,
Arithmetic waltz, so divine.
From zero to unity, each step's a rhyme,
In the primitives of prime.
🌟✨📐

---

Tip

Early access features: enabled

We are currently testing the following features in early access:

• OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• Please join our Discord Community to provide feedback and report issues.
• OSS projects are currently opted into early access features by default.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1226080 and ff6e4d5.

Files ignored due to path filters (2)

• Cargo.toml is excluded by !**/*.toml
• primitives/Cargo.toml is excluded by !**/*.toml

Files selected for processing (3)

• primitives/src/finitefield.rs (1 hunks)
• primitives/src/lib.rs (1 hunks)
• primitives/src/primefield.rs (1 hunks)

Files skipped from review due to trivial changes (1)

• primitives/src/lib.rs

Additional comments not posted (14)

primitives/src/finitefield.rs (7)

1-2: Typographical error in module documentation.

Correct the typo in the module documentation.

- //! This module containt the definition of the trait `FiniteField`
+ //! This module contains the definition of the trait `FiniteField`

---

3-7: LGTM!

The imports are appropriate and necessary for the trait definition.

---

9-16: LGTM!

The documentation provides a clear and informative definition of a field and a finite field.

---

17-47: LGTM!

The trait bounds are comprehensive and appropriate for a finite field.

---

50-61: LGTM!

The associated constants are appropriate for a finite field. The names and descriptions are clear.

---

63-88: LGTM!

The required implementations are appropriate for a finite field. The primitive_root_of_unity method is well-documented and correctly implemented.

---

80-88: LGTM!

The optional implementation of primitive_root_of_unity is appropriate and correctly implemented.

primitives/src/primefield.rs (7)

1-2: Typographical error in module documentation.

Correct the typo in the module documentation.

- //! This module containt the definition of struct `PrimeField`
+ //! This module contains the definition of struct `PrimeField`

---

3-3: LGTM!

The import is appropriate and necessary for the PrimeField struct definition.

---

5-10: LGTM!

The documentation provides a clear and informative definition of the PrimeField struct. The struct definition is appropriate.

---

12-31: LGTM!

The compile-time functions for prime checking and ensuring the prime property are appropriate and correctly implemented.

---

40-49: LGTM!

The implementation of the FiniteField trait for the PrimeField struct is appropriate and correctly implemented.

---

51-57: LGTM!

The constructor for the PrimeField struct is appropriate and correctly implemented.

---

59-90: LGTM!

The method is_quadratic_residue is well-documented and correctly implemented following Euler's criterion.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ff6e4d5 and 56444dc.

Files selected for processing (1)

• primitives/src/primefield.rs (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• primitives/src/primefield.rs