Struct TableWitnessIndex

pub struct TableWitnessIndex<'cs, 'alloc, P = PackedType<OptimalUnderlier, B128>>
where
    P: PackedField,
    P::Scalar: TowerField,
{ /* private fields */ }

Holds witness column data for a table, indexed by column index.

Implementations

impl<'cs, 'alloc, P> TableWitnessIndex<'cs, 'alloc, P>

where P: PackedField, P::Scalar: TowerField,

pub fn table(&self) -> &'cs Table<P::Scalar>

pub fn size(&self) -> usize

The number of table events that the index should contain.

pub fn log_capacity(&self) -> usize

pub fn min_log_segment_size(&self) -> usize

Binary logarithm of the mininimum segment size.

This is the minimum number of logical rows that can be put into one segment during iteration. It is the maximum number of logical rows occupied by a single underlier.

impl<'cs, 'alloc, F: TowerField, P: PackedField<Scalar = F>> TableWitnessIndex<'cs, 'alloc, P>

pub fn new( allocator: &'alloc Bump, table: &'cs Table<F>, size: usize, ) -> Result<Self, Error>

pub fn table_id(&self) -> TableId

pub fn capacity(&self) -> usize

pub fn full_segment(&mut self) -> TableWitnessSegment<'_, P>

Returns a witness index segment covering the entire table.

pub fn fill_sequential<T: TableFiller<P>>( &mut self, table: &T, rows: &[T::Event], ) -> Result<(), Error>

Fill a full table witness index using the given row data.

This function iterates through witness segments sequentially in a single thread.

pub fn fill_parallel<T>( &mut self, table: &T, rows: &[T::Event], ) -> Result<(), Error>

where T: TableFiller<P> + Sync, T::Event: Sync,

Fill a full table witness index using the given row data.

This function iterates through witness segments in parallel in multiple threads.

pub fn fill_sequential_with_segment_size<T: TableFiller<P>>( &mut self, table: &T, rows: &[T::Event], log_size: usize, ) -> Result<(), Error>

Fill a full table witness index using the given row data.

This function iterates through witness segments sequentially in a single thread.

pub fn fill_parallel_with_segment_size<T>( &mut self, table: &T, rows: &[T::Event], log_size: usize, ) -> Result<(), Error>

where T: TableFiller<P> + Sync, T::Event: Sync,

Fill a full table witness index using the given row data.

This function iterates through witness segments in parallel in multiple threads.

pub fn segments( &mut self, log_size: usize, ) -> impl Iterator<Item = TableWitnessSegment<'_, P>>

Returns an iterator over segments of witness index rows.

This method clamps the segment size, requested as log_size, to a minimum of self.min_log_segment_size() and a maximum of self.log_capacity(). The actual segment size can be queried on the items yielded by the iterator.

pub fn par_segments( &mut self, log_size: usize, ) -> impl IndexedParallelIterator<Item = TableWitnessSegment<'_, P>>

Trait Implementations

impl<'cs, 'alloc, P> Debug for TableWitnessIndex<'cs, 'alloc, P>

where P: PackedField + Debug, P::Scalar: TowerField + Debug,

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

Formats the value using the given formatter.