Struct BinaryCode 

pub struct BinaryCode { /* private fields */ }

A binary linear code [n, k, d].

k-dimensional subspace of GF(2)^n with minimum distance d.

Implementations

impl BinaryCode

pub fn from_generator(matrix: GF2Matrix) -> Result<Self, EnumerativeError>

Create a code from its generator matrix.

The matrix is reduced to RREF. Its rank determines k.

pub fn from_parity_check(h: GF2Matrix) -> Result<Self, EnumerativeError>

Create a code from its parity check matrix H.

The code is C = ker(H).

pub fn parameters(&self) -> (usize, usize, usize)

Code parameters [n, k, d].

pub fn length(&self) -> usize

Code length n.

pub fn dimension(&self) -> usize

Code dimension k.

pub fn minimum_distance(&self) -> usize

Minimum distance d (minimum Hamming weight of nonzero codewords).

pub fn generator_matrix(&self) -> &GF2Matrix

Generator matrix.

pub fn parity_check_matrix(&self) -> GF2Matrix

Parity check matrix H such that H * c = 0 for all codewords c.

pub fn dual(&self) -> BinaryCode

The dual code C^⊥.

pub fn is_self_dual(&self) -> bool

Whether the code is self-dual (C = C^⊥).

pub fn codewords(&self) -> Vec<GF2Vector>

Enumerate all 2^k codewords.

pub fn encode(&self, message: &GF2Vector) -> GF2Vector

Encode a k-bit message into an n-bit codeword.

pub fn syndrome(&self, received: &GF2Vector) -> GF2Vector

Syndrome of a received vector.

pub fn matroid(&self) -> Matroid

The column matroid of the generator matrix.

pub fn weight_enumerator(&self) -> Vec<u64>

Weight enumerator coefficients A_0, A_1, …, A_n.

A_i = number of codewords of Hamming weight i.

pub fn weight_distribution(&self) -> Vec<u64>

Weight distribution: A_i = number of codewords of Hamming weight i.

pub fn dual_weight_enumerator(&self) -> Vec<Rational64>

MacWilliams identity: dual weight enumerator computed from transform.

W_{C⊥}[j] = (1/2^k) · Σ_i W_C[i] · K_j(i; n) where K_j(i; n) is the Krawtchouk polynomial.

Trait Implementations

impl Clone for BinaryCode

fn clone(&self) -> BinaryCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryCode

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

Formats the value using the given formatter.

impl PartialEq for BinaryCode

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BinaryCode

impl StructuralPartialEq for BinaryCode