Skip to main content

A minimalistic symbolic package.

Project description

symbolite: a minimalistic symbolic python package


Symbolite allows you tu create symbolic mathematical expressions. Just create a symbol (or more) and operate with them as you will normally do in Python.

>>> from symbolite import Symbol
>>> x = Symbol("x")
>>> y = Symbol("y")
>>> expr1 = x + 3 * y
>>> print(expr1)
(x + (3 * y))

You can easily replace the symbols by the desired value.

>>> expr2 = expr1.replace_by_name(x=5, y=2)
>>> print(expr2)
(5 + (3 * 2))

The output is still a symbolic expression, which you can evaluate:

>>> expr2.eval()
11

Notice that we also got a warning (No libsl provided, defaulting to 'math'). This is because evaluating an expression requires a actual library implementation, name usually as libsl. The default one just uses python's math module.

You can avoid this warning by explicitely providing an libsl implementation.

>>> from symbolite.libimpl import math as _math
>>> expr2.eval(_math)
11

or importing it as libsl and let symbolite

>>> from symbolite.libimpl import math as libsl
>>> expr2.eval()
11

The cool thing about this is that you can use a different implementation but let's not get too much ahead of ourselves.

Mathematical functions are available in the lib module.

>>> from symbolite import lib
>>> expr3 = 3. * lib.cos(0.5)
>>> print(expr3)
(3.0 * libsl.cos(0.5))

(Functions are named according to the python math module). Again, this is a symbolic expression until evaluated.

>>> expr3.eval()
2.6327476856711

Two other implementations are provided: NumPy and SymPy:

>>> from symbolite.libimpl import numpy as libsl
>>> expr3.eval()
2.6327476856711
>>> from symbolite.libimpl import sympy as libsl
>>> expr3.eval()
2.6327476856711

(notice that the way that the different libraries round and display may vary)

In general, all symbols must be replaced by values in order to evaluate an expression. However, when using an implementation like SymPy that contains a Symbol object you can still evaluate.

>>> (3. * lib.cos(x).eval())
3.0*cos(x)

which is actually a SymPy expression with a SymPy symbol (x).

Installing:

pip install -U symbolite

FAQ

Q: Is symbolite a replacement for SymPy?

A: No

Q: Does it aim to be a replacement for SymPy in the future?

A: No

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

symbolite-0.1.1.tar.gz (16.2 kB view hashes)

Uploaded Source

Built Distribution

symbolite-0.1.1-py3-none-any.whl (16.6 kB view hashes)

Uploaded Python 3

Supported by

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