From 202dcc7245b97870602c096610595958f1b8e409 Mon Sep 17 00:00:00 2001 From: QuillPusher <130300172+QuillPusher@users.noreply.github.com> Date: Sun, 31 Mar 2024 09:54:30 -0700 Subject: [PATCH] Added `clad::estimate-error` based on Clad Readme Minor Change: - Added `clad::estimate-error` based on Clad Readme --- _pages/clad.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_pages/clad.md b/_pages/clad.md index 892017f3..90c8a25f 100644 --- a/_pages/clad.md +++ b/_pages/clad.md @@ -13,11 +13,12 @@ Since Clad is a Clang plugin, it must be properly attached when Clang compiler i ``` clang -cc1 -x c++ -std=c++11 -load /full/path/to/lib/clad.so -plugin clad SourceFile.cpp ``` -Clad provides four API functions: +Clad provides five API functions: - `clad::differentiate` to use forward-mode AD - `clad::gradient` to use reverse-mode AD - `clad::hessian` to compute Hessian matrix using a combination of forward-mode and reverse-mode AD - `clad::jacobian` to compute Jacobian matrix using reverse-mode AD +- `clad::estimate-error` to compute the floating-point error of the given program using reverse-mode AD. API functions are used to label an existing function for differentiation. 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: