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::AlternantCode< B > Class Template Reference

#include <codes.hpp>

Inheritance diagram for CECCO::AlternantCode< B >:
Inheritance graph

Public Member Functions

 AlternantCode (const B &supercode)
 AlternantCode (const Vector< SUPER > &a, const Vector< SUPER > &d, size_t delta)
 AlternantCode (const AlternantCode &)=default
 AlternantCode (AlternantCode &&)=default
AlternantCodeoperator= (const AlternantCode &)=default
AlternantCodeoperator= (AlternantCode &&)=default
const Vector< SUPER > & get_a () const noexcept
const Vector< SUPER > & get_d () const noexcept
virtual size_t get_delta () const noexcept
virtual void get_info (std::ostream &os) const override
Public Member Functions inherited from CECCO::SubfieldSubcode< B >
 SubfieldSubcode (const B &SuperCode)
 SubfieldSubcode (const SubfieldSubcode &)=default
 SubfieldSubcode (SubfieldSubcode &&)=default
SubfieldSubcodeoperator= (const SubfieldSubcode &)=default
SubfieldSubcodeoperator= (SubfieldSubcode &&)=default
const B & get_SuperCode () const noexcept
Vector< SUB > dec_supercode_BD (const Vector< SUB > &r) const
Vector< SUB > dec_supercode_ML (const Vector< SUB > &r) const
Vector< SUB > dec_supercode_BD_EE (const Vector< SUB > &r) const
Vector< SUB > dec_supercode_ML_EE (const Vector< SUB > &r) const
Public Member Functions inherited from CECCO::LinearCode< B::FIELD::BASE_FIELD >
 LinearCode (size_t n, size_t k, const Matrix< T > &X)
LinearCodeoperator= (const LinearCode &other)
size_t get_k () const noexcept
double get_R () const noexcept
InfInt get_size () const
const Matrix< T > & get_G () const noexcept
const Matrix< T > & get_HT () const noexcept
Matrix< T > get_H () const
virtual size_t get_dmin () const
size_t get_tmax () const
virtual const Polynomial< InfInt > & get_weight_enumerator () const
long double P_word (double pe) const
long double P_error (double pe) const
long double P_failure (double pe) const
long double Bhattacharyya_bound (long double gamma) const
const Polynomial< T > & get_gamma () const
void set_dmin (size_t d) const noexcept
void set_weight_enumerator (const Polynomial< InfInt > &p) const noexcept
void set_gamma (const Polynomial< T > &g) const noexcept
const std::vector< Vector< T > > & get_standard_array () const
const std::vector< bool > & get_tainted () const
const std::unordered_map< size_t, Vector< T > > & get_Meggitt_table () const
auto cbegin () const noexcept
auto cend () const noexcept
bool is_identical (const LinearCode< S > &other, Matrix< T > *L_ptr=nullptr) const
 Test whether two linear codes are identical.
bool is_equivalent (const LinearCode< S > &other, Matrix< T > *L_ptr=nullptr, Matrix< T > *P_ptr=nullptr) const
 Test whether two linear codes are equivalent.
bool is_perfect () const
bool is_MDS () const
bool is_equidistant () const
bool is_weakly_self_dual () const
bool is_dual_containing () const
bool is_self_dual () const
bool is_polynomial () const
bool is_cyclic () const
LinearCode< T > get_dual () const
LinearCode< T > get_equivalent_code_in_standard_form () const
LinearCode< T > get_identical_code_in_polynomial_form () const
Matrix< T > get_G_in_polynomial_form () const
Matrix< T > get_G_in_trellis_oriented_form () const
Trellis< T > get_trivial_trellis () const
const Trellis< T > & get_minimal_trellis () const
Vector< T > enc (const Vector< T > &u) const override
Vector< T > encinv (const Vector< T > &c) const override
virtual Vector< T > dec_BD (const Vector< T > &r) const override
virtual Vector< T > dec_boosted_BD (const Vector< T > &r) const override
virtual Vector< T > dec_ML (const Vector< T > &r) const override
virtual Vector< T > dec_burst (const Vector< T > &r) const override
virtual Vector< T > dec_Meggitt (const Vector< T > &r) const override
virtual Vector< T > dec_Viterbi (const Vector< T > &r, const std::string &filename="") const override
virtual Vector< T > dec_Viterbi_soft (const Vector< double > &llrs, const std::string &filename="") const override
virtual Vector< double > dec_BCJR (const Vector< double > &llrs, const std::string &filename="") const override
virtual Vector< T > dec_ML_soft (const Vector< double > &llrs, size_t cache_limit) const override
virtual Vector< T > dec_BD_EE (const Vector< T > &r) const override
virtual Vector< T > dec_Viterbi_EE (const Vector< T > &r, const std::string &filename="") const override
virtual Vector< T > dec_ML_EE (const Vector< T > &r) const override
Vector< T > dec_GMD (const Vector< T > &r, const std::vector< double > &reliability) const
Public Member Functions inherited from CECCO::Code< T >
 Code (size_t n)
 Code (const Code &other)
 Code (Code &&)=default
virtual ~Code ()=default
Codeoperator= (const Code &other)
Codeoperator= (Code &&)=default
size_t get_n () const noexcept
virtual Vector< T > dec_recursive (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_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

Static Protected Member Functions

static size_t k_from_delta (size_t n, size_t delta)
Static Protected Member Functions inherited from CECCO::LinearCode< B::FIELD::BASE_FIELD >
static bool erasures_present (const Vector< T > &r)

Additional Inherited Members

Public Types inherited from CECCO::LinearCode< B::FIELD::BASE_FIELD >
using FIELD
Protected Member Functions inherited from CECCO::LinearCode< B::FIELD::BASE_FIELD >
void validate_length (const Vector< S > &r) const
Protected Member Functions inherited from CECCO::Code< T >
std::vector< size_t > erasure_positions (const Vector< T > &r) const
Protected Attributes inherited from CECCO::LinearCode< B::FIELD::BASE_FIELD >
size_t k
Matrix< T > G
Matrix< T > HT
Matrix< T > MI
std::vector< size_t > infoset
details::OnceCache< size_t > dmin
details::OnceCache< Polynomial< InfInt > > weight_enumerator
details::OnceCache< std::vector< Vector< T > > > codewords
details::OnceCache< std::vector< Vector< T > > > standard_array
details::OnceCache< std::vector< bool > > tainted
details::OnceCache< std::vector< bool > > tainted_burst
details::OnceCache< std::unordered_map< size_t, Vector< T > > > Meggitt_table
details::OnceCache< std::vector< std::optional< LinearCode< T > > > > punctured_codes_BD
details::OnceCache< std::vector< std::optional< LinearCode< T > > > > punctured_codes_ML
details::OnceCache< bool > polynomial
details::OnceCache< Polynomial< T > > gamma
details::OnceCache< Trellis< T > > minimal_trellis
Protected Attributes inherited from CECCO::Code< T >
size_t n

Detailed Description

template<class B>
requires std::derived_from<B, GRSCode<typename B::FIELD>>
class CECCO::AlternantCode< B >

Definition at line 3858 of file codes.hpp.

Constructor & Destructor Documentation

◆ AlternantCode() [1/4]

template<class B>
CECCO::AlternantCode< B >::AlternantCode ( const B & supercode)
inline

Definition at line 3864 of file codes.hpp.

◆ AlternantCode() [2/4]

template<class B>
CECCO::AlternantCode< B >::AlternantCode ( const Vector< SUPER > & a,
const Vector< SUPER > & d,
size_t delta )
inline

Definition at line 3869 of file codes.hpp.

◆ AlternantCode() [3/4]

template<class B>
CECCO::AlternantCode< B >::AlternantCode ( const AlternantCode< B > & )
default

◆ AlternantCode() [4/4]

template<class B>
CECCO::AlternantCode< B >::AlternantCode ( AlternantCode< B > && )
default

Member Function Documentation

◆ get_a()

template<class B>
const Vector< SUPER > & CECCO::AlternantCode< B >::get_a ( ) const
inlinenoexcept

Definition at line 3881 of file codes.hpp.

◆ get_d()

template<class B>
const Vector< SUPER > & CECCO::AlternantCode< B >::get_d ( ) const
inlinenoexcept

Definition at line 3882 of file codes.hpp.

◆ get_delta()

template<class B>
virtual size_t CECCO::AlternantCode< B >::get_delta ( ) const
inlinevirtualnoexcept

Reimplemented in CECCO::GoppaCode< SUPER >.

Definition at line 3883 of file codes.hpp.

◆ get_info()

template<class B>
virtual void CECCO::AlternantCode< B >::get_info ( std::ostream & os) const
inlineoverridevirtual

Reimplemented from CECCO::SubfieldSubcode< B >.

Reimplemented in CECCO::BCHCode< B >, and CECCO::GoppaCode< SUPER >.

Definition at line 3885 of file codes.hpp.

◆ k_from_delta()

template<class B>
size_t CECCO::AlternantCode< B >::k_from_delta ( size_t n,
size_t delta )
inlinestaticprotected

Definition at line 3900 of file codes.hpp.

◆ operator=() [1/2]

template<class B>
AlternantCode & CECCO::AlternantCode< B >::operator= ( AlternantCode< B > && )
default

◆ operator=() [2/2]

template<class B>
AlternantCode & CECCO::AlternantCode< B >::operator= ( const AlternantCode< B > & )
default

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