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+i)=f(x)+f'(x)i

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)
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 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, etc
  • a.exp() and a.log() return their respective values. See docs or code for extending to other algebras ex.: exp(self,f=mathmodule).

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
  • Make literals optional
  • 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.4.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: dual_numbers-0.0.4.tar.gz
  • Upload date:
  • Size: 3.7 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.4.tar.gz
Algorithm Hash digest
SHA256 3e45b8aa194e021b29f6c3ea8352775abfab6c50e524209c0ee99d263fd54eaa
MD5 612f3bca8d1ec8fb5b57ebaa38f4a470
BLAKE2b-256 f9bf34f07b86ac72a1053086e5bec8499c2824826ee5bd3c52b2c313d25f39be

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dual_numbers-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 acfe736b5b6f921fa422d5d5e229114003741aac0426c545f02dd9e9264803ea
MD5 eff9154a6706849551319142c7a28380
BLAKE2b-256 f72743466966f77a6575bf760586eaf07e2315923733a0b8d5b9d147ea2f2ee3

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