peroxide-ad 0.3.0

Proc macro for automatic differenitation of Peroxide
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# Peroxide-ad

Automatic differentiation toolbox for [Peroxide](https://github.com/Axect/Peroxide)

## Usage

Modify your `Cargo.toml` as follows.

```toml
[dependencies]
peroxide = "0.30"
```

## Useful macros

* `#[ad_function]` macro generates `{}_grad`, `{}_hess` from `Fn(f64) -> f64` automatically.
    * `{}_grad` : gradient of function `{}`
    * `{}_hess` : hessian of function `{}`

```rust
#[macro_use]
extern crate peroxide;
use peroxide::fuga::*;

fn main() {
    f(2f64).print();        // x^3     = 8
    f_grad(2f64).print();   // 3 * x^2 = 12
    f_hess(2f64).print();   // 6 * x   = 12
}

#[ad_function]              // generates f_grad, f_hess
fn f(x: f64) -> f64 {
    x.powi(3)               // x^3
}
```