https://github.com/tueda/donuts-python

Python binding to Donuts: 🍩 × 🐍
https://github.com/tueda/donuts-python

binding computer-algebra mathematics multivariate-polynomials python

Last synced: 3 months ago
JSON representation

Python binding to Donuts: 🍩 × 🐍

• Host: GitHub
• URL: https://github.com/tueda/donuts-python
• Owner: tueda
• License: mit
• Created: 2019-08-22T15:15:39.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2025-02-22T09:37:33.000Z (11 months ago)
• Last Synced: 2025-02-22T09:42:04.259Z (11 months ago)
• Topics: binding, computer-algebra, mathematics, multivariate-polynomials, python
• Language: Python
• Homepage:
• Size: 172 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Donuts-Python

=============

.. image:: https://badge.fury.io/py/donuts-python.svg

    :target: https://pypi.org/project/donuts-python/

    :alt: PyPI version

.. image:: https://github.com/tueda/donuts-python/actions/workflows/test.yml/badge.svg?branch=main

    :target: https://github.com/tueda/donuts-python/actions?query=branch:main

    :alt: Test

.. image:: https://readthedocs.org/projects/donuts-python/badge/?version=latest

    :target: https://donuts-python.readthedocs.io/en/latest/

    :alt: Documentation Status

Python binding to the `Donuts`_ wrapper for the `Rings`_ library by Stanislav Poslavsky.

Requirements

------------

* Python 3.7 or later

* Java 8 or later

Installation

------------

.. code:: shell

    pip install donuts-python

Example

-------

.. code:: python

    >>> from donuts import *

    >>> a = Polynomial('1 + x + y')

    >>> b = Polynomial('1 + y + z')

    >>> g = a + b

    >>> g

    Polynomial('2+z+2*y+x')

    >>> ag = a * g

    >>> bg = b * g

    >>> ag.gcd(bg)  # must be equal to g

    Polynomial('2+z+2*y+x')

    >>> ag / bg  # same as RationalFunction(ag, bg)

    RationalFunction('(1+y+x)/(1+z+y)')

    >>> Polynomial('2*x^2 - 2*x^3 + 2*x^2*y - 2*x^3*y').factors

    (Polynomial('-2'), Polynomial('x'), Polynomial('x'), Polynomial('-1+x'), Polynomial('1+y'))

Development

-----------

.. The code is tested by "readme_dev" in .github/workflows/test.yml and .gitlab-ci.yml.

.. code:: shell

    git submodule update --init

    poetry install

    poetry run invoke prepare

    poetry run invoke build

    poetry run invoke fmt

    poetry run invoke lint

    poetry run invoke test

    poetry run invoke bench

    poetry run invoke doc

    DONUTS_PYTHON_BACKEND=pyjnius poetry run invoke test

    DONUTS_PYTHON_BACKEND=py4j    poetry run invoke test

    DONUTS_PYTHON_BACKEND=jpype   poetry run invoke test

    poetry run invoke build --sdist --wheel

Acknowledgements

----------------

This software was developed as part of the project supported by JSPS KAKENHI Grant Number 19K03831.

License

-------

Donuts-Python is distributed under the MIT license.

The wheel contains a fat JAR file generated from the following dependencies:

* `Donuts`_ (MIT)

* `Rings`_ (Apache 2.0)

* `libdivide4j`_ (Apache 2.0)

* `Combinatorics for Java`_ (Apache 2.0)

* `Apache Commons Math`_ (Apache 2.0)

* `GNU Trove`_ (LGPL 2.1)

.. _Donuts: https://github.com/tueda/donuts

.. _Rings:  https://github.com/PoslavskySV/rings

.. _libdivide4j: https://github.com/PoslavskySV/libdivide4j

.. _Combinatorics for Java: https://github.com/PoslavskySV/combinatorics

.. _Apache Commons Math: https://github.com/apache/commons-math

.. _GNU Trove: https://bitbucket.org/trove4j/trove