Struct ValueIndex 

pub struct ValueIndex(/* private fields */);

A type safe reference to one word of the ValueVec, as a segment and an index within it.

Representation

The pair is packed into a single u32: the ValueSegment in the top two bits and the index in the bottom Self::INDEX_BITS. Constraint systems hold millions of these, so the packing keeps a ShiftedValueIndex at eight bytes rather than twelve.

The packing also makes the derived Ord order the words by segment and then by index, which is the order they occupy in the value vector.

Implementations

impl ValueIndex

pub const INDEX_BITS: u32 = 30

The number of bits the index occupies, the segment tag taking the remaining two.

pub const SEGMENT_CAPACITY: u32

The number of values one segment can hold.

pub const fn new(segment: ValueSegment, index: u32) -> Self

Creates an index naming the given word of the given segment.

Panics

Panics if the index is not below Self::SEGMENT_CAPACITY.

pub const fn constant(index: u32) -> Self

Creates an index naming a constant.

pub const fn inout(index: u32) -> Self

Creates an index naming an inout value.

pub const fn private(index: u32) -> Self

Creates an index naming a private value.

pub const fn scratch(index: u32) -> Self

Creates an index naming a scratch word.

pub const fn segment(self) -> ValueSegment

The segment this index names.

pub const fn index(self) -> u32

The index within Self::segment.

Trait Implementations

impl Clone for ValueIndex

fn clone(&self) -> ValueIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValueIndex

Prints the segment and index rather than the packed word, which reads as a nonsense integer.

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

Formats the value using the given formatter.

impl DeserializeBytes for ValueIndex

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

where Self: Sized,

impl Hash for ValueIndex

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<ValueIndex> for ValueVec

type Output = Word

The returned type after indexing.

fn index(&self, index: ValueIndex) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<ValueIndex> for ValueVec

fn index_mut(&mut self, index: ValueIndex) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Ord for ValueIndex

fn cmp(&self, other: &ValueIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ValueIndex

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

fn partial_cmp(&self, other: &ValueIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl SerializeBytes for ValueIndex

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

impl Copy for ValueIndex

impl Eq for ValueIndex

impl StructuralPartialEq for ValueIndex