AFF3CT
A Fast Forward Error Correction Tool!
 All Classes Files Functions Variables Pages
Public Member Functions | Protected Attributes | List of all members
Coset_i< B, D > Class Template Referenceabstract

Performs the coset approach (flips the bits or the signs depending on the initial codeword). More...

#include <Coset.hpp>

Inheritance diagram for Coset_i< B, D >:
Module SC_Coset< B, D > Coset_bit< B, D > Coset_real< B, D >

Public Member Functions

 Coset_i (const int size, const int n_frames=1, const std::string name="Coset_i")
 Constructor. More...
 
virtual ~Coset_i ()
 Destructor.
 
virtual void apply (const mipp::vector< B > &ref, const mipp::vector< D > &in_data, mipp::vector< D > &out_data)=0
 Applies the coset approach on data using the reference. More...
 
- Public Member Functions inherited from Module
 Module (const int n_frames=1, const std::string name="Module")
 Constructor. More...
 
virtual ~Module ()
 Destructor.
 
virtual void set_n_frames (const int n_frames)
 Set the number of frames. More...
 
virtual int get_n_frames () const
 Get the number of frames. More...
 
void rename (const std::string name)
 Rename the Module. More...
 

Protected Attributes

const int size
 
- Protected Attributes inherited from Module
int n_frames
 
std::string name
 

Detailed Description

template<typename B, typename D>
class Coset_i< B, D >

Performs the coset approach (flips the bits or the signs depending on the initial codeword).

Template Parameters
Btype of the bits in the ref data.
Dtype of the input/output data.

Please use Coset for inheritance (instead of Coset_i).

Constructor & Destructor Documentation

template<typename B, typename D>
Coset_i< B, D >::Coset_i ( const int  size,
const int  n_frames = 1,
const std::string  name = "Coset_i< B, D >" 
)
inline

Constructor.

Parameters
sizesize of the input data.
n_framesnumber of frames to process in the Source.
nameSource's name.

Member Function Documentation

template<typename B, typename D>
virtual void Coset_i< B, D >::apply ( const mipp::vector< B > &  ref,
const mipp::vector< D > &  in_data,
mipp::vector< D > &  out_data 
)
pure virtual

Applies the coset approach on data using the reference.

Flips the bits or the signs depending on the reference (flips if bit ref = 1, do nothing else).

Parameters
refthe ref codeword.
in_datathe input data to apply the coset on.
out_datathe output data after the coset application.

Implemented in Coset_bit< B, D >, and Coset_real< B, D >.

Member Data Documentation

template<typename B, typename D>
const int Coset_i< B, D >::size
protected

Size of the input data


The documentation for this class was generated from the following file: