Library reference
Algebra
BinaryPolynomial– Binary polynomial.BinaryPolynomialFraction– Binary polynomial fraction.FiniteBifield– Finite field with binary characteristic.
Channels
AWGNChannel– Additive white Gaussian noise (AWGN) 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.ASKConstellation– Amplitude-shift keying (ASK) constellation.PSKConstellation– Phase-shift keying (PSK) constellation.APSKConstellation– Amplitude- and phase-shift keying (APSK) 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.Lexicode– Lexicographic code (lexicode).PolarCode– Polar (Arıkan) code.SlepianArray– Slepian array (standard array) for a linear block 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
BCJRDecoder– Bahl–Cocke–Jelinek–Raviv (BCJR) decoder for terminated convolutional codes.BerlekampDecoder– Berlekamp decoder for BCH codes.ExhaustiveSearchDecoder– Exhaustive search decoder for general block codes.ReedDecoder– Reed decoder for Reed-Muller codes.SCDecoder– Successive cancellation decoder for Polar codes.SyndromeTableDecoder– Syndrome table decoder for general block codes.ViterbiDecoder– Viterbi decoder for terminated convolutional codes.WagnerDecoder– Wagner decoder for single parity-check codes.
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.
Pulse formatting
Pulse– General pulse [Not implemented yet].RectangularPulse– Rectangular pulse.ManchesterPulse– Manchester pulse.SincPulse– Sinc pulse.RaisedCosinePulse– Raised-cosine pulse.RootRaisedCosinePulse– Root-raised-cosine pulse.GaussianPulse– Gaussian pulse.
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.
Source coding
Lossless coding
FixedToVariableCode– General fixed-to-variable length code.ShannonCode– Binary Shannon code.FanoCode– Binary Fano code.HuffmanCode– Binary Huffman code.VariableToFixedCode– General variable-to-fixed length code.TunstallCode– Binary Tunstall code.LempelZiv77Code– Lempel–Ziv 77 (LZ77 or LZ1) code.LempelZiv78Code– Lempel–Ziv 78 (LZ78 or LZ2) code.LempelZivWelchCode– Lempel–Ziv–Welch (LZW) code.
Integer coding
UnaryCode– Unary code.FibonacciCode– Fibonacci code.
Quantization
ScalarQuantizer– General scalar quantizer.UniformQuantizer– Uniform scalar quantizer.LloydMaxQuantizer– Lloyd–Max scalar quantizer.
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, or array of integers, to their bit representations.sampling_rate_compress– Performs sampling rate compression (downsampling).sampling_rate_expand– Performs sampling rate expansion (upsampling).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.