C(++)ECCO
C++ Error Control COding: a header-only library for ECC simulations and experiments, modeling complete coding systems across arbitrary finite fields and complex inter-field relationships - Christian Senger <senger@inue.uni-stuttgart.de>
Loading...
Searching...
No Matches
CECCO::Code< T > Class Template Reference

#include <codes.hpp>

Inheritance diagram for CECCO::Code< T >:
Inheritance graph

Public Member Functions

 Code (size_t n)
 Code (const Code &other)
 Code (Code &&)=default
virtual ~Code ()=default
Code & operator= (const Code &other)
Code & operator= (Code &&)=default
size_t get_n () const noexcept
virtual void get_info (std::ostream &os) const
virtual Vector< T > enc (const Vector< T > &u) const
virtual Vector< T > encinv (const Vector< T > &c) const
virtual Vector< T > dec_BD (const Vector< T > &r) const
virtual Vector< T > dec_boosted_BD (const Vector< T > &r) const
virtual Vector< T > dec_ML (const Vector< T > &r) const
virtual Vector< T > dec_Viterbi (const Vector< T > &r, const std::string &filename="") const
virtual Vector< T > dec_ML_soft (const Vector< double > &llrs, size_t cache_size) const
virtual Vector< T > dec_Viterbi_soft (const Vector< double > &llrs, const std::string &filename="") const
virtual Vector< double > dec_BCJR (const Vector< double > &llrs, const std::string &filename="") const
virtual Vector< T > dec_burst (const Vector< T > &r) const
virtual Vector< T > dec_recursive (const Vector< T > &r) const
virtual Vector< T > dec_Meggitt (const Vector< T > &r) const
virtual Vector< T > dec_WBA (const Vector< T > &r) const
virtual Vector< T > dec_BMA (const Vector< T > &r) const
virtual Vector< T > dec_BD_EE (const Vector< T > &r) const
virtual Vector< T > dec_ML_EE (const Vector< T > &r) const
virtual Vector< T > dec_Viterbi_EE (const Vector< T > &r, const std::string &filename="") const
virtual Vector< T > dec_recursive_EE (const Vector< T > &r) const
virtual Vector< T > dec_WBA_EE (const Vector< T > &r) const
virtual Vector< T > dec_BMA_EE (const Vector< T > &r) const

Protected Member Functions

std::vector< size_t > erasure_positions (const Vector< T > &r) const

Protected Attributes

size_t n

Detailed Description

template<ComponentType T>
class CECCO::Code< T >

Definition at line 126 of file codes.hpp.

Constructor & Destructor Documentation

◆ Code() [1/3]

template<ComponentType T>
CECCO::Code< T >::Code ( size_t n)
inline

Definition at line 128 of file codes.hpp.

◆ Code() [2/3]

template<ComponentType T>
CECCO::Code< T >::Code ( const Code< T > & other)
inline

Definition at line 130 of file codes.hpp.

◆ Code() [3/3]

template<ComponentType T>
CECCO::Code< T >::Code ( Code< T > && )
default

◆ ~Code()

template<ComponentType T>
virtual CECCO::Code< T >::~Code ( )
virtualdefault

Member Function Documentation

◆ dec_BCJR()

template<ComponentType T>
virtual Vector< double > CECCO::Code< T >::dec_BCJR ( const Vector< double > & llrs,
const std::string & filename = "" ) const
inlinevirtual

Reimplemented in CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, and CECCO::LinearCode< Fp< 2 > >.

Definition at line 170 of file codes.hpp.

◆ dec_BD()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_BD ( const Vector< T > & r) const
inlinevirtual

Reimplemented in CECCO::AugmentedCode< T, B >, CECCO::ExtendedCode< T, B >, CECCO::GRSCode< T >, CECCO::HammingCode< T >, CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, CECCO::LinearCode< Fp< 2 > >, CECCO::RepetitionCode< T >, CECCO::SimplexCode< T >, CECCO::SingleParityCheckCode< T >, and CECCO::UniverseCode< T >.

Definition at line 152 of file codes.hpp.

◆ dec_BD_EE()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_BD_EE ( const Vector< T > & r) const
inlinevirtual

Reimplemented in CECCO::AugmentedCode< T, B >, CECCO::ExtendedCode< T, B >, CECCO::GRSCode< T >, CECCO::HammingCode< T >, CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, CECCO::LinearCode< Fp< 2 > >, CECCO::RepetitionCode< T >, CECCO::SimplexCode< T >, CECCO::SingleParityCheckCode< T >, and CECCO::UniverseCode< T >.

Definition at line 189 of file codes.hpp.

◆ dec_BMA()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_BMA ( const Vector< T > & r) const
inlinevirtual

Reimplemented in CECCO::GRSCode< T >.

Definition at line 185 of file codes.hpp.

◆ dec_BMA_EE()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_BMA_EE ( const Vector< T > & r) const
inlinevirtual

Reimplemented in CECCO::GRSCode< T >.

Definition at line 204 of file codes.hpp.

◆ dec_boosted_BD()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_boosted_BD ( const Vector< T > & r) const
inlinevirtual

Reimplemented in CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, and CECCO::LinearCode< Fp< 2 > >.

Definition at line 155 of file codes.hpp.

◆ dec_burst()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_burst ( const Vector< T > & r) const
inlinevirtual

Reimplemented in CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, CECCO::LinearCode< Fp< 2 > >, and CECCO::UniverseCode< T >.

Definition at line 173 of file codes.hpp.

◆ dec_Meggitt()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_Meggitt ( const Vector< T > & r) const
inlinevirtual

Reimplemented in CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, and CECCO::LinearCode< Fp< 2 > >.

Definition at line 179 of file codes.hpp.

◆ dec_ML()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_ML ( const Vector< T > & r) const
inlinevirtual

Reimplemented in CECCO::AugmentedCode< T, B >, CECCO::ExtendedCode< T, B >, CECCO::HammingCode< T >, CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, CECCO::LinearCode< Fp< 2 > >, CECCO::RepetitionCode< T >, CECCO::SimplexCode< T >, CECCO::SingleParityCheckCode< T >, and CECCO::UniverseCode< T >.

Definition at line 158 of file codes.hpp.

◆ dec_ML_EE()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_ML_EE ( const Vector< T > & r) const
inlinevirtual

Reimplemented in CECCO::AugmentedCode< T, B >, CECCO::ExtendedCode< T, B >, CECCO::HammingCode< T >, CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, CECCO::LinearCode< Fp< 2 > >, CECCO::RepetitionCode< T >, CECCO::SimplexCode< T >, CECCO::SingleParityCheckCode< T >, and CECCO::UniverseCode< T >.

Definition at line 192 of file codes.hpp.

◆ dec_ML_soft()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_ML_soft ( const Vector< double > & llrs,
size_t cache_size ) const
inlinevirtual

Reimplemented in CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, and CECCO::LinearCode< Fp< 2 > >.

Definition at line 164 of file codes.hpp.

◆ dec_recursive()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_recursive ( const Vector< T > & r) const
inlinevirtual

Definition at line 176 of file codes.hpp.

◆ dec_recursive_EE()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_recursive_EE ( const Vector< T > & r) const
inlinevirtual

Definition at line 198 of file codes.hpp.

◆ dec_Viterbi()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_Viterbi ( const Vector< T > & r,
const std::string & filename = "" ) const
inlinevirtual

Reimplemented in CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, and CECCO::LinearCode< Fp< 2 > >.

Definition at line 161 of file codes.hpp.

◆ dec_Viterbi_EE()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_Viterbi_EE ( const Vector< T > & r,
const std::string & filename = "" ) const
inlinevirtual

Reimplemented in CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, and CECCO::LinearCode< Fp< 2 > >.

Definition at line 195 of file codes.hpp.

◆ dec_Viterbi_soft()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_Viterbi_soft ( const Vector< double > & llrs,
const std::string & filename = "" ) const
inlinevirtual

Reimplemented in CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, and CECCO::LinearCode< Fp< 2 > >.

Definition at line 167 of file codes.hpp.

◆ dec_WBA()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_WBA ( const Vector< T > & r) const
inlinevirtual

Reimplemented in CECCO::GRSCode< T >.

Definition at line 182 of file codes.hpp.

◆ dec_WBA_EE()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::dec_WBA_EE ( const Vector< T > & r) const
inlinevirtual

Reimplemented in CECCO::GRSCode< T >.

Definition at line 201 of file codes.hpp.

◆ enc()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::enc ( const Vector< T > & u) const
inlinevirtual

Reimplemented in CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, CECCO::LinearCode< Fp< 2 > >, CECCO::RepetitionCode< T >, and CECCO::UniverseCode< T >.

Definition at line 148 of file codes.hpp.

◆ encinv()

template<ComponentType T>
virtual Vector< T > CECCO::Code< T >::encinv ( const Vector< T > & c) const
inlinevirtual

Reimplemented in CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, CECCO::LinearCode< Fp< 2 > >, CECCO::RepetitionCode< T >, and CECCO::UniverseCode< T >.

Definition at line 149 of file codes.hpp.

◆ erasure_positions()

template<ComponentType T>
std::vector< size_t > CECCO::Code< T >::erasure_positions ( const Vector< T > & r) const
inlineprotected

Definition at line 212 of file codes.hpp.

◆ get_info()

template<ComponentType T>
virtual void CECCO::Code< T >::get_info ( std::ostream & os) const
inlinevirtual

Reimplemented in CECCO::AlternantCode< B >, CECCO::AlternantCode< GRSCode< SUPER > >, CECCO::AugmentedCode< T, B >, CECCO::BCHCode< B >, CECCO::CordaroWagnerCode, CECCO::EmptyCode< T >, CECCO::ExtendedCode< T, B >, CECCO::GolayCode< T >, CECCO::GoppaCode< SUPER >, CECCO::GRSCode< T >, CECCO::HammingCode< T >, CECCO::LDCCode< BU, BV >, CECCO::LinearCode< T >, CECCO::LinearCode< B::FIELD::BASE_FIELD >, CECCO::LinearCode< BU::FIELD >, CECCO::LinearCode< Fp< 2 > >, CECCO::RepetitionCode< T >, CECCO::RMCode, CECCO::RSCode< T >, CECCO::SimplexCode< T >, CECCO::SingleParityCheckCode< T >, CECCO::SubfieldSubcode< B >, CECCO::UniverseCode< T >, and CECCO::ZeroCode< T >.

Definition at line 147 of file codes.hpp.

◆ get_n()

template<ComponentType T>
size_t CECCO::Code< T >::get_n ( ) const
inlinenoexcept

Definition at line 145 of file codes.hpp.

◆ operator=() [1/2]

template<ComponentType T>
Code & CECCO::Code< T >::operator= ( Code< T > && )
default

◆ operator=() [2/2]

template<ComponentType T>
Code & CECCO::Code< T >::operator= ( const Code< T > & other)
inline

Definition at line 136 of file codes.hpp.

Member Data Documentation

◆ n

template<ComponentType T>
size_t CECCO::Code< T >::n
protected

Definition at line 210 of file codes.hpp.

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