Struct LabeledPolynomial 

pub struct LabeledPolynomial<F: Field, P: Polynomial<F>> { /* private fields */ }

A polynomial along with information about its degree bound (if any), and the maximum number of queries that will be made to it. This latter number determines the amount of protection that will be provided to a commitment for this polynomial.

Implementations

impl<'a, F: Field, P: Polynomial<F>> LabeledPolynomial<F, P>

pub fn new( label: PolynomialLabel, polynomial: P, degree_bound: Option<usize>, hiding_bound: Option<usize>, ) -> Self

Construct a new labeled polynomial.

pub fn label(&self) -> &String

Return the label for self.

pub fn polynomial(&self) -> &P

Retrieve an immutable reference to the polynomial contained in self.

pub fn polynomial_mut(&mut self) -> &mut P

Retrieve a mutable reference to the polynomial contained in self

pub fn evaluate(&self, point: &P::Point) -> F

Evaluate the polynomial in self.

pub fn degree(&self) -> usize

Retrieve the degree of the polynomial in self.

pub fn degree_bound(&self) -> Option<usize>

Retrieve the degree bound in self.

pub fn is_hiding(&self) -> bool

Retrieve whether the polynomial in self should be hidden.

pub fn hiding_bound(&self) -> Option<usize>

Retrieve the hiding bound for the polynomial in self.

Trait Implementations

impl<F: Field, P: Polynomial<F>> CanonicalDeserialize for LabeledPolynomial<F, P>

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, P: Polynomial<F>> CanonicalSerialize for LabeledPolynomial<F, P>

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, P: Clone + Polynomial<F>> Clone for LabeledPolynomial<F, P>

fn clone(&self) -> LabeledPolynomial<F, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Field, P: Debug + Polynomial<F>> Debug for LabeledPolynomial<F, P>

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

Formats the value using the given formatter.

impl<'a, F: Field, P: Polynomial<F>> Deref for LabeledPolynomial<F, P>

type Target = P

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<F: Field, P: Polynomial<F>> Valid for LabeledPolynomial<F, P>

const TRIVIAL_CHECK: bool

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.