General Concept and Base Classes

class BinaryLinearBlockCode(name=None, parityCheckMatrix=None, generatorMatrix=None)

Bases: lpdec.codes.LinearBlockCode

Base class for binary linear block codes.

name is a string uniquely describing the code. When storing results into a database, there must not be two different codes with the same name. If the parity-check matrix is given by a file, the code’s name defaults to the name of that file.

The class can be instanciated directly by providing a parity check matrix; the argument parityCheckMatrix must be either the path of a file containig the matrix, or a two-dimensional list or a np.ndarray representation of the matrix. Subclasses using a different code representation should leave the default value of None.

generatorMatrix

Generator matrix of this code; generated on first access if not available.

parityCheckMatrix

The parity-check matrix, calculated on first access if not given a priori.