Struct binius_core::reed_solomon::reed_solomon::ReedSolomonCode

pub struct ReedSolomonCode<P>
where
    P: PackedField,
    P::Scalar: BinaryField,
{ /* private fields */ }

Implementations

impl<P> ReedSolomonCode<P>

where P: PackedField, P::Scalar: BinaryField,

pub fn log_inv_rate(&self) -> usize

impl<P> ReedSolomonCode<P>

where P: PackedFieldIndexable<Scalar: BinaryField>,

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

pub fn get_ntt(&self) -> &impl AdditiveNTT<P>

pub fn log_dim(&self) -> usize

pub fn log_len(&self) -> usize

Trait Implementations

impl<P> Debug for ReedSolomonCode<P>

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

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

Formats the value using the given formatter.

impl<P, F> LinearCode for ReedSolomonCode<P>

where P: PackedFieldIndexable<Scalar = F>, F: BinaryField,

type P = P

type EncodeError = Error

fn len(&self) -> usize

The block length.

fn dim_bits(&self) -> usize

The base-2 log of the dimension.

fn min_dist(&self) -> usize

The minimum distance between codewords.

fn inv_rate(&self) -> usize

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

fn encode_batch_inplace( &self, code: &mut [Self::P], log_batch_size: usize ) -> Result<(), Self::EncodeError>

Encode a message in-place in a provided buffer.

fn dim(&self) -> usize

The dimension.

fn encode_inplace(&self, code: &mut [Self::P]) -> Result<(), Self::EncodeError>

Encode a message in-place in a provided buffer.

fn encode(&self, msg: Vec<Self::P>) -> Result<Vec<Self::P>, Self::EncodeError>

Encode a message provided as a vector of packed field elements.

impl<P, F> LinearCodeWithExtensionEncoding for ReedSolomonCode<P>

where P: PackedFieldIndexable<Scalar = F>, F: BinaryField,

fn encode_extension_inplace<PE>( &self, code: &mut [PE] ) -> Result<(), Self::EncodeError>

where PE: RepackedExtension<P>, PE::Scalar: ExtensionField<<Self::P as PackedField>::Scalar>,

Encode a message of extension field elements in-place in a provided buffer.

fn encode_extension<PE>( &self, msg: Vec<PE> ) -> Result<Vec<PE>, Self::EncodeError>

where PE: RepackedExtension<Self::P>, PE::Scalar: ExtensionField<<Self::P as PackedField>::Scalar>,

Encode a message of extension field elements provided as a vector of packed field elements.