IT++ Logo
itpp::LDPC_Parity_Irregular Class Reference

Irregular LDPC code generator class. More...

#include <itpp/comm/ldpc.h>

Inheritance diagram for itpp::LDPC_Parity_Irregular:
itpp::LDPC_Parity_Unstructured itpp::LDPC_Parity

Public Member Functions

 LDPC_Parity_Irregular ()
 Default constructor.
 
 LDPC_Parity_Irregular (int Nvar, const vec &var_deg, const vec &chk_deg, const std::string &method="rand", const ivec &options="200 6")
 Constructor that invokes generate() method.
 
void generate (int Nvar, const vec &var_deg, const vec &chk_deg, const std::string &method="rand", const ivec &options="200 6")
 Generate an irregular LDPC code.
 
void display_stats () const
 Display some information about the matrix.
 
int cycle_removal_MGW (int L)
 Remove cycles (loops) from unstructured parity check matrix.
 
void initialize (int ncheck, int nvar)
 Initialize an empty matrix of size ncheck x nvar.
 
GF2mat_sparse get_H (bool transpose=false) const
 Get the parity check matrix, optionally its transposed form.
 
Sparse_Vec< binget_col (int c) const
 Get a specific column from the matrix.
 
Sparse_Vec< binget_row (int r) const
 Get a specific row from the matrix.
 
int get_nvar () const
 Get the number of variable nodes (number of columns)
 
int get_ncheck () const
 Get the number of check nodes (number of rows)
 
void set (int i, int j, bin value)
 Set element (i,j) of the parity check matrix to value.
 
bin get (int i, int j) const
 Get element (i,j) of the parity check matrix.
 
bin operator() (int i, int j) const
 Get element (i,j) of the parity check matrix.
 
double get_rate () const
 Get the code rate.
 
void import_alist (const GF2mat_sparse_alist &H_alist)
 Import matrix from GF2mat_sparse_alist format.
 
GF2mat_sparse_alist export_alist () const
 Export matrix to GF2mat_sparse_alist format.
 
void load_alist (const std::string &alist_file)
 Load matrix from alist_file text file in alist format.
 
void save_alist (const std::string &alist_file) const
 Save matrix to alist_file text file in alist format.
 

Protected Member Functions

void generate_random_H (const ivec &C, const ivec &R, const ivec &cycopt)
 Generate a random parity check matrix.
 
void compute_CR (const vec &var_deg, const vec &chk_deg, const int Nvar, ivec &C, ivec &R)
 Compute target number of columns (C) and rows (R) with a specific number of ones.
 
int check_for_cycles (int L) const
 Check for cycles of length L.
 
int check_connectivity (int from_m, int from_n, int to_m, int to_n, int g, int L) const
 Check for connectivity between nodes.
 

Protected Attributes

bool init_flag
 Flag that indicates proper initialization.
 
GF2mat_sparse H
 The parity check matrix.
 
GF2mat_sparse Ht
 The transposed parity check matrix.
 
int nvar
 Number of variable nodes.
 
int ncheck
 Number of check nodes.
 
ivec sumX1
 Actual number of ones in each column.
 
ivec sumX2
 Actual number of ones in each row.
 

Static Protected Attributes

static const int Nmax = 200
 Maximum node degree class can handle.
 

Detailed Description

Irregular LDPC code generator class.

Author
Erik G. Larsson, Mattias Andersson and Adam Piatyszek

Definition at line 332 of file ldpc.h.

Constructor & Destructor Documentation

◆ LDPC_Parity_Irregular() [1/2]

itpp::LDPC_Parity_Irregular::LDPC_Parity_Irregular ( )
inline

Default constructor.

Definition at line 336 of file ldpc.h.

◆ LDPC_Parity_Irregular() [2/2]

itpp::LDPC_Parity_Irregular::LDPC_Parity_Irregular ( int Nvar,
const vec & var_deg,
const vec & chk_deg,
const std::string & method = "rand",
const ivec & options = "200 6" )

Constructor that invokes generate() method.

Definition at line 694 of file ldpc.cpp.

References generate().

Member Function Documentation

◆ generate()

void itpp::LDPC_Parity_Irregular::generate ( int Nvar,
const vec & var_deg,
const vec & chk_deg,
const std::string & method = "rand",
const ivec & options = "200 6" )

Generate an irregular LDPC code.

Parameters
Nvarnumber of variable nodes
var_degvector of variable degree distributions, from an edge perspective
chk_degvector of check degree distributions, from an edge perspective
methodcurrently the only provided method is "rand" (see below)
optionsDetermines the level of matrix optimization.

The "rand" method generates a fully unstructured random matrix. Some stochastic optimization is performed to avoid cycles. This optimization is controlled via the parameter options. In particular, the girth for the variable-node-degree-2 part of the graph can be controlled via the parameter options(0). The girth for the rest of the nodes can be controlled via the parameter options(1). The recommended value for options is "200 6" for graphs of small size, and "100 4" for large graphs. The value "0 0" means no optimization. Double edges are always avoided.

Note
The "rand" method for graph construction provided in this function is not intended to provide the best possible error performance, but it is a simple, basic, fast tool that can easily be used to build relatively good irregular graphs. Better results in terms of performance and error-floor can be achieved by using other performance measures for the graph than cycle length (for irregular codes, the so-called ACE measure for example). Additionally, the "rand" method builds the graph edge by edge, with no possibility of removing an edge once it has been placed. Better results may be achieved by building the graphs by placing pairs or n-tuples of edges at time, for example, column by column.
Alternative (user-defined) methods for code generation can be implemented by inheriting LDPC_Parity_Irregular.

Definition at line 703 of file ldpc.cpp.

References itpp::LDPC_Parity_Unstructured::compute_CR(), itpp::LDPC_Parity_Unstructured::generate_random_H(), and it_error.

Referenced by LDPC_Parity_Irregular().

◆ display_stats()

void itpp::LDPC_Parity_Irregular::display_stats ( ) const
inlinevirtual

Display some information about the matrix.

Implements itpp::LDPC_Parity_Unstructured.

Definition at line 385 of file ldpc.h.

◆ cycle_removal_MGW()

int itpp::LDPC_Parity_Unstructured::cycle_removal_MGW ( int L)
inherited

Remove cycles (loops) from unstructured parity check matrix.

This function implements the cycle removal algorithm presented by McGowan and Williamson at the IT workshop 2003. The maximum girth of the graph that will be attempted is L. The algorithm is bound to remove all loops of length L, insofar this is possible. I.e., it does not terminate until it is impossible to remove more cycles by swapping two edges.

Parameters
LTarget girth. For example, L=6 attempts to removes all 4-cycles.
Returns
The girth of the graph, i.e. the length of the shortest cycle. For example, a return value of 6 means that there are no 4-cycles.
Note
This algorithm can take a long time to run for large L or large graphs.

Definition at line 292 of file ldpc.cpp.

References itpp::elem_mult(), itpp::floor_i(), itpp::LDPC_Parity::get(), itpp::LDPC_Parity::get_col(), itpp::Sparse_Vec< T >::get_nz_index(), itpp::LDPC_Parity::init_flag, it_assert, it_assert_debug, it_info_debug, itpp::length(), itpp::LDPC_Parity::ncheck, itpp::Sparse_Vec< T >::nnz(), itpp::LDPC_Parity::nvar, itpp::randi(), itpp::randu(), itpp::LDPC_Parity::set(), and itpp::Array< T >::set_size().

◆ generate_random_H()

void itpp::LDPC_Parity_Unstructured::generate_random_H ( const ivec & C,
const ivec & R,
const ivec & cycopt )
protectedinherited

◆ compute_CR()

void itpp::LDPC_Parity_Unstructured::compute_CR ( const vec & var_deg,
const vec & chk_deg,
const int Nvar,
ivec & C,
ivec & R )
protectedinherited

Compute target number of columns (C) and rows (R) with a specific number of ones.

Parameters
var_degvector of variable degree distributions, from an edge perspective
chk_degvector of check degree distributions, from an edge perspective
Nvarnumber of variable nodes
Cnumber of columns with a specific number of ones
Rnumber of rows with a specific number of ones

The result is passed by reference and saved in C and R.

Definition at line 598 of file ldpc.cpp.

References itpp::concat(), itpp::elem_div(), itpp::elem_mult(), itpp::find(), it_info_debug, itpp::length(), itpp::linspace(), itpp::max(), itpp::LDPC_Parity::Nmax, itpp::round(), itpp::sum(), itpp::to_ivec(), itpp::to_vec(), and itpp::zeros_i().

Referenced by generate(), and itpp::LDPC_Parity_Regular::generate().

◆ initialize()

◆ get_H()

GF2mat_sparse itpp::LDPC_Parity::get_H ( bool transpose = false) const
inlineinherited

Get the parity check matrix, optionally its transposed form.

Definition at line 104 of file ldpc.h.

References itpp::transpose().

Referenced by itpp::BLDPC_Generator::construct(), and itpp::LDPC_Generator_Systematic::construct().

◆ get_col()

Sparse_Vec< bin > itpp::LDPC_Parity::get_col ( int c) const
inlineinherited

◆ get_row()

Sparse_Vec< bin > itpp::LDPC_Parity::get_row ( int r) const
inlineinherited

Get a specific row from the matrix.

Definition at line 112 of file ldpc.h.

Referenced by itpp::LDPC_Parity::check_connectivity(), itpp::LDPC_Code::decoder_parameterization(), and itpp::LDPC_Parity::display_stats().

◆ get_nvar()

int itpp::LDPC_Parity::get_nvar ( ) const
inlineinherited

Get the number of variable nodes (number of columns)

Definition at line 115 of file ldpc.h.

References it_assert_debug.

Referenced by itpp::LDPC_Generator_Systematic::construct().

◆ get_ncheck()

int itpp::LDPC_Parity::get_ncheck ( ) const
inlineinherited

Get the number of check nodes (number of rows)

Definition at line 124 of file ldpc.h.

References it_assert_debug.

Referenced by itpp::LDPC_Generator_Systematic::construct().

◆ set()

◆ get()

bin itpp::LDPC_Parity::get ( int i,
int j ) const
inlineinherited

Get element (i,j) of the parity check matrix.

Definition at line 136 of file ldpc.h.

References it_assert_debug.

Referenced by itpp::LDPC_Parity::check_connectivity(), itpp::LDPC_Parity_Unstructured::cycle_removal_MGW(), and itpp::LDPC_Parity_Unstructured::generate_random_H().

◆ operator()()

bin itpp::LDPC_Parity::operator() ( int i,
int j ) const
inlineinherited

Get element (i,j) of the parity check matrix.

Definition at line 142 of file ldpc.h.

References it_assert_debug.

◆ get_rate()

double itpp::LDPC_Parity::get_rate ( ) const
inlineinherited

Get the code rate.

Definition at line 152 of file ldpc.h.

Referenced by itpp::LDPC_Parity::display_stats().

◆ import_alist()

◆ export_alist()

GF2mat_sparse_alist itpp::LDPC_Parity::export_alist ( ) const
inherited

◆ load_alist()

void itpp::LDPC_Parity::load_alist ( const std::string & alist_file)
inherited

Load matrix from alist_file text file in alist format.

Definition at line 155 of file ldpc.cpp.

References itpp::LDPC_Parity::import_alist().

Referenced by itpp::LDPC_Parity::LDPC_Parity().

◆ save_alist()

void itpp::LDPC_Parity::save_alist ( const std::string & alist_file) const
inherited

Save matrix to alist_file text file in alist format.

Definition at line 160 of file ldpc.cpp.

References itpp::LDPC_Parity::export_alist(), and itpp::GF2mat_sparse_alist::write().

◆ check_for_cycles()

int itpp::LDPC_Parity::check_for_cycles ( int L) const
protectedinherited

Check for cycles of length L.

This function implements a recursive routine to find loops. The function is mainly a tool for testing and debugging more sophisticated functions for graph manipulation.

Parameters
Llength of cycles to look for
Returns
The function returns the number of cycles found of length L or shorter. Cycles may be counted multiple times.
Note
This function can be very slow for large matrices. It is mainly intended as a debugging aid.

Definition at line 249 of file ldpc.cpp.

References itpp::LDPC_Parity::check_connectivity(), itpp::LDPC_Parity::get_col(), itpp::Sparse_Vec< T >::get_nz_indices(), itpp::LDPC_Parity::init_flag, it_assert, itpp::length(), and itpp::LDPC_Parity::nvar.

◆ check_connectivity()

int itpp::LDPC_Parity::check_connectivity ( int from_m,
int from_n,
int to_m,
int to_n,
int g,
int L ) const
protectedinherited

Check for connectivity between nodes.

This function examines whether the point (to_m, to_n) in the matrix can be reached from the point (from_m, from_n) using at most L steps. A recursive search is used.

The function can be used to search for cycles in the matrix. To search for a cycle of length L, set from_m=to_m and from_n=to_n, and godir=0.

Parameters
from_mstarting coordinate, row number
to_mgoal coordinate, row number
from_nstarting coordinate, column number
to_ngoal coordinate, row number
gdirection: 1=start going vertically, 2=start going horizontally
Lnumber of permitted steps
Returns
  • -1 or -3 : destination unreachable
  • -2 : meaningless search (started in a "0" point),
  • -4 : meaningless search
  • >=0 : destination reached with certain number of steps left
Note
This function can be very slow depending on the nature of the matrix.

Note that smaller cycles may appear as longer cycles when using this method. More specifically, suppose the method is run with a given L and there are cycles in the neighborhood of (from_m,from_n) of length L-2 or less, but which do not contain (from_m,from_n). These shorter cycles may then also be reported as a cycle of length L. For example, if one of the immediate neighbors of (from_m,from_n) is part of a cycle of length 4 this method will report that (from_m,from_n) is part of a cycle of length 6, if run with L=6. However, if it is known that there are no cycles of length L-2 or smaller, and check_connectivity(from_m,from_n,from_m,from_n,0,L) returns a non-negative value, then one will know with certainty that the point (from_m,from_n) is part of a cycle of length L. (This behavior is inherent to the simple recursive search used.)

Definition at line 192 of file ldpc.cpp.

References itpp::LDPC_Parity::check_connectivity(), itpp::LDPC_Parity::get(), itpp::LDPC_Parity::get_col(), itpp::Sparse_Vec< T >::get_nz_indices(), itpp::LDPC_Parity::get_row(), itpp::LDPC_Parity::init_flag, it_assert, and itpp::length().

Referenced by itpp::LDPC_Parity::check_connectivity(), itpp::LDPC_Parity::check_for_cycles(), and itpp::LDPC_Parity_Unstructured::generate_random_H().

Member Data Documentation

◆ init_flag

◆ Nmax

const int itpp::LDPC_Parity::Nmax = 200
staticprotectedinherited

Maximum node degree class can handle.

Definition at line 172 of file ldpc.h.

Referenced by itpp::LDPC_Parity_Unstructured::compute_CR(), and itpp::LDPC_Parity_Unstructured::generate_random_H().

◆ H

GF2mat_sparse itpp::LDPC_Parity::H
protectedinherited

The parity check matrix.

Definition at line 174 of file ldpc.h.

Referenced by itpp::LDPC_Parity::export_alist(), itpp::LDPC_Parity::initialize(), and itpp::LDPC_Parity::set().

◆ Ht

GF2mat_sparse itpp::LDPC_Parity::Ht
protectedinherited

The transposed parity check matrix.

Definition at line 176 of file ldpc.h.

Referenced by itpp::LDPC_Parity::initialize(), and itpp::LDPC_Parity::set().

◆ nvar

◆ ncheck

◆ sumX1

ivec itpp::LDPC_Parity::sumX1
protectedinherited

Actual number of ones in each column.

Definition at line 182 of file ldpc.h.

Referenced by itpp::LDPC_Code::decoder_parameterization(), itpp::LDPC_Parity::display_stats(), itpp::LDPC_Parity::initialize(), and itpp::LDPC_Parity::set().

◆ sumX2

ivec itpp::LDPC_Parity::sumX2
protectedinherited

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

Generated on Mon Apr 7 2025 07:53:18 for IT++ by Doxygen 1.11.0