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

chore: clarify to_radix docs examples #7230

Merged
merged 1 commit into from
Jan 29, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions noir_stdlib/src/field/mod.nr
Original file line number Diff line number Diff line change
Expand Up @@ -384,19 +384,31 @@ mod tests {
#[test]
// docs:start:to_be_radix_example
fn test_to_be_radix() {
let field = 2;
// 259, in base 256, big endian, is [1, 3].
// i.e. 3 * 256^0 + 1 * 256^1
let field = 259;

// The radix (in this example, 256) must be a power of 2.
// The length of the returned byte array can be specified to be
// >= the amount of space needed.
let bytes: [u8; 8] = field.to_be_radix(256);
assert_eq(bytes, [0, 0, 0, 0, 0, 0, 0, 2]);
assert_eq(bytes, [0, 0, 0, 0, 0, 0, 1, 3]);
assert_eq(Field::from_be_bytes::<8>(bytes), field);
}
// docs:end:to_be_radix_example

#[test]
// docs:start:to_le_radix_example
fn test_to_le_radix() {
let field = 2;
// 259, in base 256, little endian, is [3, 1].
// i.e. 3 * 256^0 + 1 * 256^1
let field = 259;

// The radix (in this example, 256) must be a power of 2.
// The length of the returned byte array can be specified to be
// >= the amount of space needed.
let bytes: [u8; 8] = field.to_le_radix(256);
assert_eq(bytes, [2, 0, 0, 0, 0, 0, 0, 0]);
assert_eq(bytes, [3, 1, 0, 0, 0, 0, 0, 0]);
assert_eq(Field::from_le_bytes::<8>(bytes), field);
}
// docs:end:to_le_radix_example
Expand Down
Loading