Skip to content

Commit 202dcc7

Browse files
committed
Added clad::estimate-error based on Clad Readme
Minor Change: - Added `clad::estimate-error` based on Clad Readme
1 parent e04970e commit 202dcc7

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

_pages/clad.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@ Since Clad is a Clang plugin, it must be properly attached when Clang compiler i
1313
```
1414
clang -cc1 -x c++ -std=c++11 -load /full/path/to/lib/clad.so -plugin clad SourceFile.cpp
1515
```
16-
Clad provides four API functions:
16+
Clad provides five API functions:
1717
- `clad::differentiate` to use forward-mode AD
1818
- `clad::gradient` to use reverse-mode AD
1919
- `clad::hessian` to compute Hessian matrix using a combination of forward-mode and reverse-mode AD
2020
- `clad::jacobian` to compute Jacobian matrix using reverse-mode AD
21+
- `clad::estimate-error` to compute the floating-point error of the given program using reverse-mode AD.
2122

2223
API functions are used to label an existing function for differentiation.
2324
Both functions return a functor object containing the generated derivative which can be called via `.execute` method, which forwards provided arguments to the generated derivative function. Example:

0 commit comments

Comments
 (0)