Skip to content

document reset arg to nimDerivs #1555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paciorek merged 3 commits into from
Aug 14, 2025
Merged

document reset arg to nimDerivs #1555

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
715a1a1
Document reset arg to nimDerivs.
paciorek Jun 20, 2025
bc1fefe
Add more text to roxygen for reset.
paciorek Jun 20, 2025
d1f8a97
Merge branch 'devel' into doc-derivs-reset
paciorek Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/nimble/R/nimbleFunction_Rderivs.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ nimDerivs_dummy <- nimbleFunction(
#' is included, one should also include the arguments \code{updateNodes} and
#' \code{constantNodes} using the output obtained from running
#' \code{makeModelDerivsInfo}.
#' @param reset a logical specifying whether to reset the AD tape.
#' See Section 16.5.5 of user manual for details.
#' Not used/relevant for uncompiled execution. Defaults to \code{FALSE}.
#' @param ... additional arguments intended for internal use only.
#'
#'@details Derivatives for uncompiled nimbleFunctions are calculated using the
Expand Down Expand Up @@ -63,6 +66,7 @@ nimDerivs <- function(call = NA,
wrt = NULL,
order = nimC(0,1,2),
model = NA,
reset = FALSE,
...){ ## ... absorbs compile-only params
fxnEnv <- parent.frame()
fxnCall <- match.call()
Expand Down
Loading