Skip to main content

A python & numpy data type for floating point numbers with quantified uncertainity.

Project description

Code CI Docs CI Test Coverage Latest PyPI version Apache License

This package provides a python and numpy data type (uncertain) which implements a floating point value with quantified uncertainity, allowing for forward uncertainity propagation of uncorrelated values.

PyPI

pip install numcertain

Source code

https://github.com/garryod/numcertain

Documentation

https://garryod.github.io/numcertain

Releases

https://github.com/garryod/numcertain/releases

A brief example of library usage is shown below:

from numpy import array
from numcertain.uncertain import uncertain

scalar = uncertain(42.0, 0.84)
array_a = array([uncertain(1.0, 0.1), uncertain(2.0, 0.2)])
array_b = array([3, 4]).astype(uncertain)

print(f"scalar: {scalar}")
print(f"array_a: {array_a}")
print(f"array_b: {array_b}")

print(f"array_a + array_b: {array_b + array_a}")
print(f"array_b - array_a: {array_a - array_b}")
print(f"array_a * array_b: {array_b * array_a}")
print(f"array_a / array_b: {array_b / array_a}")
scalar: 42.0±0.84
array_a: [uncertain(1.0, 0.1) uncertain(2.0, 0.2)]
array_b: [uncertain(3.0, 0.0) uncertain(4.0, 0.0)]
array_a + array_b: [uncertain(4.0, 0.1) uncertain(6.0, 0.2)]
array_b - array_a: [uncertain(-2.0, 3.1622776601683795) uncertain(-2.0, 4.47213595499958)]
array_a * array_b: [uncertain(3.0, 0.30000000000000004) uncertain(8.0, 0.8)]
array_a / array_b: [uncertain(3.0, 0.30000000000000004) uncertain(2.0, 0.2)]

See https://garryod.github.io/numcertain for more detailed documentation.

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

numcertain-0.1.0.tar.gz (15.4 kB view hashes)

Uploaded Source

Built Distributions

numcertain-0.1.0-cp310-cp310-win_amd64.whl (19.1 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

numcertain-0.1.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (49.9 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

numcertain-0.1.0-cp310-cp310-macosx_10_9_x86_64.whl (17.2 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

numcertain-0.1.0-cp39-cp39-win_amd64.whl (19.1 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

numcertain-0.1.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (49.5 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

numcertain-0.1.0-cp39-cp39-macosx_10_9_x86_64.whl (17.2 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

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