Struct PolynomialPredicate 

pub struct PolynomialPredicate<F: Field> {
    pub polynomial: SparsePolynomial<F, SparseTerm>,
}

A polynomial predicat is just a polynomial

Fields

polynomial: SparsePolynomial<F, SparseTerm>

The sparse polynomial for the predicate

Implementations

impl<F: Field> PolynomialPredicate<F>

pub fn new( arity: usize, terms: impl IntoIterator<Item = (F, Vec<(usize, usize)>)>, ) -> Self

Create a new polynomial predicate with a given number of variables (= arity) and number of terms.

Here terms is a list of tuples of the form (variable, power) where variable is the index of the variable and power is the exponent of the variable.

So, for example, if terms is [F::ONE, [(0, 1), (1, 2)]], then the polynomial is x_0 + x_1^2.

impl<F: Field> PolynomialPredicate<F>

This is the implementation of the Predicate trait for PolynomialPredicate. The evaluation of a polynomial predicate is the evaluation of the underlying polynomial and the arity is the number of variables in the polynomial.

pub fn is_satisfied(&self, variables: &[F]) -> bool

Check if the predicate is satisfied by the given variables.

pub fn eval(&self, variables: &[F]) -> F

Evaluate the predicate on the given variables.

pub fn arity(&self) -> usize

Get the arity of the polynomial predicate. For example, the arity of P(x1, x2, …, xn) is n.

pub fn degree(&self) -> usize

Get the degree of the polynomial predicate. For example, the degree of x1 + x2^4 + x3^2 is 4.

Trait Implementations

impl<F: Field> CanonicalDeserialize for PolynomialPredicate<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 PolynomialPredicate<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 PolynomialPredicate<F>

fn clone(&self) -> PolynomialPredicate<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 PolynomialPredicate<F>

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

Formats the value using the given formatter.

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

const TRIVIAL_CHECK: bool = <SparsePolynomial<F, SparseTerm> as ark_serialize::Valid>::TRIVIAL_CHECK

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 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.

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.