libecc 0.2.2

Library of Error-Correcting Codes for GD
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

mod error;
mod math;
pub mod types;
mod util;

mod hamming;
mod rs;

use bitvec::prelude::*;
use error::*;
pub use hamming::Hamming;
pub use math::*;
pub use rs::ReedSolomon;
use types::*;
pub use util::{bitdump_bitslice, hexdump_bitslice, hexdump_slice};

pub trait Code {
  type Slice: ?Sized;
  type Vector;

  fn encode(&self, info: &Self::Slice, dev: &Self::Slice) -> Result<Encoded<Self::Vector>>;
  fn decode(&self, data: &Self::Slice) -> Result<Decoded<Self::Vector>>;
}
pub trait BitUnitCode: Code<Slice = BSRep, Vector = BVRep> {
  fn code_bit_len(&self) -> usize;
  fn info_bit_len(&self) -> usize;
}
pub trait ByteUnitCode: Code<Slice = U8SRep, Vector = U8VRep> {
  fn code_byte_len(&self) -> usize;
  fn info_byte_len(&self) -> usize;
  fn set_precoding(&mut self, pre: &[U8VRep]) -> Result<()>;
}

#[derive(Debug, Clone)]
pub struct Decoded<T> {
  pub base: T,
  pub deviation: T,
}

#[derive(Debug, Clone)]
pub struct Encoded<T>(pub T);

pub trait BitDump {
  fn bitdump(&self) -> String;
}
impl<T: BitStore, O: BitOrder> BitDump for BitSlice<T, O> {
  fn bitdump(&self) -> String {
    bitdump_bitslice(self)
  }
}
impl<T: BitStore, O: BitOrder> BitDump for BitVec<T, O> {
  fn bitdump(&self) -> String {
    bitdump_bitslice(self)
  }
}

pub trait HexDump {
  fn hexdump(&self) -> Result<String>;
}
impl<T: BitStore, O: BitOrder> HexDump for BitSlice<T, O> {
  fn hexdump(&self) -> Result<String> {
    hexdump_bitslice(self)
  }
}
impl<T: BitStore, O: BitOrder> HexDump for BitVec<T, O> {
  fn hexdump(&self) -> Result<String> {
    hexdump_bitslice(self.as_bitslice())
  }
}
impl HexDump for &U8SRep {
  fn hexdump(&self) -> Result<String> {
    hexdump_slice(self)
  }
}
impl HexDump for U8VRep {
  fn hexdump(&self) -> Result<String> {
    hexdump_slice(self.as_slice())
  }
}