Skip to content

docs(gr1cs): correct InternedField representation; remove misleading 64-bit bit layout #418

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(gr1cs): correct InternedField representation; remove misleading 64-bit bit layout #418

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 12 additions & 4 deletions relations/src/gr1cs/field_interner.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,19 @@ use ark_ff::Field;

use crate::utils::IndexMap;

/// Interned field element:
/// Interned field element.
///
/// * bit 0 – tag: 0 = inline constant, 1 = pooled
/// * bits 1-23 (23 b) – signed small constant (two’s complement)
/// * bits 24-63 (40 b) – index into the coefficient pool
/// Representation:
/// - `InternedField(0)` represents `F::ONE`.
/// - `InternedField(1)` represents `-F::ONE`.
/// - `InternedField(n)` for `n >= 2` is an index into `FieldInterner::vec`.
///
/// Notes:
/// - `InternedField` is an opaque handle; there are no bit tags or inline
/// small-constant encodings.
/// - Capacity is bounded by `u32::MAX` due to the `u32` index.
/// - Use `FieldInterner::get_or_intern` to obtain handles and
/// `FieldInterner::value` to recover field elements.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Ord, PartialOrd, Hash)]
pub struct InternedField(u32);

Expand Down