Polar Coding

A Python wrapper around the AFF3CT [1] project, transferring the Polar [2] implementations to the Hermes forward error correction pipeline structure.

class PolarSCCoding(self: hermespy.fec.aff3ct.polar.PolarSCCoding, arg0: SupportsInt | SupportsIndex, arg1: SupportsInt | SupportsIndex, arg2: SupportsFloat | SupportsIndex)

Bases: pybind11_object

Parameters:

• data_block_size (int) – Number of data bits per block to be encoded.

• code_block_size (int) – Number of code bits per encoded block.

• ber (float) – Assumed bit error rate.

• num_paths (int) – Number of decoding paths.

decode(self: hermespy.fec.aff3ct.polar.PolarSCCoding, arg0: Annotated[numpy.typing.ArrayLike, numpy.int32]) → numpy.typing.NDArray[numpy.int32]

Decode a block of code bits to data bits.

Parameters:

code (numpy.ndarray) – The code bit block to be decoded.

Returns:

The data bit block after decoding.

encode(self: hermespy.fec.aff3ct.polar.PolarSCCoding, arg0: Annotated[numpy.typing.ArrayLike, numpy.int32]) → numpy.typing.NDArray[numpy.int32]

Encode a block of data bits to code bits.

Parameters:

data (numpy.ndarray) – The data bit block to be encoded.

Returns:

The code bit block after encoding.

property bit_block_size

Number of bits within a data block to be encoded.

property code_block_size

Number of bits within a code block to be decoded.

enabled = True

property rate

Coding rate of the polar code.

class PolarSCLCoding(self: hermespy.fec.aff3ct.polar.PolarSCLCoding, arg0: SupportsInt | SupportsIndex, arg1: SupportsInt | SupportsIndex, arg2: SupportsFloat | SupportsIndex, arg3: SupportsInt | SupportsIndex)

Bases: pybind11_object

Successive Cancellation List Polar Codes. Refer to [3] for further information.

Parameters:

• data_block_size (int) – Number of data bits per block to be encoded.

• code_block_size (int) – Number of code bits per encoded block.

• ber (float) – Assumed bit error rate.

• num_paths (int) – Number of considered decoding paths.

decode(self: hermespy.fec.aff3ct.polar.PolarSCLCoding, arg0: Annotated[numpy.typing.ArrayLike, numpy.int32]) → numpy.typing.NDArray[numpy.int32]

Decode a block of code bits to data bits.

Parameters:

code (numpy.ndarray) – The code bit block to be decoded.

Returns:

The data bit block after decoding.

encode(self: hermespy.fec.aff3ct.polar.PolarSCLCoding, arg0: Annotated[numpy.typing.ArrayLike, numpy.int32]) → numpy.typing.NDArray[numpy.int32]

Encode a block of data bits to code bits.

Parameters:

data (numpy.ndarray) – The data bit block to be encoded.

Returns:

The code bit block after encoding.

property bit_block_size

Number of bits within a data block to be encoded.

property code_block_size

Number of bits within a code block to be decoded.

enabled = True

property rate

Coding rate of the polar code.

[1]

A. Cassagne, O. Hartmann, M. Léonardon, K. He, C. Leroux, R. Tajan, O. Aumage, D. Barthou, T. Tonnellier, V. Pignoly, B. Le Gal, and C. Jégo. Aff3ct: a fast forward error correction toolbox! Elsevier SoftwareX, 10:100345, October 2019. URL: http://www.sciencedirect.com/science/article/pii/S2352711019300457, doi:https://doi.org/10.1016/j.softx.2019.100345.

[2]

Erdal Arikan. Channel polarization: a method for constructing capacity-achieving codes for symmetric binary-input memoryless channels. IEEE Transactions on Information Theory, 55(7):3051–3073, 2009. doi:10.1109/TIT.2009.2021379.

[3]

Ido Tal and Alexander Vardy. List decoding of polar codes. IEEE Transactions on Information Theory, 61(5):2213–2226, 2015. doi:10.1109/TIT.2015.2410251.