Skip to content

Commit 62e34ec

Browse files
committed
Update docs
1 parent a391b49 commit 62e34ec

File tree

2 files changed

+17
-7
lines changed

2 files changed

+17
-7
lines changed

docs/src/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,16 @@ But this is note the fastest way possible. In order to achieve the best performa
3131
intermediate storage. For this we have [`GradientConfig`](@ref) and [`JacobianConfig`](@ref).
3232
For single polynomial the API is as follows
3333
```julia
34-
cfg = GradientConfig(f) # this can be reused!
34+
cfg = config(f, x) # this can be reused!
3535
f(x) == evaluate(f, x, cfg)
3636
# We can also compute the gradient of f at x
3737
map(g -> g(x), ∇f) == gradient(f, x, cfg)
3838
```
3939

4040
We also have support for systems of polynomials:
4141
```julia
42-
cfg = JacobianConfig([f, f]) # this can be reused!
42+
F = System([f, g])
43+
cfg = config(F, x) # this can be reused!
4344
[f(x), f(x)] == evaluate([f, f] x, cfg)
4445
# We can also compute the jacobian of [f, f] at x
4546
jacobian(f, x, cfg)
@@ -56,6 +57,6 @@ Make sure to also check out [`GradientDiffResult`](@ref) and [`JacobianDiffResul
5657
## Safety notes
5758

5859
!!! warning
59-
For the evaluation multivariate variant of [Horner's method](https://en.wikipedia.org/wiki/Horner%27s_method)
60-
is used. Due to that for polynomials with terms of degree over 43 we cannot guarantee
60+
The current implementation is not numerically stable in the sense that
61+
for polynomials with terms of degree over 43 we cannot guarantee
6162
an error of less than 1 [ULP](https://en.wikipedia.org/wiki/Unit_in_the_last_place).

docs/src/performance.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
In order to achieve a fast evaluation we need to precompute some things and also preallocate
2-
intermediate storage. For this we have `GradientConfig` and `JacobianConfig`:
2+
intermediate storage. For this we have
33
```@docs
4-
GradientConfig
5-
JacobianConfig
4+
config
65
```
76

87
## Evaluation
@@ -19,6 +18,16 @@ jacobian
1918
jacobian!
2019
```
2120

21+
## Systems
22+
```@docs
23+
System
24+
```
25+
Systems have the additional functions
26+
```@docs
27+
evaluate_and_jacobian!
28+
evaluate_and_jacobian
29+
```
30+
2231

2332
## DiffResults
2433
```@docs

0 commit comments

Comments
 (0)