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

Improve existing documentation for the stark-felt crate. #10

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

nils-mathieu
Copy link
Contributor

@nils-mathieu nils-mathieu commented Oct 24, 2023

This pull request provide some additional documentation to the methods defined for the Felt type.

Important Notes

One of the examples I made for inverse_mod do not pass. Here is the bogus example:

use stark_felt::{Felt, NonZeroFelt};
let a = Felt::from(3);
let p = Felt::from(5).try_into().unwrap();

let b = a.inverse_mod(&p).unwrap();
assert_eq!(a.mul_mod(&b, &p), Felt::ONE);

This do not pass.

Apparently, b is computed to be 4 instead of 2.

I'll open an issue for that.

State

Blocked by #11 .

crates/stark-felt/src/lib.rs Outdated Show resolved Hide resolved
@0xLucqs 0xLucqs requested a review from pefontana as a code owner June 29, 2024 09:15
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

Successfully merging this pull request may close these issues.

3 participants