Library reference

Algebra

• BinaryPolynomial – Binary polynomial.
• BinaryPolynomialFraction – Binary polynomial fraction.
• FiniteBifield – Finite field with binary characteristic.

Channels

• GaussianChannel – Gaussian channel.
• DiscreteMemorylessChannel – General discrete memoryless channel (DMC).
• BinarySymmetricChannel – Binary symmetric channel (BSC).
• BinaryErasureChannel – Binary erasure channel (BEC).
• ZChannel – Z-channel.

Constellations

• Constellation – General real or complex constellation.
• PAMConstellation – Pulse-amplitude modulation (PAM) constellation.
• QAMConstellation – Quadrature amplitude modulation (QAM) constellation.
• CrossQAMConstellation – Cross quadrature amplitude modulation (cross-QAM) constellation.
• ASKConstellation – Amplitude-shift keying (ASK) constellation.
• PSKConstellation – Phase-shift keying (PSK) constellation.
• APSKConstellation – Amplitude- and phase-shift keying (APSK) constellation.
• OrthogonalConstellation – Orthogonal constellation.
• BiorthogonalConstellation – Biorthogonal constellation.
• SimplexConstellation – Simplex constellation.

Error control

Block codes

• BlockCode – General binary linear block code.
• SystematicBlockCode – Systematic linear block code.
• CyclicCode – General binary cyclic code.
• HammingCode – Hamming code.
• SimplexCode – Simplex (maximum-length) code.
• GolayCode – Binary Golay code.
• RepetitionCode – Repetition code.
• SingleParityCheckCode – Single parity-check code.
• CordaroWagnerCode – Cordaro–Wagner code.
• ReedMullerCode – Reed–Muller code.
• BCHCode – Bose–Ray-Chaudhuri–Hocquenghem (BCH) code.
• ReedSolomonCode – Reed–Solomon code.
• Lexicode – Lexicographic code (lexicode).
• PolarCode – Polar (Arıkan) code.

Convolutional codes

• ConvolutionalCode – Binary convolutional encoder.
• LowRateConvolutionalCode – Low-rate convolutional encoder.
• HighRateConvolutionalCode – High-rate convolutional encoder.
• TerminatedConvolutionalCode – Terminated convolutional code.
• ViterbiStreamDecoder – Convolutional stream decoder using Viterbi algorithm.

Decoders

• ExhaustiveCodewordDecoder – Exhaustive codeword decoder for general block codes.
• ExhaustiveBitwiseDecoder – Exhaustive bitwise decoder for general block codes.
• SyndromeTableDecoder – Syndrome table decoder for general block codes.
• WagnerDecoder – Wagner decoder for single parity-check codes.
• ReedDecoder – Reed decoder for Reed–Muller codes.
• BerlekampDecoder – Berlekamp decoder for BCH codes and Reed–Solomon codes.
• SCDecoder – Successive cancellation decoder for Polar codes.
• ViterbiDecoder – Viterbi decoder for terminated convolutional codes.
• BCJRDecoder – Bahl–Cocke–Jelinek–Raviv (BCJR) decoder for terminated convolutional codes.
• GaussianEliminationDecoder – Gaussian elimination decoder for general block codes over the binary erasure channel.
• PeelingDecoder – Peeling decoder for general block codes over the binary erasure channel.

Checksum

• CyclicRedundancyCheck – Cyclic redundancy check (CRC) [Not implemented yet].

Finite-state machines

• MooreMachine – Finite-state Moore machine.
• MealyMachine – Finite-state Mealy machine.

Labelings

• Labeling – General binary labeling.
• NaturalLabeling – Natural binary labeling.
• ReflectedLabeling – Reflected (Gray) binary labeling.
• ReflectedRectangularLabeling – Reflected rectangular binary labeling.
• ProductLabeling – Cartesian product of labelings.

Lossless coding

Symbol codes

• SymbolCode – General symbol code.
• ShannonCode – Binary Shannon code.
• FanoCode – Binary Fano code.
• HuffmanCode – Binary Huffman code.
• TruncatedBinaryCode – Truncated binary code.
• FixedToVariableCode – General fixed-to-variable length code.

Variable-to-fixed codes

• VariableToFixedCode – General variable-to-fixed length code.
• TunstallCode – Binary Tunstall code.

Stream codes

• RunLengthCode – Run-length code.
• LempelZiv77Code – Lempel–Ziv 77 (LZ77 or LZ1) code.
• LempelZivSSCode – Lempel–Ziv–Storer–Szymanski (LZSS) code.
• LempelZiv78Code – Lempel–Ziv 78 (LZ78 or LZ2) code.
• LempelZivWelchCode – Lempel–Ziv–Welch (LZW) code.

Integer codes

• UnaryCode – Unary code.
• GolombCode – Golomb code.
• EscapeCode – Escape code.
• EliasGammaCode – Elias gamma code.
• EliasDeltaCode – Elias delta code.
• EliasOmegaCode – Elias omega code.
• FibonacciCode – Fibonacci code.
• TabooCode – Taboo code.

Pulse formatting

• Pulse – General pulse [Not implemented yet].
• RectangularPulse – Rectangular pulse.
• ManchesterPulse – Manchester pulse.
• SincPulse – Sinc pulse.
• RaisedCosinePulse – Raised-cosine pulse.
• BeaulieuPulse – Beaulieu pulse.
• GaussianPulse – Gaussian pulse.

Quantization

• ScalarQuantizer – General scalar quantizer.
• UniformQuantizer – Uniform scalar quantizer.
• LloydMaxQuantizer – Lloyd–Max scalar quantizer.

Sequences

Binary sequences

• BinarySequence – General binary sequence.
• BarkerSequence – Barker sequence.
• WalshHadamardSequence – Walsh–Hadamard sequence.
• LFSRSequence – Linear-feedback shift register (LFSR) sequence.
• GoldSequence – Gold sequence [Not implemented yet].
• KasamiSequence – Kasami sequence [Not implemented yet].

Complex sequences

• ComplexSequence – General complex sequence.
• ZadoffChuSequence – Zadoff–Chu sequence.

Sources

• DiscreteMemorylessSource – Discrete memoryless source.
• MarkovChain – Finite-state homogeneous discrete-time Markov chain.

Utilities

• bits_to_int – Converts a bit array to its integer representation.
• int_to_bits – Converts an integer array to its bit representation.
• from_binary – Converts a bit sequence to a single integer.
• to_binary – Converts a single integer to its bit representation.
• sampling_rate_compress – Performs sampling rate compression (downsampling).
• sampling_rate_expand – Performs sampling rate expansion (upsampling).
• convolve – Convolves two signals.
• fourier_transform – Computes the Fourier transform.
• boxplus – Computes the box-plus operation.
• gaussian_q – Computes the Gaussian Q-function.
• gaussian_q_inv – Computes the inverse Gaussian Q-function.
• marcum_q – Computes the Marcum Q-function.
• autocorrelation – Computes the autocorrelation $R[\ell]$ of a real or complex sequence $x[n]$.
• cyclic_autocorrelation – Computes the cyclic autocorrelation $\tilde{R}[\ell]$ of a real or complex sequence $x[n]$.
• entropy – Computes the entropy of a random variable with a given pmf.
• binary_entropy – Computes the binary entropy function.
• binary_entropy_inv – Computes the inverse of the binary entropy function.
• relative_entropy – Computes the relative entropy (Kullback–Leibler divergence) between two pmfs.