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 subspace(&self) -> &BinarySubspace<F>

impl<F> ReedSolomonCode<F>

pub fn log_inv_rate(&self) -> usize

impl<F: BinaryField> ReedSolomonCode<F>

pub fn new(log_dimension: usize, log_inv_rate: usize) -> Result<Self, Error>

pub fn with_ntt_subspace( ntt: &impl AdditiveNTT<Field = F>, log_dimension: usize, log_inv_rate: usize, ) -> Result<Self, Error>

pub fn with_domain_context_subspace( domain_context: &impl DomainContext<Field = F>, log_dimension: usize, log_inv_rate: usize, ) -> Result<Self, Error>

pub fn with_subspace( subspace: BinarySubspace<F>, log_dimension: usize, log_inv_rate: usize, ) -> Result<Self, Error>

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>( &self, ntt: &NTT, data: FieldSlice<'_, P>, log_batch_size: usize, ) -> Result<FieldBuffer<P>, Error>

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

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() equal log_dim() + log_batch_size.

Postconditions

• On success, all elements in the output buffer are initialized with the encoded codeword.

Throws

• Error::EncoderSubspaceMismatch if the NTT subspace doesn’t match the code’s subspace.
• Error::Math if the output buffer has incorrect dimensions.

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.