From ba237a624d52310fc75d171f8b0adc4999b5b97e Mon Sep 17 00:00:00 2001 From: Matthew Fidler Date: Sun, 24 Nov 2024 21:44:14 -0600 Subject: [PATCH] ::doc() --- NAMESPACE | 12 ++++++------ R/elu.R | 2 ++ man/ELU.Rd | 3 +++ man/dPReLU.Rd | 1 + man/reexports.Rd | 1 - man/rxSolve.Rd | 12 ++++++------ 6 files changed, 18 insertions(+), 13 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index ee4e49853..bbe44c5e6 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -95,6 +95,12 @@ S3method(modelExtract,rxode2) S3method(plot,rxSolve) S3method(plot,rxSolveConfint1) S3method(plot,rxSolveConfint2) +S3method(predict,"function") +S3method(predict,rxEt) +S3method(predict,rxParams) +S3method(predict,rxSolve) +S3method(predict,rxUi) +S3method(predict,rxode2) S3method(print,boundInits) S3method(print,boundParams) S3method(print,rxC) @@ -467,12 +473,6 @@ export(model) export(modelExtract) export(odeMethodToInt) export(phi) -export(predict.function) -export(predict.rxEt) -export(predict.rxParams) -export(predict.rxSolve) -export(predict.rxUi) -export(predict.rxode2) export(probit) export(probitInv) export(probitNormInfo) diff --git a/R/elu.R b/R/elu.R index f335da1f4..02bdb5c10 100644 --- a/R/elu.R +++ b/R/elu.R @@ -3,6 +3,8 @@ #' @family Activation Functions #' @param x A numeric vector. All elements must be finite and #' non-missing. +#' @param alpha A numeric scalar. All elements must be finite and +#' non-missing. #' @return A numeric vector where the ReLU function has been applied #' to each element of `x`. #' @author Matthew Fidler diff --git a/man/ELU.Rd b/man/ELU.Rd index cefc84179..12b2ce0ab 100644 --- a/man/ELU.Rd +++ b/man/ELU.Rd @@ -9,6 +9,9 @@ ELU(x, alpha = 1) \arguments{ \item{x}{A numeric vector. All elements must be finite and non-missing.} + +\item{alpha}{A numeric scalar. All elements must be finite and +non-missing.} } \value{ A numeric vector where the ReLU function has been applied diff --git a/man/dPReLU.Rd b/man/dPReLU.Rd index 463283315..3b2f4295f 100644 --- a/man/dPReLU.Rd +++ b/man/dPReLU.Rd @@ -32,6 +32,7 @@ dPReLU(c(-1, 0, 1, 2), 2) dPReLUa(c(-1, 0, 1, 2), 2) dPReLUa1(c(-1, 0, 1, 2), 2) + # Can also be used in rxode2: r <- rxode2({ r1=dPReLU(time, 2) diff --git a/man/reexports.Rd b/man/reexports.Rd index 2857ff16d..8cba3d62e 100644 --- a/man/reexports.Rd +++ b/man/reexports.Rd @@ -38,4 +38,3 @@ below to see their documentation. \item{magrittr}{\code{\link[magrittr:pipe]{\%>\%}}} }} -\value{ Inherited from parent routine } diff --git a/man/rxSolve.Rd b/man/rxSolve.Rd index c38c34723..1d04267e5 100644 --- a/man/rxSolve.Rd +++ b/man/rxSolve.Rd @@ -209,17 +209,17 @@ rxSolve( \method{update}{rxSolve}(object, ...) -predict.rxode2(object, ...) +\method{predict}{rxode2}(object, ...) -predict.function(object, ...) +\method{predict}{`function`}(object, ...) -predict.rxUi(object, ...) +\method{predict}{rxUi}(object, ...) -predict.rxSolve(object, ...) +\method{predict}{rxSolve}(object, ...) -predict.rxEt(object, ...) +\method{predict}{rxEt}(object, ...) -predict.rxParams(object, ...) +\method{predict}{rxParams}(object, ...) \method{simulate}{rxode2}(object, nsim = 1L, seed = NULL, ...)