lagrange 0.3.0

Python library with a basic native implementation of Lagrange interpolation over finite fields.

Python library with a basic native implementation of Lagrange interpolation over finite fields.

Purpose

Native implementation of the Lagrange interpolation algorithm over finite fields.

Package Installation and Usage

The package is available 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

Documentation

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

cd docs
python -m pip install -r requirements.txt
sphinx-apidoc -f -E --templatedir=_templates -o _source .. ../setup.py && make html

Testing and Conventions

All unit tests are executed and their coverage is measured when using nose (see setup.cfg for configuration details):

python -m pip install nose coverage
nosetests --cover-erase

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

python lagrange/lagrange.py -v

Style conventions are enforced using Pylint:

python -m pip install pylint
pylint 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.