Skip to main content

Orthogonal polynomials for Python

Project description

orthopy

All about orthogonal polynomials.

PyPi Version PyPI pyversions GitHub stars Downloads

Discord orthogonal

orthopy provides various orthogonal polynomial classes for lines, triangles, disks, spheres, n-cubes, the nD space with weight function exp(-r2) and more. All computations are done using numerically stable recurrence schemes. Furthermore, all functions are fully vectorized and can return results in exact arithmetic.

Installation

Install orthopy from PyPI with

pip install orthopy

How to get a license

Licenses for personal and academic use can be purchased here. You'll receive a confirmation email with a license key. Install the key with

plm add <your-license-key>

on your machine and you're good to go.

For commercial use, please contact support@mondaytech.com.

Basic usage

The main function of all submodules is the iterator Eval which evaluates the series of orthogonal polynomials with increasing degree at given points using a recurrence relation, e.g.,

import orthopy

x = 0.5

evaluator = orthopy.c1.legendre.Eval(x, "classical")
for _ in range(5):
     print(next(evaluator))
1.0          # P_0(0.5)
0.5          # P_1(0.5)
-0.125       # P_2(0.5)
-0.4375      # P_3(0.5)
-0.2890625   # P_4(0.5)

Other ways of getting the first n items are

evaluator = Eval(x, "normal")
vals = [next(evaluator) for _ in range(n)]

import itertools
vals = list(itertools.islice(Eval(x, "normal"), n))

Instead of evaluating at only one point, you can provide any array for x; the polynomials will then be evaluated for all points at once. You can also use sympy for symbolic computation:

import itertools
import orthopy
import sympy

x = sympy.Symbol("x")

evaluator = orthopy.c1.legendre.Eval(x, "classical")
for val in itertools.islice(evaluator, 5):
     print(sympy.expand(val))
1
x
3*x**2/2 - 1/2
5*x**3/2 - 3*x/2
35*x**4/8 - 15*x**2/4 + 3/8

All Eval methods have a scaling argument which can have three values:

  • "monic": The leading coefficient is 1.
  • "classical": The maximum value is 1 (or (n+alpha over n)).
  • "normal": The integral of the squared function over the domain is 1.

For univariate ("one-dimensional") integrals, every new iteration contains one function. For bivariate ("two-dimensional") domains, every level will contain one function more than the previous, and similarly for multivariate families. See the tree plots below.

Line segment (-1, +1) with weight function (1-x)α (1+x)β

Legendre Chebyshev 1 Chebyshev 2

Jacobi, Gegenbauer (α=β), Chebyshev 1 (α=β=-1/2), Chebyshev 2 (α=β=1/2), Legendre (α=β=0) polynomials.

import orthopy

orthopy.c1.legendre.Eval(x, "normal")
orthopy.c1.chebyshev1.Eval(x, "normal")
orthopy.c1.chebyshev2.Eval(x, "normal")
orthopy.c1.gegenbauer.Eval(x, "normal", lmbda)
orthopy.c1.jacobi.Eval(x, "normal", alpha, beta)

The plots above are generated with

import orthopy

orthopy.c1.jacobi.show(5, "normal", 0.0, 0.0)
# plot, savefig also exist

Recurrence coefficients can be explicitly retrieved by

import orthopy

rc = orthopy.c1.jacobi.RecurrenceCoefficients(
    "monic",  # or "classical", "normal"
    alpha=0, beta=0, symbolic=True
)
print(rc.p0)
for k in range(5):
    print(rc[k])
1
(1, 0, None)
(1, 0, 1/3)
(1, 0, 4/15)
(1, 0, 9/35)
(1, 0, 16/63)

1D half-space with weight function xα exp(-r)

(Generalized) Laguerre polynomials.

evaluator = orthopy.e1r.Eval(x, alpha=0, scaling="normal")

1D space with weight function exp(-r2)

Hermite polynomials come in two standardizations:

  • "physicists" (against the weight function exp(-x ** 2)
  • "probabilists" (against the weight function 1 / sqrt(2 * pi) * exp(-x ** 2 / 2)
evaluator = orthopy.e1r2.Eval(
    x,
    "probabilists",  # or "physicists"
    "normal"
)

Associated Legendre "polynomials"

Not all of those are polynomials, so they should really be called associated Legendre functions. The kth iteration contains 2k+1 functions, indexed from -k to k. (See the color grouping in the above plot.)

evaluator = orthopy.c1.associated_legendre.Eval(
    x, phi=None, standardization="natural", with_condon_shortley_phase=True
)

Triangle (T2)

orthopy's triangle orthogonal polynomials are evaluated in terms of barycentric coordinates, so the X.shape[0] has to be 3.

import orthopy

bary = [0.1, 0.7, 0.2]
evaluator = orthopy.t2.Eval(bary, "normal")

Disk (S2)

Xu Zernike Zernike 2

orthopy contains several families of orthogonal polynomials on the unit disk: After Xu, Zernike, and a simplified version of Zernike polynomials.

import orthopy

x = [0.1, -0.3]

evaluator = orthopy.s2.xu.Eval(x, "normal")
# evaluator = orthopy.s2.zernike.Eval(x, "normal")
# evaluator = orthopy.s2.zernike2.Eval(x, "normal")

Sphere (U3)

Complex-valued spherical harmonics, (black=zero, green=real positive, pink=real negative, blue=imaginary positive, yellow=imaginary negative). The functions in the middle are real-valued. The complex angle takes n turns on the nth level.

evaluator = orthopy.u3.EvalCartesian(
    x,
    scaling="quantum mechanic"  # or "acoustic", "geodetic", "schmidt"
)

evaluator = orthopy.u3.EvalSpherical(
    theta_phi,  # polar, azimuthal angles
    scaling="quantum mechanic"  # or "acoustic", "geodetic", "schmidt"
)

n-Cube (Cn)

C1 (Legendre) C2 C3

Jacobi product polynomials. All polynomials are normalized on the n-dimensional cube. The dimensionality is determined by X.shape[0].

evaluator = orthopy.cn.Eval(X, alpha=0, beta=0)
values, degrees = next(evaluator)

nD space with weight function exp(-r2) (Enr2)

E1r2 E2r2 E3r2

Hermite product polynomials. All polynomials are normalized over the measure. The dimensionality is determined by X.shape[0].

evaluator = orthopy.enr2.Eval(
    x,
    standardization="probabilists"  # or "physicists"
)
values, degrees = next(evaluator)

Other tools

  • Generating recurrence coefficients for 1D domains with Stieltjes, Golub-Welsch, Chebyshev, and modified Chebyshev.

  • The the sanity of recurrence coefficients with test 3 from Gautschi's article: computing the weighted sum of orthogonal polynomials:

    orthopy.tools.gautschi_test_3(moments, alpha, beta)
    
  • Clenshaw algorithm for computing the weighted sum of orthogonal polynomials:

    vals = orthopy.c1.clenshaw(a, alpha, beta, t)
    

Relevant publications

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

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

orthopy-0.10.9-cp314-none-any.whl (168.5 kB view details)

Uploaded CPython 3.14

orthopy-0.10.9-cp313-none-any.whl (158.0 kB view details)

Uploaded CPython 3.13

orthopy-0.10.9-cp312-none-any.whl (157.6 kB view details)

Uploaded CPython 3.12

orthopy-0.10.9-cp311-none-any.whl (177.3 kB view details)

Uploaded CPython 3.11

orthopy-0.10.9-cp310-none-any.whl (96.7 kB view details)

Uploaded CPython 3.10

File details

Details for the file orthopy-0.10.9-cp314-none-any.whl.

File metadata

  • Download URL: orthopy-0.10.9-cp314-none-any.whl
  • Upload date:
  • Size: 168.5 kB
  • Tags: CPython 3.14
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for orthopy-0.10.9-cp314-none-any.whl
Algorithm Hash digest
SHA256 bed0ca84b726f930b78a1a90bd60cb0b2d8793b2037df6fc0434b6ac6e458943
MD5 7f75bea904b453e3032db1e83443a3e5
BLAKE2b-256 f77aaa16fc8153518cbc742f1457e3e973f55deeae4e640bd68654d15ba0c42a

See more details on using hashes here.

Provenance

The following attestation bundles were made for orthopy-0.10.9-cp314-none-any.whl:

Publisher: release.yml on sigma-py/orthopy-dev

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

File details

Details for the file orthopy-0.10.9-cp313-none-any.whl.

File metadata

  • Download URL: orthopy-0.10.9-cp313-none-any.whl
  • Upload date:
  • Size: 158.0 kB
  • Tags: CPython 3.13
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for orthopy-0.10.9-cp313-none-any.whl
Algorithm Hash digest
SHA256 cc0254b59648d84f9b365e01649e4d8f841a93e818e49d74ba6fd8e86e4d105f
MD5 90391f347df6d04894504c2e3e5c7c26
BLAKE2b-256 5fcc49a064c1f312dfb6c8c4382c2466cf783b349d2c6f502c9a608b3f5037e3

See more details on using hashes here.

Provenance

The following attestation bundles were made for orthopy-0.10.9-cp313-none-any.whl:

Publisher: release.yml on sigma-py/orthopy-dev

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

File details

Details for the file orthopy-0.10.9-cp312-none-any.whl.

File metadata

  • Download URL: orthopy-0.10.9-cp312-none-any.whl
  • Upload date:
  • Size: 157.6 kB
  • Tags: CPython 3.12
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for orthopy-0.10.9-cp312-none-any.whl
Algorithm Hash digest
SHA256 b6e3fdb6543a59075df58f8d77fa39b265b48c7ef1aab8dd54c3c9235b5db6b2
MD5 6ddabfc61fc7359af248130e9f2c32bd
BLAKE2b-256 190c3440a3ec6eb96a3917ef6034d27d502825b1d8509470bdcf6b5ae67d7615

See more details on using hashes here.

Provenance

The following attestation bundles were made for orthopy-0.10.9-cp312-none-any.whl:

Publisher: release.yml on sigma-py/orthopy-dev

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

File details

Details for the file orthopy-0.10.9-cp311-none-any.whl.

File metadata

  • Download URL: orthopy-0.10.9-cp311-none-any.whl
  • Upload date:
  • Size: 177.3 kB
  • Tags: CPython 3.11
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for orthopy-0.10.9-cp311-none-any.whl
Algorithm Hash digest
SHA256 38781b5474aa82fc26a003712e032cff25026806c46afa2a3f504281d6eacf5f
MD5 13e04c604db500592edcac64d5cad8e9
BLAKE2b-256 7e6c9392ddcc585c8c83d87c26a026ab3596175889acfc4e16236b06aad95309

See more details on using hashes here.

Provenance

The following attestation bundles were made for orthopy-0.10.9-cp311-none-any.whl:

Publisher: release.yml on sigma-py/orthopy-dev

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

File details

Details for the file orthopy-0.10.9-cp310-none-any.whl.

File metadata

  • Download URL: orthopy-0.10.9-cp310-none-any.whl
  • Upload date:
  • Size: 96.7 kB
  • Tags: CPython 3.10
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for orthopy-0.10.9-cp310-none-any.whl
Algorithm Hash digest
SHA256 4f7ca792992eeb86ae8a4debef88f6cd4bb23bd8e27e0bc9df1f4099c45a37b8
MD5 4310d7a82e4c5ec82824ba5f94ebd73e
BLAKE2b-256 2f471f364c7e8d205288158f8a9efcc017fade5b49f25936a471f79edff52f4a

See more details on using hashes here.

Provenance

The following attestation bundles were made for orthopy-0.10.9-cp310-none-any.whl:

Publisher: release.yml on sigma-py/orthopy-dev

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