Skip to content

Commit 3db221b

Browse files
committed
Document checkbounds usage in generate_W and generate_jacobian
1 parent 57340c3 commit 3db221b

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/systems/codegen.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,8 @@ Generate the jacobian function for the equations of a [`System`](@ref).
211211
212212
$GENERATE_X_KWARGS
213213
- `simplify`, `sparse`: Forwarded to [`calculate_jacobian`](@ref).
214+
- `checkbounds`: Whether to check correctness of indices at runtime if `sparse`.
215+
Also forwarded to `build_function_wrapper`.
214216
215217
All other keyword arguments are forwarded to [`build_function_wrapper`](@ref).
216218
"""
@@ -326,6 +328,8 @@ Generate the `W = γ * M + J` function for the equations of a [`System`](@ref).
326328
327329
$GENERATE_X_KWARGS
328330
- `simplify`, `sparse`: Forwarded to [`calculate_jacobian`](@ref).
331+
- `checkbounds`: Whether to check correctness of indices at runtime if `sparse`.
332+
Also forwarded to `build_function_wrapper`.
329333
330334
All other keyword arguments are forwarded to [`build_function_wrapper`](@ref).
331335
"""

0 commit comments

Comments
 (0)