Skip to main content

analog-ecc-heights

Python and C++ methods for computing the height profile of analog error-correcting codes, including Jiang's LP formulations and Roth's LP and combinatorial formulations. The distribution is analog-ecc-heights; the Python import is analog_ecc_heights.

One package provides a NumPy/SciPy implementation by default and optional native backends. Installing native support does not change the default backend.

Install

Requires Python 3.10 or later. Install the published package from PyPI:

python -m pip install analog-ecc-heights

Pip installs NumPy >=1.23 and SciPy >=1.9 automatically. Version 0.1.2 is available as a Python wheel and source archive.

Use an existing Python environment or follow the environment setup guide to create a virtual environment or use Conda. If your Python command is python3 or py, use it in place of python.

The default installation does not invoke CMake or require a compiler, Eigen, GLPK, or a separately installed HiGHS library. Native support is an optional source build of this same distribution; see native installation. To install from a checkout, see source installation.

Use

import numpy as np
from analog_ecc_heights import (
    available_backends,
    h_m_roth_primal_lp,
    h_m_roth_primal_combinatorial,
)

G = np.array([[1.0, 0.0, 1.0], [0.0, 1.0, 1.0]])

print(h_m_roth_primal_lp(G, 1))                         # 2.0
print(h_m_roth_primal_lp(G, 1, early_quit_threshold=1.5)) # 1.5
print(h_m_roth_primal_combinatorial(G))                # [2.0]
print(available_backends())                           # ["python"] in a default install

With m=None, the primal combinatorial method returns the finite profile [h_1, ..., h_(d-1)], where d is the minimum distance under tol. Its length is d-1; codes with d=1 return [].

For a native-enabled installation, select the implementation explicitly:

h_m_roth_primal_lp(G, 1, backend="cpp-glpk")
h_m_roth_primal_lp(G, 1, backend="cpp-highs", num_threads=1)
h_m_roth_primal_combinatorial(G, 1, backend="cpp", num_threads=1)
Backend Methods Separately installed native dependencies
python LP and combinatorial None; LP uses the HiGHS solver included with SciPy
cpp Combinatorial Eigen headers at build time; OpenMP
cpp-glpk LP Eigen headers at build time; GLPK headers and library
cpp-highs LP Eigen headers at build time; HiGHS headers and library; OpenMP

An unavailable backend raises an installation error. Unsupported combinations raise an argument error. Calls never switch to another backend automatically.

Documentation and examples

License

Licensed under the MIT License.

References

The height definitions and published formulations come from these papers; the method-to-formula mapping also identifies derived variants:

  1. Ron M. Roth, “Analog Error-Correcting Codes,” IEEE Transactions on Information Theory, 66(7), 4075–4088, 2020.
  2. Anxiao Jiang, “Analog Error-Correcting Codes: Designs and Analysis,” IEEE Transactions on Information Theory, 70(11), 7740–7756, 2024.
  3. Ron M. Roth, Ziyuan Zhu, Changcheng Yuan, Paul H. Siegel, and Anxiao Jiang, “On the Height Profile of Analog Error-Correcting Codes,” 2026 IEEE International Symposium on Information Theory (ISIT), also available as arXiv:2602.20366.

Roth's 2020 paper has a 2023 correction concerning decoder requirements and proofs. It does not change the height computations implemented here.

Metadata

Release files for analog-ecc-heights 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for analog-ecc-heights 0.1.2
File Size Uploaded Provenance Actions
analog_ecc_heights-0.1.2.tar.gz 60.3 kB Without provenance Details for analog_ecc_heights-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for analog-ecc-heights 0.1.2
File Interpreter ABI Platform Actions
analog_ecc_heights-0.1.2-py3-none-any.whl Python 3 none any Details for analog_ecc_heights-0.1.2-py3-none-any.whl

Total release size: 80.2 kB

Release files / analog_ecc_heights-0.1.2.tar.gz

Download URL analog_ecc_heights-0.1.2.tar.gz
Size 60.3 kB
Tags Source
SHA-256 checksum
How to use checksums
ac7aad823459749392c02ea388e6741416f79d4d99ea040fbd956123ace980a3
BLAKE2b-256 checksum
How to use checksums
b91093b8057b21abdf07fdd309c9ba55c2a1b49d2dbef0e824388b1310ac0eaa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.20

Release files / analog_ecc_heights-0.1.2-py3-none-any.whl

Download URL analog_ecc_heights-0.1.2-py3-none-any.whl
Size 20.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1f35129adcae0d2c27aa98f7b235a2504637f4081e4fef388cb7e3cc8de57685
BLAKE2b-256 checksum
How to use checksums
341eb34a4c57b4c59e3adbea779af9534b3f4d08701e8d248e64d802d6702c6a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.20

Security for analog-ecc-heights 0.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page