Mercurial > octave
changeset 30983:7711b5e38ebc
integral.m: small coding convention tweaks to cset e8ced722b19e.
* integral.m: Document inputs first and then outputs. Use only single '#' for
comments which are not stand-alone on a line. Simplify "error_flag"
calculation to a single line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Fri, 06 May 2022 07:27:38 -0700 |
| parents | 95cb7ebba1a9 |
| children | 760d38460452 |
| files | scripts/general/integral.m |
| diffstat | 1 files changed, 12 insertions(+), 15 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/general/integral.m Thu May 05 20:50:18 2022 +0200 +++ b/scripts/general/integral.m Fri May 06 07:27:38 2022 -0700 @@ -48,11 +48,6 @@ ## path integral. Alternatively, a complex domain path can be specified using ## the @qcode{"Waypoints"} option (see below). ## -## The optional output @var{err} contains an integration quality measure from -## the called integrator. This is an absolute error estimate from @code{quadcc} -## and @code{quadgk}, and the number of function evaluations for array-valued -## functions passed to @code{quadv}. -## ## Additional optional parameters can be specified using ## @qcode{"@var{property}", @var{value}} pairs. Valid properties are: ## @@ -79,6 +74,11 @@ ## relative tolerance is 1e-6 (1e-4 for single). ## @end table ## +## The optional output @var{err} contains an integration quality measure from +## the called integrator. This is an absolute error estimate from @code{quadcc} +## and @code{quadgk}, and the number of function evaluations for array-valued +## functions passed to @code{quadv}. +## ## Adaptive quadrature is used to minimize the estimate of error until the ## following is satisfied: ## @tex @@ -122,10 +122,7 @@ print_usage (); endif - error_flag = false; - if (nargout == 2) - error_flag = true; - endif + error_flag = (nargout == 2); ## quadcc can't handle complex limits or integrands, but quadgk & quadv can. ## Check for simple cases of complex limits and integrand. @@ -352,12 +349,12 @@ ##test 2nd output %!test <*62412> -%! [~, err] = integral (@(x) ones (size (x)), 0, 1); ##quadcc -%! assert (err, 0, 5*eps); ## err ~3e-16 -%! [~, err] = integral (@(x) ones (size (x)), 0, 1, "waypoints", 1); ##quadgk -%! assert (err, 0, 1000*eps); ## err ~7e-14 -%! [~, err] = integral (@(x) ones (size (x)), 0, 1, "arrayvalued", true); ##quadv -%! assert (err, 0, 20); ## nfev ~13 +%! [~, err] = integral (@(x) ones (size (x)), 0, 1); # quadcc +%! assert (err, 0, 5*eps); # err ~3e-16 +%! [~, err] = integral (@(x) ones (size (x)), 0, 1, "waypoints", 1); # quadgk +%! assert (err, 0, 1000*eps); # err ~7e-14 +%! [~, err] = integral (@(x) ones (size (x)), 0, 1, "arrayvalued", true); # quadv +%! assert (err, 0, 20); # nfev ~13 ## Test input validation %!error integral (@sin)