Revision 45536c5580212aeb43a1cdf1a690e92cc843203c authored by Mark Clements on 07 January 2023, 02:40:02 UTC, committed by cran-robot on 07 January 2023, 02:40:02 UTC
1 parent b58cc9c
grad.Rd
\name{grad}
\Rdversion{1.1}
\alias{grad}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{gradient function (internal function)
%% ~~function to do ... ~~
}
\description{
Numerical gradient for a function at a given value (internal).
}
\usage{
grad(func, x, ...)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
\item{func}{
Function taking a vector argument x (returns a vector of length>=1)
}
\item{x}{
vector of arguments for where the gradient is wanted.
}
\item{\dots}{
other arguments to the function
}
}
\details{
(func(x+delta,...)-func(x-delta,...))/(2 delta) where delta is the third root
of the machine precision times pmax(1,abs(x)).
}
\value{
A vector if func(x) has length 1, otherwise a matrix with rows for x
and columns for func(x).
}
%% \references{
%% %% ~put references to the literature/web site here ~
%% }
\author{
Mark Clements.
}
%% \note{
%% %% ~~further notes~~
%% }
%% ~Make other sections like Warning with \section{Warning }{....} ~
\seealso{
numDelta()
}
%% \examples{
%% }
% Add one or more standard keywords, see file 'KEYWORDS' in the
% R documentation directory.
%% \keyword{ ~kwd1 }
%% \keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
Computing file changes ...