Struct OodFrame

pub struct OodFrame { /* private fields */ }

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.

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

impl OodFrame

pub fn set_trace_states<E, H>( &mut self, trace_ood_frame: &TraceOodFrame<E>, ) -> <H as Hasher>::Digest

where E: FieldElement, H: ElementHasher<BaseField = <E as FieldElement>::BaseField>,

Updates the trace state portion of this out-of-domain frame, and returns the hash of the trace states.

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.

pub fn set_constraint_evaluations<E>(&mut self, evaluations: &[E])

where E: FieldElement,

Updates constraint evaluation portion of this out-of-domain frame.

Panics

Panics if:

• Constraint evaluations have already been set.
• evaluations is an empty vector.

pub fn parse<E>( self, main_trace_width: usize, aux_trace_width: usize, num_evaluations: usize, ) -> Result<(TraceOodFrame<E>, Vec<E>), DeserializationError>

where E: FieldElement,

Returns an out-of-domain trace frame and a vector of out-of-domain constraint evaluations contained in self.

Panics

Panics if either main_trace_width or num_evaluations are equal to zero.

Errors

Returns an error if:

• Valid crate::EvaluationFrames for the specified main_trace_width and aux_trace_width could not be parsed from the internal bytes.
• A vector of evaluations specified by num_evaluations could not be parsed from the internal bytes.
• Any unconsumed bytes remained after the parsing was complete.

Trait Implementations

impl Clone for OodFrame

fn clone(&self) -> OodFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OodFrame

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

Formats the value using the given formatter.

impl Default for OodFrame

fn default() -> OodFrame

Returns the “default value” for a type.

impl Deserializable for OodFrame

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

where R: ByteReader,

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.

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

Attempts to deserialize the provided bytes into Self and returns the result.

impl PartialEq for OodFrame

fn eq(&self, other: &OodFrame) -> 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.

impl Serializable for OodFrame

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

where W: ByteWriter,

Serializes self and writes the resulting bytes into the target.

fn get_size_hint(&self) -> usize

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

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

Serializes self into a vector of bytes.

impl Eq for OodFrame

impl StructuralPartialEq for OodFrame