Struct AssignedMsm 

pub struct AssignedMsm<S: SelfEmulation> { /* private fields */ }

Type for in-circuit multi-scalar multiplications.

This is the in-circuit analog of Msm<C>.

Implementations

impl<S: SelfEmulation> AssignedMsm<S>

pub fn as_public_input_with_committed_scalars( msm: &Msm<S>, ) -> (Vec<S::F>, Vec<S::F>)

Converts the off-circuit MSM into two vectors of scalars. The first will be used as a normal instance, whereas the second will be plugged-in in as a committed instance.

The committed instance part corresponds to the (fixed and non-fixed) scalars of the MSM.

impl<S: SelfEmulation> AssignedMsm<S>

pub fn assign( layouter: &mut impl Layouter<S::F>, curve_chip: &S::CurveChip, scalar_chip: &S::ScalarChip, len: usize, fixed_base_names: &[String], msm_value: Value<Msm<S>>, ) -> Result<Self, Error>

Witnesses an MSM computation of len bases/scalars and a BTreeMap of fixed_base_scalars indexed by the given fixed_base_names.

Warning

The points of the MSM are not enforced to be part of the relevant prime order subgroup.

Panics

If msm_value is known and its number of variable bases differs from len, or its number of fixed-base scalars differs from fixed_base_names.len().

pub fn empty() -> Self

An empty AssignedMsm with no fixed base scalars, that evaluates to the identity point.

pub fn from_term( scalar: &AssignedBoundedScalar<S::F>, base: &S::AssignedPoint, ) -> Self

Creates a new MSM from the given base (with a scalar of 1).

pub fn from_fixed_term( scalar: &AssignedBoundedScalar<S::F>, base_name: &str, ) -> Self

Creates a new MSM from the given fixed base name (with a scalar of 1).

pub fn add_term( &mut self, scalar: &AssignedBoundedScalar<S::F>, base: &S::AssignedPoint, )

Adds a (scalar, base) term to the AssignedMsm.

pub fn add_msm( &mut self, layouter: &mut impl Layouter<S::F>, scalar_chip: &S::ScalarChip, other: &Self, ) -> Result<(), Error>

Adds two AssignedMsm.

pub fn collapse( &mut self, layouter: &mut impl Layouter<S::F>, curve_chip: &S::CurveChip, scalar_chip: &S::ScalarChip, ) -> Result<(), Error>

Evaluates the variable part of the AssignedMsm (the scalar-base pairs) collapsing it to a single point (and a scalar of 1), leaving the fixed-base part intact.

This function mutates self.

pub fn resolve_fixed_bases( &mut self, fixed_bases: &BTreeMap<String, S::AssignedPoint>, )

Given the actual fixed bases, resolves the fixed-base part of the MSM by pairing each named scalar with its base and moving them to regular variable-base entries.

After this call, fixed_base_scalars becomes empty.

Panics

If some of the keys in fixed_base_scalars do not appear in the provided fixed_bases map.

pub fn scale( &mut self, layouter: &mut impl Layouter<S::F>, scalar_chip: &S::ScalarChip, r: &AssignedBoundedScalar<S::F>, ) -> Result<(), Error>

Scales all the scalars of the AssignedMsm by the given factor r.

This function mutates self.

pub fn accumulate_with_r( &self, layouter: &mut impl Layouter<S::F>, scalar_chip: &S::ScalarChip, other: &Self, r: &AssignedBoundedScalar<S::F>, ) -> Result<Self, Error>

Accumulates two AssignedMSMs with the a given scalar r. The resulting AssignedMSMs evaluates (on fixed_bases) to self.eval(fixed_bases) + r * other.eval(fixed_bases).

Trait Implementations

impl<S: Clone + SelfEmulation> Clone for AssignedMsm<S>

where S::AssignedPoint: Clone, S::F: Clone,

fn clone(&self) -> AssignedMsm<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + SelfEmulation> Debug for AssignedMsm<S>

where S::AssignedPoint: Debug, S::F: Debug,

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

Formats the value using the given formatter.

impl<S: SelfEmulation> Eq for AssignedMsm<S>

impl<S: SelfEmulation> InnerValue for AssignedMsm<S>

type Element = Msm<S>

Represents the unassigned type corresponding to the InnerValue

fn value(&self) -> Value<Self::Element>

Returns the value of the assigned element.

impl<S: SelfEmulation> Instantiable<<S as SelfEmulation>::F> for AssignedMsm<S>

fn as_public_input(msm: &Msm<S>) -> Vec<S::F>

This function is the off-circuit analog of crate::instructions::PublicInputInstructions::as_public_input.

fn from_public_input(_fields: &[S::F]) -> Option<Msm<S>>

Inverse of Self::as_public_input: reconstructs the element from its public input representation. Returns None if fields does not encode a valid element.

impl<S: SelfEmulation> PartialEq for AssignedMsm<S>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.