comnum 0.2.0__cp311-abi3-win_amd64.whl

comnum/__init__.py

@@ -0,0 +1,835 @@
+"""Communication algorithms in Rust, with Python bindings.
+
+``comnum`` implements the building blocks of digital and optical communication
+simulations in Rust and exposes them to Python with NumPy arrays in and out. The
+conventions follow OptiCommPy (Gray mapping, metrics, pulse shapes, fibre and device
+models), which serves as the test oracle; the code is an independent implementation
+under the MIT licence.
+
+Conventions:
+
+- signals are 1-D ``complex128`` arrays (array-likes are converted), bits are ``uint8``
+  arrays, symbol indices ``int64`` arrays; the functions return arrays, not lists, of
+  one type whatever their arguments;
+- several streams (antennas, polarisations) are stream-major ``(n_streams, n)``
+  arrays, a time-frequency grid is ``(n_subcarriers, n_symbols)`` with its resource
+  elements as ``(k, l)`` pairs;
+- names: ``fs`` is a sampling rate, ``fc_hz`` a carrier, ``noise_var`` a noise variance
+  ``E|w|²``, ``ebn0_db`` and ``esn0_db`` the SNRs per bit and per symbol, MIMO channels
+  are ``(n_rx, n_tx)``; the tuning parameters are keyword-only, the generator is the
+  last positional argument, ``rng``;
+- the closed forms (``theory_*``, ``qfunc``, ``db2lin``…) take a scalar (and return a
+  float) or an array-like (and return an array of the same shape);
+- randomness is explicit: every function that draws takes a :class:`Rng`, so that a
+  simulation is reproducible from its seeds (``Rng.stream`` derives the per-trial
+  generators of a Monte Carlo campaign, as the Rust runner does);
+- invalid parameters raise ``ValueError``, numerical failures ``ArithmeticError``.
+
+Contents:
+
+=====================  ===============================================================
+Theme                  Names
+=====================  ===============================================================
+random and math        :class:`Rng`, :func:`db2lin`, :func:`lin2db`, :func:`dbm2w`,
+                       :func:`w2dbm`, :func:`qfunc`, :func:`ber_to_q_db`
+sources                :func:`bits`, :func:`prbs`, :func:`o150_sequence`,
+                       :func:`symbols`, :func:`maxwell_boltzmann`
+modulation             :class:`Constellation`, :func:`gray_code`, :class:`Dpsk`
+metrics                :func:`ber`, :func:`snr_db`, :func:`phase_error_std`, :func:`fast_ber_calc`, :func:`evm`,
+                       :func:`monte_carlo_gmi`, :func:`monte_carlo_mi`, :func:`entropy`,
+                       :func:`information_rates`, :func:`posterior_rates`
+closed forms           :func:`theory_ber`, :func:`theory_ser`, :func:`theory_ser_esn0`,
+                       :func:`theory_mi`,
+                       :func:`theory_gmi`, :func:`theory_ber_gray`,
+                       :func:`theory_ber_rayleigh_mrc`,
+                       :func:`theory_phase_pdf`, :func:`theory_ber_dpsk`,
+                       :func:`theory_differential_phase_tail`, :func:`theory_papr_ccdf`,
+                       :func:`theory_rs_wer`, :func:`theory_rs_ser`,
+                       :func:`theory_rs_ber`, :func:`theory_biawgn_capacity`,
+                       :func:`bpsk_noise_variance`, :func:`bpsk_llr`,
+                       :func:`theory_normal_approximation`, :func:`theory_shannon_limit_ebn0_db`,
+                       :func:`theory_cm_capacity`, :func:`theory_bicm_capacity`,
+                       :func:`theory_cm_cutoff_rate`, :func:`theory_bicm_cutoff_rate`
+filters and sampling   :func:`pulse_shape`, :func:`rrc_spectrum`, :func:`rrc_taps`,
+                       :func:`rc_taps`, :func:`fir_filter`,
+                       :func:`convolve`, :func:`upsample`, :func:`downsample`,
+                       :func:`decimate`, :func:`resample_fft`, :func:`low_pass_fir`, :func:`butterworth_lowpass`,
+                       :func:`pnorm`, :func:`anorm`, :func:`freq_shift`, :func:`select_channel`, :func:`resample_rational`,
+                       :func:`moving_average`, :func:`delay_fft`
+equalisation           :func:`cdc`, :func:`cd_taps_needed`, :func:`cd_fir_taps`,
+                       :func:`cd_dispersion_factor`, :func:`cd_savory_taps`,
+                       :func:`cd_ls_taps`, :func:`cd_ls_error`,
+                       :func:`adaptive_equalizer`
+carrier recovery       :func:`fourth_power_foe`, :func:`viterbi_viterbi`, :func:`bps`,
+                       :func:`ddpll`, :func:`derotate`, :func:`unwrap`
+clock recovery         :func:`gardner_ted`, :func:`gardner_ted_nyquist`,
+                       :func:`lagrange_cubic`, :func:`gardner_clock_recovery`
+channels               :func:`awgn`, :func:`awgn_ebn0`, :func:`phase_noise`, :func:`clock_offset`,
+                       :func:`linear_fiber_channel`, :class:`FiberParams`,
+                       :class:`Edfa`, :class:`Ssfm`, :class:`ManakovPmd`,
+                       :class:`ManakovSsfm`, :func:`gn_model`,
+                       :func:`gn_closed_form`, :func:`gn_isrs_closed_form`,
+                       :func:`format_moments`,
+                       :func:`raman_profile`, :func:`wdm_grid`
+devices                :func:`laser`, :func:`phase_modulator`, :func:`mzm`, :func:`iqm`,
+                       :class:`Photodiode`, :func:`balanced_photodiode`,
+                       :func:`hybrid_2x4`, :func:`coherent_receiver`
+optical wireless       :class:`OwcRoom`, :class:`OwcIllumination`,
+                       :class:`OwcImpulseResponse`, :func:`lambertian_mode`,
+                       :func:`owc_direction`, :func:`owc_illuminance` (indoor VLC and
+                       infrared), :class:`PinFetReceiver`, :class:`Fso`,
+                       :class:`GammaGamma`, :class:`PointingError`,
+                       :func:`rytov_variance`, :func:`fog_attenuation_db_per_km`
+channel coding         :class:`Crc`, :class:`Scrambler`, :class:`Interleaver`,
+                       :class:`ConvolutionalCode`, :class:`TurboCode`,
+                       :class:`LdpcCode`, :class:`PolarCode`, :class:`NrLdpc`,
+                       :class:`NrPolar`,
+                       :class:`ReedSolomonCode`, :class:`BchCode`, :class:`Ccdm`,
+                       :func:`free_distance`, :func:`pack_symbols`,
+                       :func:`unpack_symbols`, :class:`Dvbs`, :func:`dvb_packets`,
+                       :class:`Dvbs2`, :func:`dvbs2_bbframe`,
+                       :func:`dvbs2_bbframe_data`, :func:`dvbs2_decode_plheader`,
+                       :class:`Dvbt`, :func:`dvbt_channel_gains`,
+                       :class:`CcsdsRs`, :class:`CcsdsLdpc`, :class:`CcsdsTurbo`,
+                       :class:`CcsdsConvolutional`, :func:`ccsds_randomizer`,
+                       :func:`ccsds_marker`, :func:`ccsds_cadu`
+OFDM and PAPR          :class:`Ofdm`, :class:`PaprReduction`, :func:`papr_db`,
+                       :func:`papr_db_blocks`,
+                       :func:`ccdf`, :func:`clipping_bussgang`
+filtered multicarrier  :class:`Fbmc` (FBMC/OQAM, PHYDYAS), :func:`oqam_stagger`,
+                       :func:`oqam_destagger`, :class:`Ufmc`, :func:`chebyshev_window`
+OTFS                   :class:`Otfs`, :func:`delay_doppler_paths`
+CPM and CE-OFDM        :class:`Cpm`, :func:`msk_precode`, :func:`msk_bits`,
+                       :func:`theory_msk_psd`, :class:`CeOfdm`, :func:`ce_ofdm_imp_powers`,
+                       :func:`ce_ofdm_optimum_gain`, :func:`theory_ce_ofdm_ber_optimum`,
+                       :func:`pm_occupied_bandwidth`
+chirp spread spectrum  :class:`Css` (the modulation of LoRa), :func:`theory_css_ser`,
+                       :func:`theory_css_ber`, :func:`css_cross_correlation`,
+                       :func:`css_max_cross_correlation`,
+                       :func:`css_continuous_spectrum`, :func:`css_spectral_lines`,
+                       :func:`css_occupied_bandwidth`, :func:`css_interference_pattern`,
+                       :func:`theory_css_ser_interference`
+OFDM links             :class:`ResourceGrid`, :func:`ofdm_estimate`,
+                       :func:`ofdm_preamble`, :func:`schmidl_cox`,
+                       :func:`ofdm_synchronize`, :func:`ofdm_budget`,
+                       :func:`ofdm_timing_noise`, :class:`Wiener2d`, :class:`RobustDesign`,
+                       :class:`LowRank`, :func:`ls_noise_factor`, :func:`random_delay_correlation`,
+                       :class:`TdlChannel`,
+                       :class:`ChannelTaps`, :func:`power_delay_profile`,
+                       :func:`rms_delay_spread`, :class:`CdlChannel`,
+                       :func:`cdl_profile`, :func:`cdl_k_factor_db`,
+                       :func:`path_loss_db`, :func:`shadow_fading_std_db`,
+                       :func:`los_probability`, :func:`uma_environment_height`,
+                       :func:`building_penetration_db`,
+                       :func:`gain_limited_correction`, :func:`theory_sdr_gain_limited`,
+                       :func:`theory_sdr_optimum_correction`
+amplifiers and DPD     :func:`pa_rapp`, :func:`pa_saleh`, :func:`pa_memory_polynomial`,
+                       :func:`rapp_predistort`, :class:`MemoryPolynomialDpd`,
+                       :func:`amplifier_bussgang`
+blind estimation       :func:`cumulants`, :func:`theory_cumulants`,
+                       :func:`classify_modulation`, :func:`snr_m2m4_db`, :func:`snr_crb_nmse`,
+                       :func:`estimate_symbol_rate`, :func:`cyclic_autocorrelation`
+converters             :func:`adc`, :func:`dac`, :func:`theory_sqnr_sine_db`,
+                       :func:`theory_quantization_mse`, :func:`optimal_loading`,
+                       :func:`theory_jitter_snr_db`, :func:`enob_from_sinad_db`,
+                       :func:`zero_order_hold_gain`
+spectrum               :func:`psd`, :func:`periodogram`, :func:`aclr_db`
+MIMO                   :func:`mimo_channel`, :func:`mimo_channels`,
+                       :func:`exponential_correlation`,
+                       :func:`mimo_detect`, :func:`mimo_llr`, :func:`mimo_estimate`,
+                       :class:`MimoTraining`, :func:`blue_weights`, :func:`blue_combine`,
+                       :func:`blue_mse`,
+                       :func:`message_passing`, :func:`amp_state_evolution`,
+                       :func:`amp_thresholds`, :func:`oamp_state_evolution`,
+                       :class:`Ostbc`, :func:`mimo_capacity`, :func:`water_filling_powers`,
+                       :func:`eigenmode`, :func:`zf_precoder`,
+                       :func:`theory_ergodic_capacity`, :func:`theory_outage_probability`,
+                       :func:`theory_outage_capacity`
+chains                 :class:`Chain` (named blocks, run on the Rust runner),
+                       :mod:`comnum.blocks`, :class:`Block`, :class:`Native`,
+                       :func:`var` and :class:`Var` (a grid variable as a parameter),
+                       :class:`Frame`, :class:`LinkBlock`, :func:`frame_metrics`
+analysis               :class:`Results`, :func:`compare`, :class:`Trace`,
+                       :mod:`comnum.plot` (constellation, eye, time, PSD, curves)
+Monte Carlo            :mod:`comnum.sim` (Python trials on the Rust runner: ``run``,
+                       ``grid``, ``Stop``, ``Record``, ``ErrorRate``, ``Mean``)
+declarative campaigns  :func:`run_spec` (a YAML specification on the parallel Rust
+                       runner), :func:`verify_spec` (check its expected results),
+                       :func:`search_spec` (the operating point of a metric),
+                       :func:`spec_conditions`, :func:`spec_blocks`,
+                       :func:`spec_schema`, :func:`spec_check_link`,
+                       :class:`Tolerance` (the acceptance rule of the expectations)
+recordings             :func:`read_sigmf`, :func:`write_sigmf`
+link theory            :func:`theory_ber_imperfect_csi`, :func:`theory_ber_dpsk_jakes`,
+                       :func:`envelope_series`, :func:`distortion_spectrum`,
+                       :func:`bessel_j0`
+5G NR                  :func:`nr_numerology`, :func:`nr_ofdm_modulate`, :func:`nr_pss`,
+                       :func:`nr_sss`, :func:`nr_pbch_dmrs`, :func:`nr_ssb_indices`,
+                       :func:`nr_ssb_grid`, :func:`nr_detect_cell_id`,
+                       :func:`nr_pdsch_dmrs`, :func:`nr_mcs`, :func:`nr_tbs`,
+                       :func:`nr_constellation`, :class:`NrTransportBlock`,
+                       :class:`NrHarqProcess`, :class:`NrPdsch`
+FM broadcasting        :func:`fm_modulate`, :func:`fm_discriminator`, :func:`fm_preemphasis`,
+                       :func:`fm_deemphasis`, :func:`fm_multiplex`, :func:`fm_stereo_decode`,
+                       :func:`rds_group_bits`, :func:`rds_differential_encode`,
+                       :func:`rds_receive`
+LTE                    :func:`lte_frame`, :func:`lte_pss`, :func:`lte_cell_search`,
+                       :func:`lte_decode_mib`, :func:`zadoff_chu`
+AIS                    :func:`ais_transmit`, :func:`ais_receive`, :func:`ais_decode`,
+                       :func:`ais_position_report`, :func:`ais_aivdm`, :func:`ais_messages`,
+                       :func:`ais_front_end_rate`
+=====================  ===============================================================
+
+Example:
+    >>> import comnum
+    >>> rng = comnum.Rng(1)
+    >>> c = comnum.Constellation("qam", 16).normalized()
+    >>> b = comnum.bits(4 * 20_000, rng)
+    >>> y = comnum.awgn_ebn0(c.map_bits(b), 10.0, 4, rng)
+    >>> ber = comnum.ber(c.demap_bits(y), b)
+    >>> abs(ber / comnum.theory_ber(16, 10.0, "qam") - 1) < 0.2
+    True
+"""
+
+from comnum import blocks, plot, sim
+from comnum._comnum import (
+    BchCode,
+    Ccdm,
+    CcsdsConvolutional,
+    CcsdsLdpc,
+    CcsdsRs,
+    CcsdsTurbo,
+    CdlChannel,
+    CeOfdm,
+    ChannelTaps,
+    Constellation,
+    ConvolutionalCode,
+    Cpm,
+    Crc,
+    Css,
+    Dpsk,
+    Dvbs,
+    Dvbs2,
+    Dvbt,
+    Edfa,
+    Fbmc,
+    FiberParams,
+    Frame,
+    Fso,
+    GammaGamma,
+    Interleaver,
+    LdpcCode,
+    LinkBlock,
+    LowRank,
+    ManakovPmd,
+    ManakovSsfm,
+    MemoryPolynomialDpd,
+    MimoTraining,
+    NrHarqProcess,
+    NrLdpc,
+    NrPdsch,
+    NrPolar,
+    NrTransportBlock,
+    Ofdm,
+    Ostbc,
+    Otfs,
+    OwcIllumination,
+    OwcImpulseResponse,
+    OwcRoom,
+    PaprReduction,
+    Photodiode,
+    PinFetReceiver,
+    PointingError,
+    PolarCode,
+    ReedSolomonCode,
+    ResourceGrid,
+    Rng,
+    RobustDesign,
+    Scrambler,
+    Ssfm,
+    TdlChannel,
+    Tolerance,
+    TurboCode,
+    Ufmc,
+    Wiener2d,
+    __version__,
+    aclr_db,
+    adaptive_equalizer,
+    adc,
+    ais_aivdm,
+    ais_decode,
+    ais_front_end_rate,
+    ais_messages,
+    ais_position_report,
+    ais_receive,
+    ais_transmit,
+    amp_state_evolution,
+    amp_thresholds,
+    amplifier_bussgang,
+    anorm,
+    awgn,
+    awgn_ebn0,
+    balanced_photodiode,
+    ber,
+    ber_to_q_db,
+    bessel_j0,
+    bits,
+    blue_combine,
+    blue_mse,
+    blue_weights,
+    bps,
+    bpsk_llr,
+    bpsk_noise_variance,
+    building_penetration_db,
+    butterworth_lowpass,
+    ccdf,
+    ccsds_cadu,
+    ccsds_marker,
+    ccsds_randomizer,
+    cd_dispersion_factor,
+    cd_fir_taps,
+    cd_ls_error,
+    cd_ls_taps,
+    cd_savory_taps,
+    cd_taps_needed,
+    cdc,
+    cdl_k_factor_db,
+    cdl_profile,
+    ce_ofdm_imp_powers,
+    ce_ofdm_optimum_gain,
+    chebyshev_window,
+    classify_modulation,
+    clipping_bussgang,
+    clock_offset,
+    coherent_receiver,
+    convolve,
+    css_continuous_spectrum,
+    css_cross_correlation,
+    css_interference_pattern,
+    css_max_cross_correlation,
+    css_occupied_bandwidth,
+    css_spectral_lines,
+    cumulants,
+    cyclic_autocorrelation,
+    dac,
+    db2lin,
+    dbm2w,
+    ddpll,
+    decimate,
+    delay_doppler_paths,
+    delay_fft,
+    derotate,
+    distortion_spectrum,
+    downsample,
+    dvb_packets,
+    dvbs2_bbframe,
+    dvbs2_bbframe_data,
+    dvbs2_decode_plheader,
+    dvbt_channel_gains,
+    eigenmode,
+    enob_from_sinad_db,
+    entropy,
+    envelope_series,
+    estimate_symbol_rate,
+    evm,
+    exponential_correlation,
+    fast_ber_calc,
+    fir_filter,
+    fm_deemphasis,
+    fm_discriminator,
+    fm_modulate,
+    fm_multiplex,
+    fm_preemphasis,
+    fm_stereo_decode,
+    fog_attenuation_db_per_km,
+    format_moments,
+    fourth_power_foe,
+    frame_metrics,
+    free_distance,
+    freq_shift,
+    gain_limited_correction,
+    gardner_clock_recovery,
+    gardner_ted,
+    gardner_ted_nyquist,
+    gn_closed_form,
+    gn_isrs_closed_form,
+    gn_model,
+    gray_code,
+    hybrid_2x4,
+    information_rates,
+    iqm,
+    lagrange_cubic,
+    lambertian_mode,
+    laser,
+    lin2db,
+    linear_fiber_channel,
+    los_probability,
+    low_pass_fir,
+    ls_noise_factor,
+    lte_cell_search,
+    lte_decode_mib,
+    lte_frame,
+    lte_pss,
+    maxwell_boltzmann,
+    message_passing,
+    mimo_capacity,
+    mimo_channel,
+    mimo_channels,
+    mimo_detect,
+    mimo_estimate,
+    mimo_llr,
+    monte_carlo_gmi,
+    monte_carlo_mi,
+    moving_average,
+    msk_bits,
+    msk_precode,
+    mzm,
+    nr_constellation,
+    nr_detect_cell_id,
+    nr_mcs,
+    nr_numerology,
+    nr_ofdm_modulate,
+    nr_pbch_dmrs,
+    nr_pdsch_dmrs,
+    nr_pss,
+    nr_ssb_grid,
+    nr_ssb_indices,
+    nr_sss,
+    nr_tbs,
+    o150_sequence,
+    oamp_state_evolution,
+    ofdm_budget,
+    ofdm_estimate,
+    ofdm_preamble,
+    ofdm_synchronize,
+    ofdm_timing_noise,
+    optimal_loading,
+    oqam_destagger,
+    oqam_stagger,
+    owc_direction,
+    owc_illuminance,
+    pa_memory_polynomial,
+    pa_rapp,
+    pa_saleh,
+    pack_symbols,
+    papr_db,
+    papr_db_blocks,
+    path_loss_db,
+    periodogram,
+    phase_error_std,
+    phase_modulator,
+    phase_noise,
+    pm_occupied_bandwidth,
+    pnorm,
+    posterior_rates,
+    power_delay_profile,
+    prbs,
+    psd,
+    pulse_shape,
+    qfunc,
+    raman_profile,
+    random_delay_correlation,
+    rapp_predistort,
+    rc_taps,
+    rds_differential_encode,
+    rds_group_bits,
+    rds_receive,
+    read_sigmf,
+    resample_fft,
+    resample_rational,
+    rms_delay_spread,
+    rrc_spectrum,
+    rrc_taps,
+    run_spec,
+    rytov_variance,
+    schmidl_cox,
+    search_spec,
+    select_channel,
+    shadow_fading_std_db,
+    snr_crb_nmse,
+    snr_db,
+    snr_m2m4_db,
+    spec_blocks,
+    spec_check_link,
+    spec_conditions,
+    spec_schema,
+    symbols,
+    theory_ber,
+    theory_ber_dpsk,
+    theory_ber_dpsk_jakes,
+    theory_ber_gray,
+    theory_ber_imperfect_csi,
+    theory_ber_rayleigh_mrc,
+    theory_biawgn_capacity,
+    theory_bicm_capacity,
+    theory_bicm_cutoff_rate,
+    theory_ce_ofdm_ber_optimum,
+    theory_cm_capacity,
+    theory_cm_cutoff_rate,
+    theory_css_ber,
+    theory_css_ser,
+    theory_css_ser_interference,
+    theory_cumulants,
+    theory_differential_phase_tail,
+    theory_ergodic_capacity,
+    theory_gmi,
+    theory_jitter_snr_db,
+    theory_mi,
+    theory_msk_psd,
+    theory_normal_approximation,
+    theory_outage_capacity,
+    theory_outage_probability,
+    theory_papr_ccdf,
+    theory_phase_pdf,
+    theory_quantization_mse,
+    theory_rs_ber,
+    theory_rs_ser,
+    theory_rs_wer,
+    theory_sdr_gain_limited,
+    theory_sdr_optimum_correction,
+    theory_ser,
+    theory_ser_esn0,
+    theory_shannon_limit_ebn0_db,
+    theory_sqnr_sine_db,
+    uma_environment_height,
+    unpack_symbols,
+    unwrap,
+    upsample,
+    verify_spec,
+    viterbi_viterbi,
+    w2dbm,
+    water_filling_powers,
+    wdm_grid,
+    write_sigmf,
+    zadoff_chu,
+    zero_order_hold_gain,
+    zf_precoder,
+)
+from comnum.block import Block, Native, Var, var
+from comnum.chain import Chain
+from comnum.results import Results, Trace, compare
+
+__all__ = [
+    "BchCode",
+    "Block",
+    "Ccdm",
+    "CcsdsConvolutional",
+    "CcsdsLdpc",
+    "CcsdsRs",
+    "CcsdsTurbo",
+    "CdlChannel",
+    "CeOfdm",
+    "Chain",
+    "ChannelTaps",
+    "Constellation",
+    "ConvolutionalCode",
+    "Cpm",
+    "Crc",
+    "Css",
+    "Dpsk",
+    "Dvbs",
+    "Dvbs2",
+    "Dvbt",
+    "Edfa",
+    "Fbmc",
+    "FiberParams",
+    "Frame",
+    "Fso",
+    "GammaGamma",
+    "Interleaver",
+    "LdpcCode",
+    "LinkBlock",
+    "LowRank",
+    "ManakovPmd",
+    "ManakovSsfm",
+    "MemoryPolynomialDpd",
+    "MimoTraining",
+    "Native",
+    "NrHarqProcess",
+    "NrLdpc",
+    "NrPdsch",
+    "NrPolar",
+    "NrTransportBlock",
+    "Ofdm",
+    "Ostbc",
+    "Otfs",
+    "OwcIllumination",
+    "OwcImpulseResponse",
+    "OwcRoom",
+    "PaprReduction",
+    "Photodiode",
+    "PinFetReceiver",
+    "PointingError",
+    "PolarCode",
+    "ReedSolomonCode",
+    "ResourceGrid",
+    "Results",
+    "Rng",
+    "RobustDesign",
+    "Scrambler",
+    "Ssfm",
+    "TdlChannel",
+    "Tolerance",
+    "Trace",
+    "TurboCode",
+    "Ufmc",
+    "Var",
+    "Wiener2d",
+    "__version__",
+    "aclr_db",
+    "adaptive_equalizer",
+    "adc",
+    "ais_aivdm",
+    "ais_decode",
+    "ais_front_end_rate",
+    "ais_messages",
+    "ais_position_report",
+    "ais_receive",
+    "ais_transmit",
+    "amp_state_evolution",
+    "amp_thresholds",
+    "amplifier_bussgang",
+    "anorm",
+    "awgn",
+    "awgn_ebn0",
+    "balanced_photodiode",
+    "ber",
+    "ber_to_q_db",
+    "bessel_j0",
+    "bits",
+    "blocks",
+    "blue_combine",
+    "blue_mse",
+    "blue_weights",
+    "bps",
+    "bpsk_llr",
+    "bpsk_noise_variance",
+    "building_penetration_db",
+    "butterworth_lowpass",
+    "ccdf",
+    "ccsds_cadu",
+    "ccsds_marker",
+    "ccsds_randomizer",
+    "cd_dispersion_factor",
+    "cd_fir_taps",
+    "cd_ls_error",
+    "cd_ls_taps",
+    "cd_savory_taps",
+    "cd_taps_needed",
+    "cdc",
+    "cdl_k_factor_db",
+    "cdl_profile",
+    "ce_ofdm_imp_powers",
+    "ce_ofdm_optimum_gain",
+    "chebyshev_window",
+    "classify_modulation",
+    "clipping_bussgang",
+    "clock_offset",
+    "coherent_receiver",
+    "compare",
+    "convolve",
+    "css_continuous_spectrum",
+    "css_cross_correlation",
+    "css_interference_pattern",
+    "css_max_cross_correlation",
+    "css_occupied_bandwidth",
+    "css_spectral_lines",
+    "cumulants",
+    "cyclic_autocorrelation",
+    "dac",
+    "db2lin",
+    "dbm2w",
+    "ddpll",
+    "decimate",
+    "delay_doppler_paths",
+    "delay_fft",
+    "derotate",
+    "distortion_spectrum",
+    "downsample",
+    "dvb_packets",
+    "dvbs2_bbframe",
+    "dvbs2_bbframe_data",
+    "dvbs2_decode_plheader",
+    "dvbt_channel_gains",
+    "eigenmode",
+    "enob_from_sinad_db",
+    "entropy",
+    "envelope_series",
+    "estimate_symbol_rate",
+    "evm",
+    "exponential_correlation",
+    "fast_ber_calc",
+    "fir_filter",
+    "fm_deemphasis",
+    "fm_discriminator",
+    "fm_modulate",
+    "fm_multiplex",
+    "fm_preemphasis",
+    "fm_stereo_decode",
+    "fog_attenuation_db_per_km",
+    "format_moments",
+    "fourth_power_foe",
+    "frame_metrics",
+    "free_distance",
+    "freq_shift",
+    "gain_limited_correction",
+    "gardner_clock_recovery",
+    "gardner_ted",
+    "gardner_ted_nyquist",
+    "gn_closed_form",
+    "gn_isrs_closed_form",
+    "gn_model",
+    "gray_code",
+    "hybrid_2x4",
+    "information_rates",
+    "iqm",
+    "lagrange_cubic",
+    "lambertian_mode",
+    "laser",
+    "lin2db",
+    "linear_fiber_channel",
+    "los_probability",
+    "low_pass_fir",
+    "ls_noise_factor",
+    "lte_cell_search",
+    "lte_decode_mib",
+    "lte_frame",
+    "lte_pss",
+    "maxwell_boltzmann",
+    "message_passing",
+    "mimo_capacity",
+    "mimo_channel",
+    "mimo_channels",
+    "mimo_detect",
+    "mimo_estimate",
+    "mimo_llr",
+    "monte_carlo_gmi",
+    "monte_carlo_mi",
+    "moving_average",
+    "msk_bits",
+    "msk_precode",
+    "mzm",
+    "nr_constellation",
+    "nr_detect_cell_id",
+    "nr_mcs",
+    "nr_numerology",
+    "nr_ofdm_modulate",
+    "nr_pbch_dmrs",
+    "nr_pdsch_dmrs",
+    "nr_pss",
+    "nr_ssb_grid",
+    "nr_ssb_indices",
+    "nr_sss",
+    "nr_tbs",
+    "o150_sequence",
+    "oamp_state_evolution",
+    "ofdm_budget",
+    "ofdm_estimate",
+    "ofdm_preamble",
+    "ofdm_synchronize",
+    "ofdm_timing_noise",
+    "optimal_loading",
+    "oqam_destagger",
+    "oqam_stagger",
+    "owc_direction",
+    "owc_illuminance",
+    "pa_memory_polynomial",
+    "pa_rapp",
+    "pa_saleh",
+    "pack_symbols",
+    "papr_db",
+    "papr_db_blocks",
+    "path_loss_db",
+    "periodogram",
+    "phase_error_std",
+    "phase_modulator",
+    "phase_noise",
+    "plot",
+    "pm_occupied_bandwidth",
+    "pnorm",
+    "posterior_rates",
+    "power_delay_profile",
+    "prbs",
+    "psd",
+    "pulse_shape",
+    "qfunc",
+    "raman_profile",
+    "random_delay_correlation",
+    "rapp_predistort",
+    "rc_taps",
+    "rds_differential_encode",
+    "rds_group_bits",
+    "rds_receive",
+    "read_sigmf",
+    "resample_fft",
+    "resample_rational",
+    "rms_delay_spread",
+    "rrc_spectrum",
+    "rrc_taps",
+    "run_spec",
+    "rytov_variance",
+    "schmidl_cox",
+    "search_spec",
+    "select_channel",
+    "shadow_fading_std_db",
+    "sim",
+    "snr_crb_nmse",
+    "snr_db",
+    "snr_m2m4_db",
+    "spec_blocks",
+    "spec_check_link",
+    "spec_conditions",
+    "spec_schema",
+    "symbols",
+    "theory_ber",
+    "theory_ber_dpsk",
+    "theory_ber_dpsk_jakes",
+    "theory_ber_gray",
+    "theory_ber_imperfect_csi",
+    "theory_ber_rayleigh_mrc",
+    "theory_biawgn_capacity",
+    "theory_bicm_capacity",
+    "theory_bicm_cutoff_rate",
+    "theory_ce_ofdm_ber_optimum",
+    "theory_cm_capacity",
+    "theory_cm_cutoff_rate",
+    "theory_css_ber",
+    "theory_css_ser",
+    "theory_css_ser_interference",
+    "theory_cumulants",
+    "theory_differential_phase_tail",
+    "theory_ergodic_capacity",
+    "theory_gmi",
+    "theory_jitter_snr_db",
+    "theory_mi",
+    "theory_msk_psd",
+    "theory_normal_approximation",
+    "theory_outage_capacity",
+    "theory_outage_probability",
+    "theory_papr_ccdf",
+    "theory_phase_pdf",
+    "theory_quantization_mse",
+    "theory_rs_ber",
+    "theory_rs_ser",
+    "theory_rs_wer",
+    "theory_sdr_gain_limited",
+    "theory_sdr_optimum_correction",
+    "theory_ser",
+    "theory_ser_esn0",
+    "theory_shannon_limit_ebn0_db",
+    "theory_sqnr_sine_db",
+    "uma_environment_height",
+    "unpack_symbols",
+    "unwrap",
+    "upsample",
+    "var",
+    "verify_spec",
+    "viterbi_viterbi",
+    "w2dbm",
+    "water_filling_powers",
+    "wdm_grid",
+    "write_sigmf",
+    "zadoff_chu",
+    "zero_order_hold_gain",
+    "zf_precoder",
+]