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.
Error control
Block coding
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).SlepianArray
– Slepian array (standard array) for a linear block code.
Block 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.SyndromeTableDecoder
– Syndrome table decoder for general block codes.ViterbiDecoder
– Viterbi decoder for terminated convolutional codes.WagnerDecoder
– Wagner decoder for single parity-check codes.
Convolutional coding
ConvolutionalCode
– Binary convolutional code.TerminatedConvolutionalCode
– Terminated convolutional code.ConvolutionalStreamEncoder
– Convolutional stream encoder.ViterbiStreamDecoder
– Convolutional stream decoder using Viterbi algorithm.
Checksum
CyclicRedundancyCheck
– Cyclic redundancy check (CRC) [Not implemented yet].
Finite-state machines
FiniteStateMachine
– Finite-state machine (Mealy machine).
Modulation
Modulation
– General modulation scheme.PAModulation
– Pulse-amplitude modulation (PAM).QAModulation
– Quadrature-amplitude modulation (QAM).ASKModulation
– Amplitude-shift keying (ASK) modulation.PSKModulation
– Phase-shift keying (PSK) modulation.APSKModulation
– Amplitude- and phase-shift keying (APSK) modulation.
Pulse formatting
Pulses
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.
Filtering
TransmitFilter
– Transmit filter (pulse shaping).ReceiveFilter
– Receive filter [Not implemented yet].
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.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.LloydMaxQuantizer
– Lloyd–Max scalar quantizer.UniformQuantizer
– Uniform scalar quantizer.
Sources
DiscreteMemorylessSource
– Discrete memoryless source (DMS).
Utilities
bits_to_int
– Converts a bit array to its integer representation (LSB first).int_to_bits
– Converts an integer, or array of integers, to their bit representations (LSB first).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.relative_entropy
– Computes the relative entropy (Kullback–Leibler divergence) between two pmfs.