Loading...
Searching...
No Matches
gf2mat.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2015 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef GF2MAT_H
#define GF2MAT_H
#include "alist.h"
#include "gf2vec.h"
#include <vector>
class GF2Mat
{
//! The matrix H
std::vector<std::vector<uint8_t>> H;
//! Number of rows in H
int M;
//! Number of columns in H
int N;
public:
//! Default constructor
GF2Mat(){};
//! Construct an M x N matrix with all 0 entries
GF2Mat(int m, int n);
//! Loads the matrix from alist _list
GF2Mat(alist _list);
//! Initializes the class from a 2-D vector X
GF2Mat(std::vector<std::vector<uint8_t>> X);
//! Returns the variable M
int get_M();
//! Returns the variable N
int get_N();
//! Set the element at (i, j) coordinate to val
void set_element(int i, int j, char val);
//! Returns the element at coordinate (i, j)
char get_element(int i, int j);
//! Returns the ith row
GF2Vec get_row(int i);
//! Returns the ith column
GF2Vec get_col(int i);
//! Returns the ith row
GF2Vec operator[](int i);
//! Prints the matrix H
void print_matrix();
//! Sets the ith column with the given vector
void set_col(int i, GF2Vec vec);
//! Sets the ith row with the given vector
void set_row(int i, GF2Vec vec);
//! Swaps columns i and j
void swap_cols(int i, int j);
//! Adds column j to i and replace i with the sum
void add_cols(int i, int j);
//! Add row j to i and replace j with the sum
void add_rows(int i, int j);
//! Returns the variable H
std::vector<std::vector<uint8_t>> get_H();
/*!
* \brief Obtains an equivalent representation of H for encoding
*
* For encoding a G matrix in the form [I P] obtained from the
* parity matrix H, by (a) Column permutations, (b) Row additions
* and (c) Row permutations. Details of encoding is given in
* section A.1 of the reference:
*
* - "Modern Coding Theory", T Richardson and R Urbanke.
*
* \param p The column permutation during this operation.
* \param rank The rank of the matrix.
*/
GF2Mat get_G(std::vector<int>& p, int& rank);
};
#endif // #ifndef GF2MAT_H
alist.h
GF2Mat
Definition gf2mat.h:18
GF2Mat::get_row
GF2Vec get_row(int i)
Returns the ith row.
GF2Mat::get_element
char get_element(int i, int j)
Returns the element at coordinate (i, j)
GF2Mat::add_cols
void add_cols(int i, int j)
Adds column j to i and replace i with the sum.
GF2Mat::set_element
void set_element(int i, int j, char val)
Set the element at (i, j) coordinate to val.
GF2Mat::set_col
void set_col(int i, GF2Vec vec)
Sets the ith column with the given vector.
GF2Mat::GF2Mat
GF2Mat(alist _list)
Loads the matrix from alist _list.
GF2Mat::GF2Mat
GF2Mat(int m, int n)
Construct an M x N matrix with all 0 entries.
GF2Mat::add_rows
void add_rows(int i, int j)
Add row j to i and replace j with the sum.
GF2Mat::set_row
void set_row(int i, GF2Vec vec)
Sets the ith row with the given vector.
GF2Mat::operator[]
GF2Vec operator[](int i)
Returns the ith row.
GF2Mat::get_N
int get_N()
Returns the variable N.
GF2Mat::GF2Mat
GF2Mat()
Default constructor.
Definition gf2mat.h:30
GF2Mat::get_G
GF2Mat get_G(std::vector< int > &p, int &rank)
Obtains an equivalent representation of H for encoding.
GF2Mat::get_M
int get_M()
Returns the variable M.
GF2Mat::get_H
std::vector< std::vector< uint8_t > > get_H()
Returns the variable H.
GF2Mat::swap_cols
void swap_cols(int i, int j)
Swaps columns i and j.
GF2Mat::print_matrix
void print_matrix()
Prints the matrix H.
GF2Mat::get_col
GF2Vec get_col(int i)
Returns the ith column.
GF2Mat::GF2Mat
GF2Mat(std::vector< std::vector< uint8_t > > X)
Initializes the class from a 2-D vector X.
GF2Vec
Definition gf2vec.h:18
alist
Definition alist.h:33
std::vector
STL class.
Definition vector_docstub.h:11
gf2vec.h