comparison scripts/general/quadgk.m @ 31375:96f751f8392c

doc: grammar check documentation ahead of 8.1 release. * numbers.txi, vectorize.txi, besselj.cc, data.cc, oct-hist.cc, pr-output.cc, ov-bool-mat.cc, LSODE-opts.in, quadgk.m, warning_ids.m, clearAllMemoizedCaches.m, memoize.m, nthargout.m, pkg.m, print.m, movslice.m: Grammar check documentation ahead of 8.1 release.
author Rik <rik@octave.org>
date Sun, 30 Oct 2022 21:58:36 -0700
parents 451fb63a10a0
children 597f3ee61a48
comparison
equal deleted inserted replaced
31369:c0f1a817c058 31375:96f751f8392c
50 ## @noindent 50 ## @noindent
51 ## Note that the formulation of the integrand uses the element-by-element 51 ## Note that the formulation of the integrand uses the element-by-element
52 ## operator @code{./} and all user functions to @code{quadgk} should do the 52 ## operator @code{./} and all user functions to @code{quadgk} should do the
53 ## same. 53 ## same.
54 ## 54 ##
55 ## The optional argument @var{abstol} defines the absolute tolerance used to stop 55 ## The optional argument @var{abstol} defines the absolute tolerance used to
56 ## the integration procedure. The default value is 1e-10 (1e-5 for single). 56 ## stop the integration procedure. The default value is 1e-10 (1e-5 for
57 ## single).
57 ## 58 ##
58 ## The algorithm used by @code{quadgk} involves subdividing the integration 59 ## The algorithm used by @code{quadgk} involves subdividing the integration
59 ## interval and evaluating each subinterval. If @var{trace} is true then after 60 ## interval and evaluating each subinterval. If @var{trace} is true then after
60 ## computing each of these partial integrals display: (1) the number of 61 ## computing each of these partial integrals display: (1) the number of
61 ## subintervals at this step, (2) the current estimate of the error @var{err}, 62 ## subintervals at this step, (2) the current estimate of the error @var{err},
81 ## 82 ##
82 ## @example 83 ## @example
83 ## quadgk (@@(x) x .^ (1:5), 0, 2, "ArrayValued", 1) 84 ## quadgk (@@(x) x .^ (1:5), 0, 2, "ArrayValued", 1)
84 ## @end example 85 ## @end example
85 ## 86 ##
87 ## @noindent
86 ## will integrate @code{[x.^1, x.^2, x.^3, x.^4, x.^5]} in one function call 88 ## will integrate @code{[x.^1, x.^2, x.^3, x.^4, x.^5]} in one function call
87 ## rather than having to repeatedly define a single anonymous function and 89 ## rather than having to repeatedly define a single anonymous function and
88 ## use a normal invocation of @code{quadgk}. 90 ## use a normal invocation of @code{quadgk}.
89 ## 91 ##
90 ## @item WayPoints 92 ## @item WayPoints