Skip to content

Commit ebde624

Browse files
docs: add codegen page to API docs
1 parent 9ff28e4 commit ebde624

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

docs/src/API/codegen.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Code generation utilities
2+
3+
These are lower-level functions that ModelingToolkit leverages to generate code for
4+
building numerical problems.
5+
6+
```@docs
7+
ModelingToolkit.generate_rhs
8+
ModelingToolkit.generate_diffusion_function
9+
ModelingToolkit.generate_jacobian
10+
ModelingToolkit.generate_tgrad
11+
ModelingToolkit.generate_hessian
12+
ModelingToolkit.generate_W
13+
ModelingToolkit.generate_dae_jacobian
14+
ModelingToolkit.generate_history
15+
ModelingToolkit.generate_boundary_conditions
16+
ModelingToolkit.generate_cost
17+
ModelingToolkit.generate_cost_gradient
18+
ModelingToolkit.generate_cost_hessian
19+
ModelingToolkit.generate_cons
20+
ModelingToolkit.generate_constraint_jacobian
21+
ModelingToolkit.generate_constraint_hessian
22+
ModelingToolkit.generate_control_jacobian
23+
ModelingToolkit.build_explicit_observed_function
24+
```
25+
26+
For functions such as jacobian calculation which require symbolic computation, there
27+
are `calculate_*` equivalents to obtain the symbolic result without building a function.
28+
29+
```@docs
30+
ModelingToolkit.calculate_tgrad
31+
ModelingToolkit.calculate_jacobian
32+
ModelingToolkit.jacobian_sparsity
33+
ModelingToolkit.jacobian_dae_sparsity
34+
ModelingToolkit.calculate_hessian
35+
ModelingToolkit.hessian_sparsity
36+
ModelingToolkit.calculate_massmatrix
37+
ModelingToolkit.W_sparsity
38+
ModelingToolkit.calculate_W_prototype
39+
ModelingToolkit.calculate_cost_gradient
40+
ModelingToolkit.calculate_cost_hessian
41+
ModelingToolkit.cost_hessian_sparsity
42+
ModelingToolkit.calculate_constraint_jacobian
43+
ModelingToolkit.calculate_constraint_hessian
44+
ModelingToolkit.calculate_control_jacobian
45+
```

0 commit comments

Comments
 (0)