Polar Codes in Python

"""
Polar Codes in Python
=============================================
"""

from polarcodes.utils import *
from polarcodes.decoder_utils import *
from polarcodes.Construct import Construct
from polarcodes.Shorten import Shorten
from polarcodes.Encode import Encode
from polarcodes.Decode import Decode
from polarcodes.AWGN import AWGN
from polarcodes.Puncture import Puncture
from polarcodes.PolarCode import PolarCode
from polarcodes.GUI import GUI

Sub-modules

polarcodes.AWGN

This class simulates an AWGN channel by adding gaussian noise with double-sided noise power. It updates likelihoods in polarcodes.PolarCode with randomly …

polarcodes.Construct

Construct performs the mothercode construction. It uses the algorithm specified by construction_type in myPC. Mothercode constructions …

polarcodes.Decode

A polar decoder class. Currently only Successive Cancellation Decoder (SCD) is supported.

polarcodes.Encode

A polar encoder class. Currently only non-systematic encoding is supported.

polarcodes.GUI

polarcodes.PolarCode

An object that encapsulates all of the parameters required to define a polar code. This object must be given to the following classes: polarcodes.AWGN, …

polarcodes.Puncture

polarcodes.SCD

polarcodes.Shorten

A class dedicated to shortening. This means that the likelihoods for each coded shortened bit are set to infinity at the channel output given by class …

polarcodes.decoder_utils

polarcodes.utils

Math provides miscellaneous math operations to the other classes, which are important for polar codes algorithm implementations.