num-dual
Generalized, recursive, scalar and vector (hyper) dual numbers for the automatic and exact calculation of (partial) derivatives. Including bindings for python.
Installation and Usage
Python
The python package can be installed directly from PyPI:
pip install num_dual
Rust
Add this to your Cargo.toml:
[dependencies]
num-dual = "0.12"
Example
Python
Compute the first and second derivative of a scalar-valued function.
from num_dual import second_derivative
import numpy as np
def f(x):
return np.exp(x) / np.sqrt(np.sin(x)**3 + np.cos(x)**3)
f, df, d2f = second_derivative(f, 1.5)
print(f'f(x) = {f}')
print(f'df/dx = {df}')
print(f'd2f/dx2 = {d2f}')
Rust
This example defines a generic function that can be called using any (hyper) dual number and automatically calculates derivatives.
use num_dual::*;
use nalgebra::SMatrix;
fn f<D: DualNum<f64>>(x: D, y: D) -> D {
x.powi(3) * y.powi(2)
}
fn main() {
let (x, y) = (5.0, 4.0);
// Calculate a simple derivative using dual numbers
let x_dual = Dual64::from(x).derivative();
let y_dual = Dual64::from(y);
println!("{}", f(x_dual, y_dual)); // 2000 + 1200ε
// or use the provided function instead
let (_, df) = first_derivative(|x| f(x, y.into()), x);
println!("{df}"); // 1200
// Calculate a gradient
let (value, grad) = gradient(|v| f(v[0], v[1]), &SMatrix::from([x, y]));
println!("{value} {grad}"); // 2000 [1200, 1000]
// Calculate a Hessian
let (_, _, hess) = hessian(|v| f(v[0], v[1]), &SMatrix::from([x, y]));
println!("{hess}"); // [[480, 600], [600, 250]]
// for x=cos(t) and y=sin(t) calculate the third derivative w.r.t. t
let (_, _, _, d3f) = third_derivative(|t| f(t.cos(), t.sin()), 1.0);
println!("{d3f}"); // 7.358639755305733
}
Documentation
- You can find the documentation of the rust crate here.
- The documentation of the python package can be found here.
Python
For the following commands to work you have to have the package installed (see: installing from source).
cd docs
make html
Open _build/html/index.html in your browser.
Further reading
If you want to learn more about the topic of dual numbers and automatic differentiation, we have listed some useful resources for you here:
- Initial paper about hyper-dual numbers: Fike, J. and Alonso, J., 2011
- Website about all topics regarding automatic differentiation: autodiff.org
- Our paper about dual numbers in equation of state modeling: Rehner, P. and Bauer, G., 2021
Cite us
If you find num-dual useful for your own scientific studies, consider citing our publication accompanying this library.
@ARTICLE{rehner2021,
AUTHOR={Rehner, Philipp and Bauer, Gernot},
TITLE={Application of Generalized (Hyper-) Dual Numbers in Equation of State Modeling},
JOURNAL={Frontiers in Chemical Engineering},
VOLUME={3},
YEAR={2021},
URL={https://www.frontiersin.org/article/10.3389/fceng.2021.758090},
DOI={10.3389/fceng.2021.758090},
ISSN={2673-2718}
}
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file num_dual-0.12.1-cp39-abi3-win_amd64.whl.
File metadata
- Download URL: num_dual-0.12.1-cp39-abi3-win_amd64.whl
- Upload date:
- Size: 3.9 MB
- Tags: CPython 3.9+, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.11.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ae963acbc95304aec4fa853eb59173f6c4c82b4b85ed31b31c2e3b7d0101e6cd
|
|
| MD5 |
b7b81178beadaf048dd7710a9c4b2390
|
|
| BLAKE2b-256 |
4db0503a1476475613007c52475be3c2a3b2b25d3e042549d8f4df254a5a5e96
|
File details
Details for the file num_dual-0.12.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.
File metadata
- Download URL: num_dual-0.12.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
- Upload date:
- Size: 3.7 MB
- Tags: CPython 3.9+, manylinux: glibc 2.17+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.11.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
319a568a6945ac98bccba9703bac3f2ae9536d2cecdfd2551130b824b81ab221
|
|
| MD5 |
c0e529e0f3e4cdf1c9757d42b432537a
|
|
| BLAKE2b-256 |
3233ef50ca264a97b8a5a462f38b43b5383d837e249e7ea2503a07b32d28f2c9
|
File details
Details for the file num_dual-0.12.1-cp39-abi3-macosx_11_0_arm64.whl.
File metadata
- Download URL: num_dual-0.12.1-cp39-abi3-macosx_11_0_arm64.whl
- Upload date:
- Size: 3.1 MB
- Tags: CPython 3.9+, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.11.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
59983ef8702fc0221af107e360159a5ced4516cad67de347d9e732b375c4412f
|
|
| MD5 |
53ad5eefeac1162136c631b6fe73b3f4
|
|
| BLAKE2b-256 |
4ba9f81b8168ec3dc31fd496e8c472ba819fa1bc32490d710641fe64f4a8c2ec
|
File details
Details for the file num_dual-0.12.1-cp39-abi3-macosx_10_12_x86_64.whl.
File metadata
- Download URL: num_dual-0.12.1-cp39-abi3-macosx_10_12_x86_64.whl
- Upload date:
- Size: 3.8 MB
- Tags: CPython 3.9+, macOS 10.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.11.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a75dc4511237137a37fe3ced225097ef0384714fbcc6d3924d3a8d9213444ff7
|
|
| MD5 |
96e340027d8005b547325bdcbaa64df2
|
|
| BLAKE2b-256 |
e7e5fa9dccb3ab68a467f5252986d4b13d9631ca1ab08ec789a9828120049e9f
|
