Struct R1CS 

pub struct R1CS<F: Field> { /* private fields */ }

R1CS holds the three sparse matrices A, B, C together with the configuration.

Implementations

impl<F: Field> R1CS<F>

pub fn new( n_constraints: usize, n_variables: usize, n_public_inputs: usize, matrices: [Matrix<F>; 3], ) -> Result<Self, Error>

R1CS::new creates a new R1CS structure from the given configuration and matrices.

pub fn validate(&self) -> Result<(), Error>

R1CS::validate checks that the structural invariant of the R1CS holds, i.w., every matrix has exactly m rows (one per constraint), and no column index reaches beyond the n variables.

pub fn new_without_validity_check( n_constraints: usize, n_variables: usize, n_public_inputs: usize, matrices: [Matrix<F>; 3], ) -> Self

R1CS::new_without_validity_check creates a new R1CS structure from the given configuration and matrices without checking their validity.

pub fn evaluate_r1cs( &self, z: Assignments<F, impl AsRef<[F]> + Sync>, ) -> Result<Vec<F>, Error>

R1CS::evaluate_r1cs evaluates the R1CS relation at a given vector of assignments z.

This method is simply a wrapper of CCS::evaluate_ccs with fixed coefficients and multisets.

Trait Implementations

impl<F: PrimeField, ConstraintF: PrimeField, FVar: AllocVar<F, ConstraintF>> AllocVar<R1CS<F>, ConstraintF> for R1CSMatricesVar<FVar>

fn new_variable<T: Borrow<R1CS<F>>>( cs: impl Into<Namespace<ConstraintF>>, f: impl FnOnce() -> Result<T, SynthesisError>, mode: AllocationMode, ) -> Result<Self, SynthesisError>

Allocates a new variable of type Self in the ConstraintSystem cs. The mode of allocation is decided by mode.

fn new_constant( cs: impl Into<Namespace<F>>, t: impl Borrow<V>, ) -> Result<Self, SynthesisError>

Allocates a new constant of type Self in the ConstraintSystem cs.

fn new_input<T>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, ) -> Result<Self, SynthesisError>

where T: Borrow<V>,

Allocates a new public input of type Self in the ConstraintSystem cs.

fn new_witness<T>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, ) -> Result<Self, SynthesisError>

where T: Borrow<V>,

Allocates a new private witness of type Self in the ConstraintSystem cs.

fn new_variable_with_inferred_mode<T>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, ) -> Result<Self, SynthesisError>

where T: Borrow<V>,

Allocates a new constant or private witness of type Self in the ConstraintSystem cs with the allocation mode inferred from cs. A constant is allocated if cs is None, and a private witness is allocated otherwise.

impl<F: Field> Arith for R1CS<F>

fn config(&self) -> ArithConfig

Arith::config returns the configuration of the constraint system.

impl<F: Field> ArithRelation<RelaxedWitness<&[F]>, RelaxedInstance<&[F]>> for R1CS<F>

type Evaluation = Vec<F>

ArithRelation::Evaluation defines the type of the evaluation result returned by ArithRelation::eval_relation, and consumed by ArithRelation::check_evaluation.

fn eval_relation( &self, w: &RelaxedWitness<&[F]>, u: &RelaxedInstance<&[F]>, ) -> Result<Self::Evaluation, Error>

ArithRelation::eval_relation evaluates the constraint system at witness w and instance u. It returns the evaluation result.

fn check_evaluation( w: &RelaxedWitness<&[F]>, _u: &RelaxedInstance<&[F]>, v: Self::Evaluation, ) -> Result<(), Error>

ArithRelation::check_evaluation checks if the evaluation result is valid. The witness w and instance u are also parameters, because the validity check may need information contained in w and/or u.

impl<F: Field, W: AsRef<[F]>, U: AsRef<[F]>> ArithRelation<W, U> for R1CS<F>

type Evaluation = Vec<F>

ArithRelation::Evaluation defines the type of the evaluation result returned by ArithRelation::eval_relation, and consumed by ArithRelation::check_evaluation.

fn eval_relation(&self, w: &W, x: &U) -> Result<Self::Evaluation, Error>

ArithRelation::eval_relation evaluates the constraint system at witness w and instance u. It returns the evaluation result.

fn check_evaluation(_w: &W, _x: &U, e: Self::Evaluation) -> Result<(), Error>

ArithRelation::check_evaluation checks if the evaluation result is valid. The witness w and instance u are also parameters, because the validity check may need information contained in w and/or u.

impl<F: Field> CCS for R1CS<F>

type Field = F

CCS::Field specifies the underlying field of a CCS instance

fn matrices(&self) -> &[Matrix<Self::Field>]

CCS::matrices returns the matrices contained in a concrete CCS instance self.

fn evaluate_ccs<const Q: usize>( &self, z: Assignments<Self::Field, impl AsRef<[Self::Field]> + Sync>, multisets: [Vec<usize>; Q], coefficients: [Self::Field; Q], ) -> Result<Vec<Self::Field>, Error>

CCS::evaluate_ccs evaluates the CCS relation at a given vector of assignments, multisets, and coefficients.

fn mles( &self, z: Assignments<Self::Field, impl AsRef<[Self::Field]> + Sync>, ) -> Vec<DenseMultilinearExtension<Self::Field>>

CCS::mles returns the multilinear extensions of all CCS matrices M_i evaluated over the assignments z.

impl<F: Field> CanonicalDeserialize for R1CS<F>

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

The general deserialize method that takes in customization flags.

fn deserialize_compressed<R>(reader: R) -> Result<Self, SerializationError>

where R: Read,

Reads Self from reader using the compressed form if applicable. Performs validation if applicable.

fn deserialize_compressed_unchecked<R>( reader: R, ) -> Result<Self, SerializationError>

where R: Read,

Reads Self from reader using the compressed form if applicable, without validating the deserialized value.

fn deserialize_uncompressed<R>(reader: R) -> Result<Self, SerializationError>

where R: Read,

Reads Self from reader using the uncompressed form. Performs validation if applicable.

fn deserialize_uncompressed_unchecked<R>( reader: R, ) -> Result<Self, SerializationError>

where R: Read,

Reads Self from reader using the uncompressed form, without validating the deserialized value.

impl<F: Field> CanonicalSerialize for R1CS<F>

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

The general serialize method that takes in customization flags.

fn serialized_size(&self, compress: Compress) -> usize

Returns the size in bytes of the serialized version of self with the given compression mode.

fn serialize_compressed<W>(&self, writer: W) -> Result<(), SerializationError>

where W: Write,

Serializes self into writer using the compressed form if applicable.

fn compressed_size(&self) -> usize

Returns the size in bytes of the compressed serialized version of self.

fn serialize_uncompressed<W>(&self, writer: W) -> Result<(), SerializationError>

where W: Write,

Serializes self into writer using the uncompressed form.

fn uncompressed_size(&self) -> usize

Returns the size in bytes of the uncompressed serialized version of self.

impl<F: Clone + Field> Clone for R1CS<F>

fn clone(&self) -> R1CS<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Field> Debug for R1CS<F>

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

Formats the value using the given formatter.

impl<F: Default + Field> Default for R1CS<F>

fn default() -> R1CS<F>

Returns the “default value” for a type.

impl<F: Field> From<&ConstraintSystem<F>> for R1CS<F>

fn from(cs: &ConstraintSystem<F>) -> Self

Converts to this type from the input type.

impl<F: Field> From<ConstraintSystem<F>> for R1CS<F>

fn from(cs: ConstraintSystem<F>) -> Self

Converts to this type from the input type.

impl<F: PartialEq + Field> PartialEq for R1CS<F>

fn eq(&self, other: &R1CS<F>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<F: PartialEq + Field> StructuralPartialEq for R1CS<F>

impl<F: Field> Valid for R1CS<F>

fn check(&self) -> Result<(), SerializationError>

Checks whether self is valid. If self is valid, returns Ok(()). Otherwise, returns an error describing the failure. This method is called by deserialize_with_mode if validate is Validate::Yes.

const TRIVIAL_CHECK: bool = false

Whether the check method is trivial (i.e. always returns Ok(())). If this is true, the batch_check method will skip all checks and return Ok(()). This should be set to true for types where check is trivial, e.g. integers, field elements, etc. This is false by default. This is primarily an optimization to skip unnecessary checks in batch_check.

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

Checks whether all items in batch are valid. If all items are valid, returns Ok(()). Otherwise, returns an error describing the first failure.