IT++ Logo Newcom Logo

itpp::Hamming_Code Class Reference
[Forward Error Correcting Codes]

Binary Hamming codes. More...

#include <itpp/comm/hammcode.h>

Inheritance diagram for itpp::Hamming_Code:

itpp::Channel_Code List of all members.

Public Member Functions

 Hamming_Code (short m)
 Constructor for hamming(n,k). n = pow(2,m)-1 and k = pow(2,m)-m-1.
virtual ~Hamming_Code ()
 Destructor.
virtual void encode (const bvec &uncoded_bits, bvec &coded_bits)
 Hamming encoder. Will truncate some bits if not length = integer * k.
virtual bvec encode (const bvec &uncoded_bits)
 Hamming encoder. Will truncate some bits if not length = integer * k.
virtual void decode (const bvec &coded_bits, bvec &decoded_bits)
 Hamming decoder. Will truncate some bits if not length = integer * n.
virtual bvec decode (const bvec &coded_bits)
 Hamming decoder. Will truncate some bits if not length = integer * n.
virtual void decode (const vec &received_signal, bvec &output)
 Decode a vec of received data.
virtual bvec decode (const vec &received_signal)
 Decode a vec of received data.
virtual double get_rate ()
 Get the code rate.
short get_n ()
 Gets the code length n.
short get_k ()
 Gets the number of information bits per code word, k.
bmat get_H ()
 Gets the parity check matrix for the code.
bmat get_G ()
 Gets the generator matrix for the code.

Detailed Description

Binary Hamming codes.

Definition at line 47 of file hammcode.h.


Constructor & Destructor Documentation

itpp::Hamming_Code::Hamming_Code ( short  m  ) 

Constructor for hamming(n,k). n = pow(2,m)-1 and k = pow(2,m)-m-1.

Definition at line 39 of file hammcode.cpp.

References itpp::pow2i().

virtual itpp::Hamming_Code::~Hamming_Code (  )  [inline, virtual]

Destructor.

Definition at line 53 of file hammcode.h.


Member Function Documentation

void itpp::Hamming_Code::encode ( const bvec &  uncoded_bits,
bvec &  coded_bits 
) [virtual]

Hamming encoder. Will truncate some bits if not length = integer * k.

Implements itpp::Channel_Code.

Definition at line 91 of file hammcode.cpp.

References itpp::floor(), and itpp::length().

Referenced by encode().

bvec itpp::Hamming_Code::encode ( const bvec &  uncoded_bits  )  [virtual]

Hamming encoder. Will truncate some bits if not length = integer * k.

Implements itpp::Channel_Code.

Definition at line 104 of file hammcode.cpp.

References encode().

void itpp::Hamming_Code::decode ( const bvec &  coded_bits,
bvec &  decoded_bits 
) [virtual]

Hamming decoder. Will truncate some bits if not length = integer * n.

Implements itpp::Channel_Code.

Definition at line 111 of file hammcode.cpp.

References itpp::bin2dec(), itpp::floor(), and itpp::length().

Referenced by decode().

bvec itpp::Hamming_Code::decode ( const bvec &  coded_bits  )  [virtual]

Hamming decoder. Will truncate some bits if not length = integer * n.

Implements itpp::Channel_Code.

Definition at line 143 of file hammcode.cpp.

References decode().

void itpp::Hamming_Code::decode ( const vec &  received_signal,
bvec &  decoded_bits 
) [virtual]

Decode a vec of received data.

Implements itpp::Channel_Code.

Definition at line 152 of file hammcode.cpp.

References it_error.

bvec itpp::Hamming_Code::decode ( const vec &  received_signal  )  [virtual]

Decode a vec of received data.

Implements itpp::Channel_Code.

Definition at line 157 of file hammcode.cpp.

References it_error.

virtual double itpp::Hamming_Code::get_rate ( void   )  [inline, virtual]

Get the code rate.

Implements itpp::Channel_Code.

Definition at line 70 of file hammcode.h.

short itpp::Hamming_Code::get_n (  )  [inline]

Gets the code length n.

Definition at line 73 of file hammcode.h.

short itpp::Hamming_Code::get_k (  )  [inline]

Gets the number of information bits per code word, k.

Definition at line 75 of file hammcode.h.

bmat itpp::Hamming_Code::get_H (  )  [inline]

Gets the parity check matrix for the code.

Definition at line 77 of file hammcode.h.

bmat itpp::Hamming_Code::get_G (  )  [inline]

Gets the generator matrix for the code.

Definition at line 79 of file hammcode.h.


The documentation for this class was generated from the following files:
SourceForge Logo

Generated on Wed Apr 18 11:45:39 2007 for IT++ by Doxygen 1.5.2