Skip to main content

Pure-Python implementation of Lagrange interpolation over finite fields.""

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 way:

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


Download files

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

Source Distribution

lagrange-3.0.1.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: lagrange-3.0.1.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for lagrange-3.0.1.tar.gz
Algorithm Hash digest
SHA256 272f352a676679ee318b0b302054f667f23afb73d10063cd3926c612527e09f1
MD5 13a0c9d29669ef519daa19d3fb0c3672
BLAKE2b-256 079d4b6470fd6769b0943fbda9b30e2068bb8d9940be2977b1e80a184d527fa6

See more details on using hashes here.

Provenance

The following attestation bundles were made for lagrange-3.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-3.0.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for lagrange-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d473913d901f0c257456c505e4a94450f2e4a2f147460a68ad0cfb9ea33a6d0a
MD5 8a9c793d5412a3b3c07929a021bdf362
BLAKE2b-256 3ed8f1c3ff60a8b3e114cfb3e9eed75140d2a3e1e766791cfe2f210a5c736d61

See more details on using hashes here.

Provenance

The following attestation bundles were made for lagrange-3.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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page