OodFrame

Struct OodFrame 

Source
pub struct OodFrame { /* private fields */ }
Expand description

Trace and constraint polynomial evaluations at an out-of-domain point.

This struct contains the following evaluations:

  • Evaluations of all trace polynomials at z.
  • Evaluations of all trace polynomials at z * g.
  • Evaluations of constraint composition column polynomials at z.
  • Evaluations of constraint composition column polynomials at z * g.

where z is an out-of-domain point and g is the generator of the trace domain.

Internally, the evaluations are stored as a sequence of bytes. Thus, to retrieve the evaluations, parse() function should be used.

Implementations§

Source§

impl OodFrame

Source

pub fn set_trace_states<E>(&mut self, trace_ood_frame: &TraceOodFrame<E>)
where E: FieldElement,

Updates the trace state portion of this out-of-domain frame.

The out-of-domain frame is stored as one vector built from the concatenation of values of two vectors, the current row vector and the next row vector. Given the input frame

+—––+—––+—––+—––+—––+—––+—––+—––+ | a1 | a2 | … | an | c1 | c2 | … | cm | +—––+—––+—––+—––+—––+—––+—––+—––+ | b1 | b2 | … | bn | d1 | d2 | … | dm | +—––+—––+—––+—––+—––+—––+—––+—––+

with n being the main trace width and m the auxiliary trace width, the values are stored as

[a1, …, an, c1, …, cm, b1, …, bn, d1, …, dm]

into Self::trace_states (as byte values).

§Panics

Panics if evaluation frame has already been set.

Source

pub fn set_quotient_states<E>( &mut self, quotients_ood_frame: &QuotientOodFrame<E>, )
where E: FieldElement,

Updates constraints composition polynomials (i.e., quotient polynomials) state portion of this out-of-domain frame.

The out-of-domain frame is stored as one vector built from the concatenation of values of two vectors, the current row vector and the next row vector. Given the input frame

+—––+—––+—––+—––+—––+—––+—––+—––+ | a1 | a2 | … | … | … | … | … | an | +—––+—––+—––+—––+—––+—––+—––+—––+ | b1 | b2 | … | … | … | … | … | bn | +—––+—––+—––+—––+—––+—––+—––+—––+

with n being the number of constraints composition polynomials, the values are stored as

[a1, …, an, b1, …, bn]

into Self::quotient_states (as byte values).

§Panics

Panics if:

  • Constraint evaluations have already been set.
Source

pub fn parse<E: FieldElement>( self, main_trace_width: usize, aux_trace_width: usize, num_quotients: usize, ) -> Result<(TraceOodFrame<E>, QuotientOodFrame<E>), DeserializationError>

Returns an out-of-domain trace frame and an out-of-domain constraints evaluations frame. contained in self.

§Panics

Panics if either main_trace_width or num_evaluations are equal to zero.

§Errors

Returns an error if:

  • Valid TraceOodFrames for the specified main_trace_width and aux_trace_width could not be parsed from the internal bytes.
  • Valid QuotientOodFrames for the specified num_quotients could not be parsed from the internal bytes.
  • Any unconsumed bytes remained after the parsing was complete.

Trait Implementations§

Source§

impl Clone for OodFrame

Source§

fn clone(&self) -> OodFrame

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OodFrame

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OodFrame

Source§

fn default() -> OodFrame

Returns the “default value” for a type. Read more
Source§

impl Deserializable for OodFrame

Source§

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a OOD frame from the specified source and returns the result

§Errors

Returns an error of a valid OOD frame could not be read from the specified source.

Source§

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result. Read more
Source§

impl PartialEq for OodFrame

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serializable for OodFrame

Source§

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self and writes the resulting bytes into the target.

Source§

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

Source§

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.
Source§

impl Eq for OodFrame

Source§

impl StructuralPartialEq for OodFrame

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.