Mercurial > hg > octave-lyh

comparison scripts/general/gradient.m @ 10793:be55736a0783

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammarcheck the documentation from m-files.
author Rik <octave@nomad.inbox5.com>
date Sun, 18 Jul 2010 20:35:16 -0700
parents d1978e7364ad
children a8ac114ec9ab
comparison
equal deleted inserted replaced
10792:91342260063e 10793:be55736a0783
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{dx} =} gradient (@var{m}) 20 ## @deftypefn {Function File} {@var{dx} =} gradient (@var{m})
21 ## @deftypefnx {Function File} {[@var{dx}, @var{dy}, @var{dz}, @dots{}] =} gradient (@var{m}) 21 ## @deftypefnx {Function File} {[@var{dx}, @var{dy}, @var{dz}, @dots{}] =} gradient (@var{m})
22 ## @deftypefnx {Function File} {[@dots{}] =} gradient (@var{m}, @var{s}) 22 ## @deftypefnx {Function File} {[@dots{}] =} gradient (@var{m}, @var{s})
23 ## @deftypefnx {Function File} {[@dots{}] =} gradient (@var{m}, @var{x}, @var{y}, @var{z}, @dots{}) 23 ## @deftypefnx {Function File} {[@dots{}] =} gradient (@var{m}, @var{x}, @var{y}, @var{z}, @dots{})
24 ## @deftypefnx {Function File} {[@dots{}] =} gradient (@var{f}, @var{x0}) 24 ## @deftypefnx {Function File} {[@dots{}] =} gradient (@var{f}, @var{x0})
25 ## @deftypefnx {Function File} {[@dots{}] =} gradient (@var{f}, @var{x0}, @var{s}) 25 ## @deftypefnx {Function File} {[@dots{}] =} gradient (@var{f}, @var{x0}, @var{s})
36 ## 36 ##
37 ## A constant spacing between two points can be provided by the 37 ## A constant spacing between two points can be provided by the
38 ## @var{s} parameter. If @var{s} is a scalar, it is assumed to be the spacing 38 ## @var{s} parameter. If @var{s} is a scalar, it is assumed to be the spacing
39 ## for all dimensions. 39 ## for all dimensions.
40 ## Otherwise, separate values of the spacing can be supplied by 40 ## Otherwise, separate values of the spacing can be supplied by
41 ## the @var{x}, @dots{} arguments. Scalar values specify an equidistant spacing. 41 ## the @var{x}, @dots{} arguments. Scalar values specify an equidistant
42 ## Vector values for the @var{x}, @dots{} arguments specify the coordinate for that 42 ## spacing.
43 ## Vector values for the @var{x}, @dots{} arguments specify the coordinate for
44 ## that
43 ## dimension. The length must match their respective dimension of @var{m}. 45 ## dimension. The length must match their respective dimension of @var{m}.
44 ## 46 ##
45 ## At boundary points a linear extrapolation is applied. Interior points 47 ## At boundary points a linear extrapolation is applied. Interior points
46 ## are calculated with the first approximation of the numerical gradient 48 ## are calculated with the first approximation of the numerical gradient
47 ## 49 ##