Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

  • ecd6f1f
  • /
  • man
  • /
  • grad.Rd
Raw File Download

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
content badge
swh:1:cnt:73b9c74387f30700bcc73b45eb3138b0b4bca84c
directory badge
swh:1:dir:9ec105da683b91eb08060a5ff10f5ea6a91017f9

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
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, ..., method=c("fast","richardson"))
}
%- 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
}
  \item{method}{
    string argument to determine whether to use the fast two sided
    calculation or use a Richardson extrapolation.
}
}
\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

back to top

Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API