Skip to content

Commit

Permalink
Minor doc changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
jlmelville committed Sep 2, 2018
1 parent 797bc5c commit b2e5f65
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
10 changes: 6 additions & 4 deletions R/mize.R
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,8 @@
#' \itemize{
#' \item{\code{"rasmussen"}} As used by Rasmussen in \code{minimize.m}:
#' \deqn{\frac{1}{1+\left|g\right|^2}}{1 / 1 + (|g|^2)}
#' \item{\code{"scipy"}} As used in scipy's \code{optimize.py}
#' \item{\code{"scipy"}} As used in \code{optimize.py} in the python
#' library Scipy.
#' \deqn{\frac{1}{\left|g\right|}}{1 / |g|}
#' \item{\code{"schmidt"}} As used by Schmidt in \code{minFunc.m}
#' (the reciprocal of the l1 norm of g)
Expand Down Expand Up @@ -305,7 +306,8 @@
#' the gradient. Indicated by \code{terminate$what} being \code{"grad_tol"}.
#' Note that the gradient norm is not a very reliable stopping criterion
#' (see Nocedal and co-workers 2002), but is quite commonly used, so this
#' might be useful for comparison with results from other optimizers.
#' might be useful for comparison with results from other optimization
#' software.
#' \item{\code{ginf_tol}} Absolute tolerance of the infinity norm (maximum
#' absolute component) of the gradient. Indicated by \code{terminate$what}
#' being \code{"ginf_tol"}.
Expand Down Expand Up @@ -470,7 +472,7 @@
#' @param mom_linear_weight If \code{TRUE}, the gradient contribution to the
#' update is weighted using momentum contribution.
#' @param restart Momentum restart type. Can be one of "fn", "gr" or "speed".
#' See Details'. Ignored if no momentum scheme is being used.
#' See 'Details'. Ignored if no momentum scheme is being used.
#' @param restart_wait Number of iterations to wait between restarts. Ignored
#' if \code{restart} is \code{NULL}.
#' @param max_iter Maximum number of iterations to optimize for. Defaults to
Expand Down Expand Up @@ -604,7 +606,7 @@
#' (pp. 1139-1147).
#'
#' Xie, D., & Schlick, T. (1999).
#' Remark on Algorithm 702The updated truncated Newton minimization package.
#' Remark on Algorithm 702 - The updated truncated Newton minimization package.
#' \emph{ACM Transactions on Mathematical Software (TOMS)}, \emph{25}(1), 108-122.
#'
#' Xie, D., & Schlick, T. (2002).
Expand Down
10 changes: 6 additions & 4 deletions man/mize.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit b2e5f65

Please sign in to comment.