Struct code_rs::coding::galois::Codeword

pub struct Codeword<F: GaloisField> { /* private fields */ }

Codeword in a Galois field.

Implementations

impl<F: GaloisField> Codeword<F>

pub fn new(bits: u8) -> Codeword<F>

Construct a new Codeword αⁱ from the given bit pattern. Panic if the pattern is invalid in the field.

pub fn for_power(power: usize) -> Codeword<F>

Construct a new Codeword α^m ≡ αⁱ (modulo the field) for the given power i.

pub fn bits(&self) -> u8

Retrieve the bit pattern of the codeword.

pub fn zero(&self) -> bool

Check if the codeword is zero.

pub fn power(&self) -> Option<usize>

Retrieve the power i of the current codeword αⁱ. Return Some(i) if the power is defined and None if the codeword is zero.

pub fn invert(self) -> Codeword<F>

Find 1/αⁱ for the current codeword αⁱ. Panic if the codeword is zero.

pub fn pow(&self, pow: usize) -> Codeword<F>

Compute (αⁱ)^p for the current codeword αⁱ and given power p.

Trait Implementations

impl<F: GaloisField> Add<Codeword<F>> for Codeword<F>

Add codewords using Galois addition.

type Output = Codeword<F>

The resulting type after applying the + operator.

fn add(self, rhs: Codeword<F>) -> Self::Output

Performs the + operation.

impl<F: Clone + GaloisField> Clone for Codeword<F>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: GaloisField> Debug for Codeword<F>

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

Formats the value using the given formatter.

impl<F: GaloisField> Default for Codeword<F>

fn default() -> Self

Construct the additive identity codeword α⁰ = 1.

impl<F: GaloisField> Div<Codeword<F>> for Codeword<F>

Divide codewords using Galois division. Panic if the divisor is zero.

type Output = Codeword<F>

The resulting type after applying the / operator.

fn div(self, rhs: Codeword<F>) -> Self::Output

Performs the / operation.

impl<F: GaloisField> Mul<Codeword<F>> for Codeword<F>

Mutiply codewords using Galois multiplication.

type Output = Codeword<F>

The resulting type after applying the * operator.

fn mul(self, rhs: Codeword<F>) -> Self::Output

Performs the * operation.

impl<P: PolynomialCoefs> Mul<Codeword<P25Field>> for Polynomial<P>

Scale polynomial by a codeword.

type Output = Polynomial<P>

The resulting type after applying the * operator.

fn mul(self, rhs: P25Codeword) -> Self::Output

Performs the * operation.

impl<F: GaloisField> PartialEq<Codeword<F>> for Codeword<F>

Check equality of two codewords.

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<F: GaloisField> PartialEq<u8> for Codeword<F>

Check equality of the codeword’s bit pattern with raw bits.

fn eq(&self, other: &u8) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<F: GaloisField> Sub<Codeword<F>> for Codeword<F>

“Subtract” codewords, which is equivalent to addition.

type Output = Codeword<F>

The resulting type after applying the - operator.

fn sub(self, rhs: Codeword<F>) -> Self::Output

Performs the - operation.

impl<F: Copy + GaloisField> Copy for Codeword<F>

impl<F: GaloisField> Eq for Codeword<F>