Trait IntegerInstructions

pub trait IntegerInstructions<F: PrimeField>: Clone + Debug {
    type Context: Debug;
    type AssignedCell: Clone + Debug;
    type AssignedInteger: Clone + Debug;

    // Required methods
    fn assign_integer(
        &self,
        ctx: &mut Self::Context,
        integer: F,
    ) -> Self::AssignedInteger;
    fn assign_constant(
        &self,
        ctx: &mut Self::Context,
        integer: F,
    ) -> Self::AssignedInteger;
    fn sum_with_coeff_and_const(
        &self,
        ctx: &mut Self::Context,
        values: &[(F, impl Deref<Target = Self::AssignedInteger>)],
        constant: F,
    ) -> Self::AssignedInteger;
    fn sum_products_with_coeff_and_const(
        &self,
        ctx: &mut Self::Context,
        values: &[(F, impl Deref<Target = Self::AssignedInteger>, impl Deref<Target = Self::AssignedInteger>)],
        constant: F,
    ) -> Self::AssignedInteger;
    fn sub(
        &self,
        ctx: &mut Self::Context,
        lhs: &Self::AssignedInteger,
        rhs: &Self::AssignedInteger,
    ) -> Self::AssignedInteger;
    fn neg(
        &self,
        ctx: &mut Self::Context,
        value: &Self::AssignedInteger,
    ) -> Self::AssignedInteger;
    fn invert(
        &self,
        ctx: &mut Self::Context,
        value: &Self::AssignedInteger,
    ) -> Self::AssignedInteger;
    fn assert_equal(
        &self,
        ctx: &mut Self::Context,
        lhs: &Self::AssignedInteger,
        rhs: &Self::AssignedInteger,
    );
    fn pow_var(
        &self,
        ctx: &mut Self::Context,
        base: &Self::AssignedInteger,
        exponent: &Self::AssignedInteger,
        max_bits: usize,
    ) -> Self::AssignedInteger;
}

Instructions to handle field element operations.

Required Associated Types

type Context: Debug

Context (either enhanced region or some kind of builder).

type AssignedCell: Clone + Debug

Assigned cell.

type AssignedInteger: Clone + Debug

Assigned integer.

Required Methods

fn assign_integer( &self, ctx: &mut Self::Context, integer: F, ) -> Self::AssignedInteger

Assign an integer witness.

fn assign_constant( &self, ctx: &mut Self::Context, integer: F, ) -> Self::AssignedInteger

Assign an integer constant.

fn sum_with_coeff_and_const( &self, ctx: &mut Self::Context, values: &[(F, impl Deref<Target = Self::AssignedInteger>)], constant: F, ) -> Self::AssignedInteger

Sum integers with coefficients and constant.

fn sum_products_with_coeff_and_const( &self, ctx: &mut Self::Context, values: &[(F, impl Deref<Target = Self::AssignedInteger>, impl Deref<Target = Self::AssignedInteger>)], constant: F, ) -> Self::AssignedInteger

Sum product of integers with coefficients and constant.

fn sub( &self, ctx: &mut Self::Context, lhs: &Self::AssignedInteger, rhs: &Self::AssignedInteger, ) -> Self::AssignedInteger

Returns lhs - rhs.

fn neg( &self, ctx: &mut Self::Context, value: &Self::AssignedInteger, ) -> Self::AssignedInteger

Returns -value.

fn invert( &self, ctx: &mut Self::Context, value: &Self::AssignedInteger, ) -> Self::AssignedInteger

Returns 1/value.

fn assert_equal( &self, ctx: &mut Self::Context, lhs: &Self::AssignedInteger, rhs: &Self::AssignedInteger, )

Enforce lhs and rhs are equal.

fn pow_var( &self, ctx: &mut Self::Context, base: &Self::AssignedInteger, exponent: &Self::AssignedInteger, max_bits: usize, ) -> Self::AssignedInteger

Returns base^exponent and constrains that exponent has at most max_bits bits.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<F: BigPrimeField> IntegerInstructions<F> for GateChip<F>

type Context = SinglePhaseCoreManager<F>

type AssignedCell = AssignedValue<F>

type AssignedInteger = AssignedValue<F>

fn assign_integer( &self, ctx: &mut Self::Context, integer: F, ) -> Self::AssignedInteger

fn assign_constant( &self, ctx: &mut Self::Context, integer: F, ) -> Self::AssignedInteger

fn sum_with_coeff_and_const( &self, ctx: &mut Self::Context, values: &[(F, impl Deref<Target = Self::AssignedInteger>)], constant: F, ) -> Self::AssignedInteger

fn sum_products_with_coeff_and_const( &self, ctx: &mut Self::Context, values: &[(F, impl Deref<Target = Self::AssignedInteger>, impl Deref<Target = Self::AssignedInteger>)], constant: F, ) -> Self::AssignedInteger

fn sub( &self, ctx: &mut Self::Context, a: &Self::AssignedInteger, b: &Self::AssignedInteger, ) -> Self::AssignedInteger

fn neg( &self, ctx: &mut Self::Context, a: &Self::AssignedInteger, ) -> Self::AssignedInteger

fn invert( &self, ctx: &mut Self::Context, a: &Self::AssignedInteger, ) -> Self::AssignedInteger

fn assert_equal( &self, ctx: &mut Self::Context, a: &Self::AssignedInteger, b: &Self::AssignedInteger, )

fn pow_var( &self, ctx: &mut Self::Context, base: &Self::AssignedInteger, exponent: &Self::AssignedInteger, max_bits: usize, ) -> Self::AssignedInteger

Implementors