Struct GoldilocksField

pub struct GoldilocksField<E: Engine> { /* private fields */ }

Implementations

impl<E: Engine> GoldilocksField<E>

pub const ORDER: u64 = 18_446_744_069_414_584_321u64

pub const ORDER_BITS: usize = 64usize

pub const REMAINDER: u64 = 4_294_967_295u64

pub fn zero() -> Self

pub fn one() -> Self

pub fn minus_one() -> Self

pub fn constant_from_field(value: GL) -> Self

pub fn constant(value: u64) -> Self

pub fn into_u64(self) -> Option<u64>

pub fn into_field(self) -> Option<GL>

pub fn is_constant(&self) -> bool

pub fn alloc<CS: ConstraintSystem<E>>( cs: &mut CS, witness: Option<E::Fr>, ) -> Result<Self, SynthesisError>

pub fn alloc_from_u64<CS: ConstraintSystem<E>>( cs: &mut CS, witness: Option<u64>, ) -> Result<Self, SynthesisError>

pub fn alloc_from_field<CS: ConstraintSystem<E>>( cs: &mut CS, witness: Option<GL>, ) -> Result<Self, SynthesisError>

pub unsafe fn from_num_unchecked(num: Num<E>) -> Result<Self, SynthesisError>

pub fn from_num<CS: ConstraintSystem<E>>( cs: &mut CS, num: Num<E>, ) -> Result<Self, SynthesisError>

pub fn into_num(&self) -> Num<E>

pub fn from_num_to_multiple_with_reduction<CS: ConstraintSystem<E>, const N: usize>( cs: &mut CS, num: Num<E>, ) -> Result<[Self; N], SynthesisError>

This function is used in SNARK-wrapper to get Goldilocks challenges from random Bn256 scalar field element. Usually, we use N = 3. Note: we lose some information during this conversion, but it’s OK. We only care about good output distribution.

pub fn negate<CS: ConstraintSystem<E>>( &self, cs: &mut CS, ) -> Result<Self, SynthesisError>

pub fn add<CS: ConstraintSystem<E>>( &self, cs: &mut CS, other: &Self, ) -> Result<Self, SynthesisError>

pub fn inverse<CS: ConstraintSystem<E>>( &self, cs: &mut CS, ) -> Result<Self, SynthesisError>

pub fn mul<CS: ConstraintSystem<E>>( &self, cs: &mut CS, other: &Self, ) -> Result<Self, SynthesisError>

pub fn mul_add<CS: ConstraintSystem<E>>( &self, cs: &mut CS, other: &Self, third: &Self, ) -> Result<Self, SynthesisError>

self * other + third

pub fn equals<CS: ConstraintSystem<E>>( cs: &mut CS, this: &Self, other: &Self, ) -> Result<Boolean, SynthesisError>

pub fn enforce_equal<CS: ConstraintSystem<E>>( &self, cs: &mut CS, other: &Self, ) -> Result<(), SynthesisError>

pub fn conditionally_select<CS: ConstraintSystem<E>>( cs: &mut CS, bit: Boolean, first: &Self, second: &Self, ) -> Result<Self, SynthesisError>

pub fn spread_into_bits<CS: ConstraintSystem<E>, const LIMIT: usize>( &self, cs: &mut CS, ) -> Result<[Boolean; LIMIT], SynthesisError>

Trait Implementations

impl<E> Clone for GoldilocksField<E>

where E: Clone + Engine,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E: Engine> Debug for GoldilocksField<E>

fn fmt(&self, __f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<E> Default for GoldilocksField<E>

where E: Default + Engine,

fn default() -> Self

Returns the “default value” for a type.

impl<E: Engine, CS: ConstraintSystem<E>> From<GoldilocksField<E>> for GoldilocksAsFieldWrapper<E, CS>

fn from(value: GoldilocksField<E>) -> Self

Converts to this type from the input type.

impl<E: Engine> Hash for GoldilocksField<E>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<E> Copy for GoldilocksField<E>

where E: Copy + Engine,