Skip to main content

ReedSolomon

Struct ReedSolomon 

Source
pub struct ReedSolomon<F> { /* private fields */ }
Expand description

Systematic Reed–Solomon [n, k, n-k+1] encoder over the additive-FFT subspaces W_k ⊂ W_n: encode(msg)[..k] == msg (Lin–Chung–Han 2014).

Implementations§

Source§

impl<F: BinaryFieldExtras + HardwareField> ReedSolomon<F>

Source

pub fn new(log_k: u32, log_n: u32) -> Result<Self, RsError>

k = 2^log_k message and n = 2^log_n codeword symbols, 1 <= log_k < log_n <= min(F::BITS, usize::BITS - 1). The only allocation is the two twiddle schedules.

Source

pub fn message_len(&self) -> usize

Source

pub fn codeword_len(&self) -> usize

Source

pub fn encode_scalar( &self, msg: &[Flat<F>], out: &mut [Flat<F>], ) -> Result<(), RsError>

Encode one row: msg.len() == k, out.len() == n, out[..k] == msg on return.

Source

pub fn encode( &self, msg: &[PackedFlat<F>], out: &mut [PackedFlat<F>], ) -> Result<(), RsError>

Encode F::WIDTH rows in lockstep. Lengths are in packed elements: msg.len() == k, out.len() == n.

Auto Trait Implementations§

§

impl<F> Freeze for ReedSolomon<F>

§

impl<F> RefUnwindSafe for ReedSolomon<F>
where F: RefUnwindSafe,

§

impl<F> Send for ReedSolomon<F>
where F: Send,

§

impl<F> Sync for ReedSolomon<F>
where F: Sync,

§

impl<F> Unpin for ReedSolomon<F>

§

impl<F> UnsafeUnpin for ReedSolomon<F>

§

impl<F> UnwindSafe for ReedSolomon<F>
where F: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.