Struct ValueVecLayout 

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

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

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.

offset_inout: usize

The offset at which inout parameters start.

offset_witness: usize

The offset at which witness parameters start.

The public section of the value vec has the power-of-two size and is greater than the minimum number of words. By public section we mean the constants and the inout values.

n_hidden_words: usize

The number of words in the hidden segment: the witness and internal values, including padding up to the segment length. This does not include the public segment or any scratch values.

n_scratch: usize

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

Implementations

impl ValueVecLayout

pub const MIN_WORDS_PER_SEGMENT: usize = 2

The minimum number of words in the public segment.

Self::validate rejects any layout whose public segment is shorter than this.

pub const fn validate(&self) -> Result<(), ConstraintSystemError>

Validates that the value vec layout has a correct shape.

Specifically checks that:

• the public segment (constants and inout values) is padded to the power of two.
• the public segment is not less than the minimum size.
• the hidden segment is at least as long as the public segment, so Self::log_witness_words is at least Self::log_public_words.

pub const fn n_public_words(&self) -> usize

Returns the number of words in the public segment: the constants and inout values, including padding up to the power-of-two segment length.

pub const fn log_public_words(&self) -> usize

Returns the base-2 logarithm of the public segment length in words.

Self::validate guarantees that the public segment length is a power of two.

pub const fn combined_len(&self) -> usize

Returns the combined number of public and hidden words, excluding scratch.

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

pub const fn log_witness_words(&self) -> usize

Returns the base-2 logarithm of the hidden segment length in words, rounded up to a power of two.

Self::validate guarantees this is at least Self::log_public_words.

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 DeserializeBytes for ValueVecLayout

fn deserialize(read_buf: impl Buf) -> Result<Self, SerializationError>

where Self: Sized,

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 SerializeBytes for ValueVecLayout

fn serialize(&self, write_buf: impl BufMut) -> Result<(), SerializationError>

impl Eq for ValueVecLayout

impl StructuralPartialEq for ValueVecLayout