Mercurial > hg > octave-lyh
comparison scripts/general/dblquad.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | eb63fbe60fab |
children | 95c3e38098bf |
comparison
equal
deleted
inserted
replaced
9044:656ad518f385 | 9051:1bf0ce0930be |
---|---|
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} {} dblquad (@var{f}, @var{xa}, @var{xb}, @var{ya}, @var{yb}, @var{tol}, @var{quadf}, @dots{}) | 20 ## @deftypefn {Function File} {} dblquad (@var{f}, @var{xa}, @var{xb}, @var{ya}, @var{yb}, @var{tol}, @var{quadf}, @dots{}) |
21 ## Numerically evaluate a double integral. The function over with to | 21 ## Numerically evaluate a double integral. The function over with to |
22 ## integrate is defined by @code{@var{f}}, and the interval for the | 22 ## integrate is defined by @code{@var{f}}, and the interval for the |
23 ## integration is defined by @code{[@var{xa}, @var{xb}, @var{ya}, | 23 ## integration is defined by @code{[@var{xa}, @var{xb}, @var{ya}, |
24 ## @var{yb}]}. The function @var{f} must accept a vector @var{x} and a | 24 ## @var{yb}]}. The function @var{f} must accept a vector @var{x} and a |
25 ## scalar @var{y}, and return a vector of the same length as @var{x}. | 25 ## scalar @var{y}, and return a vector of the same length as @var{x}. |
26 ## | 26 ## |
27 ## If defined, @var{tol} defines the absolute tolerance to which to | 27 ## If defined, @var{tol} defines the absolute tolerance to which to |
28 ## which to integrate each sub-integral. | 28 ## which to integrate each sub-integral. |
29 ## | 29 ## |
30 ## Additional arguments, are passed directly to @var{f}. To use the default | 30 ## Additional arguments, are passed directly to @var{f}. To use the default |
31 ## value for @var{tol} one may pass an empty matrix. | 31 ## value for @var{tol} one may pass an empty matrix. |
32 ## @seealso{triplequad, quad, quadv, quadl, quadgk, trapz} | 32 ## @seealso{triplequad, quad, quadv, quadl, quadgk, trapz} |
33 ## @end deftypefn | 33 ## @end deftypefn |
34 | 34 |
35 function q = dblquad(f, xa, xb, ya, yb, tol, quadf, varargin) | 35 function q = dblquad(f, xa, xb, ya, yb, tol, quadf, varargin) |