Struct ValueVecLayout 

pub struct ValueVecLayout {
    pub n_const: usize,
    pub n_inout: usize,
    pub n_witness: usize,
    pub n_internal: usize,
    pub n_scratch: usize,
}

Description of a layout of the value vector for a particular circuit.

This is the compiler’s view of the value vector: it names every section the circuit allocates, including the ones a ConstraintSystem has no interest in — the split of the private segment into declared witness and gate-created internal values, and the scratch tail used only while evaluating the circuit.

The sections are stored back to back, with no padding between them:

[ constants | inout ][ witness | internal ][ scratch ]
 \-- public values -/ \--- private values -/

The proving protocol pads the two committed segments to the widths its reductions need, which ConstraintSystem derives; none of that padding is stored here.

Fields

n_const: usize

The number of the constants declared by the circuit.

n_inout: usize

The number of the input output parameters declared by the circuit.

n_witness: usize

The number of the witness parameters declared by the circuit.

n_internal: usize

The number of the internal values declared by the circuit.

Those are outputs and intermediaries created by the gates.

n_scratch: usize

The number of scratch values at the end of the value vec.

Implementations

impl ValueVecLayout

pub const fn offset_inout(&self) -> usize

Returns the word at which the inout values start.

pub const fn offset_witness(&self) -> usize

Returns the word at which the private values start, which is where the public ones end.

pub const fn n_private(&self) -> usize

Returns the number of private values: the declared witness values followed by the gate-created internal ones, which share the segment.

pub const fn combined_len(&self) -> usize

Returns the combined number of public and private values, excluding scratch.

This is the length of the value vector prefix that constraint operands can reference.

pub const fn word_offset(&self, index: ValueIndex) -> usize

Returns the flat position of the word a ValueIndex names, counting the scratch tail.

pub fn constraint_system_shape(&self, constants: Vec<Word>) -> ConstraintSystem

Returns the constraint system shape this layout realizes.

The returned system has no constraints; the caller fills them in.

Panics

Panics if the constant count does not match the layout’s.

Trait Implementations

impl Clone for ValueVecLayout

fn clone(&self) -> ValueVecLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValueVecLayout

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

Formats the value using the given formatter.

impl PartialEq for ValueVecLayout

fn eq(&self, other: &ValueVecLayout) -> 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 Eq for ValueVecLayout

impl StructuralPartialEq for ValueVecLayout