Skip to main content

2D dual numbers for python, with support for complex scalars

Project description

dual_numbers

2D Dual numbers for python, can trivially use complex numbers as scalars.

What are dual numbers?

Python uses j for the imaginary unit, here we use d for the dual unit, in order to differentiate it from scientific notation.

d^2 = 0

exp(a*d)=1+a*d

Since complex numbers can make rotations be done as multiplication, dual numbers can make posible translation as multiplication. As the dual part squares to 0, they can also be used for automatic differentiation:

f(x+d) = f(x) + f'(x)d

Note: in complex numbers, f'(x) = Img(f(x+i*dx))/dx. See this for an explanation.

More info in wikipedia.

How to use:

To declare a dual number:

a=dual(1,2)
a
>>> (1+2d)
b=3 .d + 1
b
>>> (1+3d)
b=3.0.d+1
b
>>> (1+3d)
c=dual(1) # same as complex(1)
c
>>> (1+0d)
c.real
>>> 1
c.dl
>>> 0
dual(1+1j,2).real
>>> (1+1j) # This is not a bug, but a feature.

To add them, make sure the dual number comes first, since we cannot modify python's integer and float methods for adding:

a=1 .d + 2
b=1
a+b
>>> (3+1d) # CORRECT!!
b+a
>>> Error: "+" not defined for int with dual

So make sure to declare all your numbers as dual if you dont want to deal with these.

Basic arithmetic operations +,-,*,/,exp,log,abs,arg work as intended if both operands are dual. See docs or code for the cases when numbers are promoted.

  • a+b,a-b,a*b, a/b, a**b work as expected.
  • a.exp() and a.log() return their respective values.
  • a.abs() returns the real part, and a.arg() returns a.dl/a.real See docs or code for extending to other algebras ex.: exp(self,f=mathmodule).

In case there is a math domain error, python handles them as usual, ex.:

a=1 .d # pure dual numbers do not have inverse
a**-1
>>> ValueError: math domain error

Requirements

Install these with pip install as usual:

  • custom_literals (for easy dual declaration with .d)
  • forbiddenfruit (dependency for the former)

TODO

  • Test the library
  • Add wheel
  • Make docs
  • Put more use cases
  • Give more links

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

dual_numbers-0.0.10.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

dual_numbers-0.0.10-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file dual_numbers-0.0.10.tar.gz.

File metadata

  • Download URL: dual_numbers-0.0.10.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for dual_numbers-0.0.10.tar.gz
Algorithm Hash digest
SHA256 ae27dff15907164f271876be07f43eb807ddbbf88a8bcf052af38338ac8705df
MD5 bcaeb6f48d8e80ee495e3423c6402fda
BLAKE2b-256 cd2d80b42ad8ac4da1b950ffa57464463999e90eede8bcd285647cb22a621f4b

See more details on using hashes here.

File details

Details for the file dual_numbers-0.0.10-py3-none-any.whl.

File metadata

File hashes

Hashes for dual_numbers-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 b8dfb53c99588550540ecc1ed9c50bcaaa0d9f6728a0d338148167219b97ddee
MD5 deee9a0bc94337537e217b8fd8809bb1
BLAKE2b-256 c5ff6c891bba25eb61caacd2b4580ee7794a1355c5b0498412c157841457c247

See more details on using hashes here.

Supported by

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