Struct ReedSolomonCode 

pub struct ReedSolomonCode<F> { /* private fields */ }

Reed–Solomon codes over binary fields.

The Reed–Solomon code admits an efficient encoding algorithm over binary fields due to LCH14. The additive NTT encoding algorithm encodes messages interpreted as the coefficients of a polynomial in a non-standard, novel polynomial basis and the codewords are the polynomial evaluations over a linear subspace of the field. See the [binius-math] crate for more details.

Implementations

impl<F> ReedSolomonCode<F>

pub fn log_inv_rate(&self) -> usize

impl<F: BinaryField> ReedSolomonCode<F>

pub const fn new(log_dimension: usize, log_inv_rate: usize) -> Self

A code of the given dimension and rate, evaluated over the Gao-Mateer basis.

The evaluation domain is not a parameter: it is the Gao-Mateer basis of log_dimension + log_inv_rate, the same one GaoMateerOnTheFly and GaoMateerPreExpanded generate. A verifier can therefore rebuild the domain from the code’s shape alone, without being told which basis the prover encoded over.

pub fn subspace(&self) -> BinarySubspace<F>

The evaluation domain: the Gao-Mateer basis of Self::log_len dimensions.

Derived on demand rather than stored, so there is no way for it to disagree with the domain a prover or verifier generates from the same dimension.

pub const fn dim(&self) -> usize

The dimension.

pub const fn log_dim(&self) -> usize

pub const fn log_len(&self) -> usize

pub const fn len(&self) -> usize

The block length.

pub const fn inv_rate(&self) -> usize

The reciprocal of the rate, ie. self.len() / self.dim().

pub fn encode_batch<P, NTT, A>( &self, ntt: &NTT, data: FieldSlice<'_, P>, log_batch_size: usize, alloc: &A, ) -> FieldBuffer<P, A::Vec<P>>

where P: PackedField<Scalar = F>, NTT: AdditiveNTT<Field = F> + Sync, A: Allocator,

Encodes a message with an interleaved Reed–Solomon code.

This function interprets the message as a batch of independent vectors and applies an interleaved Reed–Solomon.

Preconditions

• data.log_len() must equal log_dim() + log_batch_size.
• The NTT subspace must match the code’s subspace.

Postconditions

• All elements in the output buffer are initialized with the encoded codeword.

Trait Implementations

impl<F: Clone> Clone for ReedSolomonCode<F>

fn clone(&self) -> ReedSolomonCode<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for ReedSolomonCode<F>

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

Formats the value using the given formatter.