Pure-Python implementation of Lagrange interpolation over finite fields.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for lapets from gravatar.com lapets
Meta

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: MIT
    SPDX License Expression
  • Author: Andrei Lapets
  • Requires: Python >=3.9
  • Provides-Extra: docs , test , lint , coveralls , publish
Report project as malware

Project description

Pure-Python implementation of Lagrange interpolation over finite fields.

PyPI version and link. Read the Docs documentation status. GitHub Actions status. Coveralls test coverage summary.

Purpose

This library provides a pure-Python implementation of the Lagrange interpolation algorithm over finite fields.

Installation and Usage

This library is available as a package on PyPI:

python -m pip install lagrange

The library can be imported in the usual manner:

from lagrange import lagrange

Examples

Interpolation can be performed on collections of points represented in a variety of ways:

>>> lagrange({1: 15, 2: 9, 3: 3}, 17)
4
>>> lagrange([(1, 15), (2, 9), (3, 3)], 17)
4
>>> lagrange([15, 9, 3], 17)
4
>>> lagrange(
...     {
...         1: 119182, 2: 11988467, 3: 6052427, 4: 8694701,
...         5: 9050123, 6: 3676518, 7: 558333, 8: 12198248,
...         9: 7344866, 10: 10114014, 11: 2239291, 12: 2515398
...     },
...     15485867
... )
123
>>> lagrange(
...     [
...         119182, 11988467, 6052427, 8694701, 9050123, 3676518,
...         558333, 12198248, 7344866, 10114014, 2239291, 2515398
...     ],
...     15485867
... )
123

Development

All installation and development dependencies are fully specified in pyproject.toml. The project.optional-dependencies object is used to specify optional requirements for various development tasks. This makes it possible to specify additional options (such as docs, lint, and so on) when performing installation using pip:

python -m pip install ".[docs,lint]"

Documentation

The documentation can be generated automatically from the source files using Sphinx:

python -m pip install ".[docs]"
cd docs
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html

Testing and Conventions

All unit tests are executed and their coverage is measured when using pytest (see the pyproject.toml file for configuration details):

python -m pip install ".[test]"
python -m pytest

Alternatively, all unit tests are included in the module itself and can be executed using doctest:

python src/lagrange/lagrange.py -v

Style conventions are enforced using Pylint:

python -m pip install ".[lint]"
python -m pylint src/lagrange

Contributions

In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.

Versioning

Beginning with version 0.2.0, the version number format for this library and the changes to the library associated with version number increments conform with Semantic Versioning 2.0.0.

Publishing

This library can be published as a package on PyPI via the GitHub Actions workflow found in .github/workflows/build-publish-sign-release.yml that follows the recommendations found in the Python Packaging User Guide.

Ensure that the correct version number appears in pyproject.toml, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an automation rule that activates and sets as the default all tagged versions.

To publish the package, create and push a tag for the version being published (replacing ?.?.? with the version number):

git tag ?.?.?
git push origin ?.?.?

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for lapets from gravatar.com lapets
Meta

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: MIT
    SPDX License Expression
  • Author: Andrei Lapets
  • Requires: Python >=3.9
  • Provides-Extra: docs , test , lint , coveralls , publish

Release history Release notifications | RSS feed

This version

4.0.1

3.0.1

2.1.0

2.0.2

2.0.1

2.0.0

1.0.0

0.3.0

0.2.0

0.1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lagrange-4.0.1.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lagrange-4.0.1-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file lagrange-4.0.1.tar.gz.

File metadata

  • Download URL: lagrange-4.0.1.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lagrange-4.0.1.tar.gz
Algorithm Hash digest
SHA256 2066c004238802a17f7bd1377453c09942e3dcfe723e2b8abd32ec6e7b914b8f
MD5 02199c4f38501a5155bd6202e8413885
BLAKE2b-256 ecb8cc2b22ce0bb0672e102709a485272b18c1b6e895f2aae4214751ba2e0553

See more details on using hashes here.

Provenance

The following attestation bundles were made for lagrange-4.0.1.tar.gz:

Publisher: build-publish-sign-release.yml on lapets/lagrange

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lagrange-4.0.1-py3-none-any.whl.

File metadata

  • Download URL: lagrange-4.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lagrange-4.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 de8bdeb243f4da4a8366f85fdabd1ff9df99564eb8e45f0bd43828395a01f1e9
MD5 801a7c5cba39c94e8f544f22672c47e2
BLAKE2b-256 1fe53c19721faa639564e64e431bca91794eac42fd24573d8eb480bbd2dfadcb

See more details on using hashes here.

Provenance

The following attestation bundles were made for lagrange-4.0.1-py3-none-any.whl:

Publisher: build-publish-sign-release.yml on lapets/lagrange

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page