Struct ReedSolomonCode

pub struct ReedSolomonCode<F: BinaryField> { /* 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_ntt crate for more details.

Implementations

impl<F: BinaryField> ReedSolomonCode<F>

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

impl<F: BinaryField> 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_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_ext_batch_inplace<PE: PackedExtension<F>, NTT: AdditiveNTT<F> + Sync>( &self, ntt: &NTT, code: &mut [PE], log_batch_size: usize, ) -> Result<(), Error>

Encode a batch of interleaved messages of extension field elements in-place in a provided buffer.

A linear code can be naturally extended to a code over extension fields by encoding each dimension of the extension as a vector-space separately.

Preconditions

• PE::Scalar::DEGREE must be a power of two.

Throws

• If the code buffer does not have capacity for len() << log_batch_size field elements.

Trait Implementations

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

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

Formats the value using the given formatter.