Mercurial > octave
diff libinterp/corefcn/quadcc.cc @ 21966:112b20240c87
move docstrings in C++ files out of C strings and into comments
* __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc,
__ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc,
bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc,
dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc,
dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.cc, fft.cc, fft2.cc,
fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc,
hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc,
lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc,
oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc,
pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc,
sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc,
sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc,
time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc,
utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc,
audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc,
convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc,
ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc,
ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc,
ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc,
ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc,
ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc,
pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy:
Docstrings are now comments instead of C strings.
* build-aux/mk-opts.pl: Emit docstrings as comments instead of C
strings.
* DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments.
* builtins.h: Include builtin-defun-decls.h unconditionally.
* defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration.
(DEFALIAS): Always expand to nothing.
* defun-dld.h: No special macro expansions for MAKE_BUILTINS.
(DEFUN_DLD): Use FORWARD_DECLARE_FUN.
(DEFUNX_DLD): Use FORWARD_DECLARE_FUNX.
* defun-int.h: No special macro expansions for MAKE_BUILTINS.
(FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros.
(DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass
"external-doc" to DEFINE_FUNX_INSTALLER_FUN.
(DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL,
DEFALIAS_INTERNAL): Delete.
* common.mk (move_if_change_rule): New macro.
(simple_move_if_change_rule): Define using move_if_change_rule.
* find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file
name extension to ".df".
* libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files.
* mkbuiltins: New argument, SRCDIR. Operate directly on source files.
* mkdefs: Delete.
* libinterp/module.mk (BUILT_SOURCES): Update list to contain only
files included in other source files.
(GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete.
(LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here.
(LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from
the list.
(libinterp_EXTRA_DIST): Remove mkdefs from the list.
(FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES.
(DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES.
(SRC_DEFUN_FILES): Rename from SRC_DEF_FILES.
(ALL_DEFUN_FILES): Rename from ALL_DEF_FILES.
(%.df: %.cc): Delete pattern rule.
(libinterp/build-env-features.cc, libinterp/builtins.cc,
libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change.
(libinterp/builtins.cc, libinterp/builtin-defun-decls.h):
Update mkbuiltins command.
($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command.
* liboctave/module.mk (BUILT_SOURCES): Don't include
liboctave-build-info.cc in the list.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 21 Jun 2016 16:07:51 -0400 |
parents | aab79a1885cc |
children | bac0d6f07a3e |
line wrap: on
line diff
--- a/libinterp/corefcn/quadcc.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/corefcn/quadcc.cc Tue Jun 21 16:07:51 2016 -0400 @@ -1478,75 +1478,75 @@ // The actual integration routine. DEFUN (quadcc, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {@var{q} =} quadcc (@var{f}, @var{a}, @var{b})\n\ -@deftypefnx {} {@var{q} =} quadcc (@var{f}, @var{a}, @var{b}, @var{tol})\n\ -@deftypefnx {} {@var{q} =} quadcc (@var{f}, @var{a}, @var{b}, @var{tol}, @var{sing})\n\ -@deftypefnx {} {[@var{q}, @var{err}, @var{nr_points}] =} quadcc (@dots{})\n\ -Numerically evaluate the integral of @var{f} from @var{a} to @var{b}\n\ -using doubly-adaptive @nospell{Clenshaw-Curtis} quadrature.\n\ -\n\ -@var{f} is a function handle, inline function, or string containing the name\n\ -of the function to evaluate. The function @var{f} must be vectorized and\n\ -must return a vector of output values if given a vector of input values.\n\ -For example,\n\ -\n\ -@example\n\ -f = @@(x) x .* sin (1./x) .* sqrt (abs (1 - x));\n\ -@end example\n\ -\n\ -@noindent\n\ -which uses the element-by-element ``dot'' form for all operators.\n\ -\n\ -@var{a} and @var{b} are the lower and upper limits of integration. Either\n\ -or both limits may be infinite. @code{quadcc} handles an inifinite limit\n\ -by substituting the variable of integration with @code{x = tan (pi/2*u)}.\n\ -\n\ -The optional argument @var{tol} defines the relative tolerance used to stop\n\ -the integration procedure. The default value is @math{1e^{-6}}.\n\ -\n\ -The optional argument @var{sing} contains a list of points where the\n\ -integrand has known singularities, or discontinuities\n\ -in any of its derivatives, inside the integration interval.\n\ -For the example above, which has a discontinuity at x=1, the call to\n\ -@code{quadcc} would be as follows\n\ -\n\ -@example\n\ -int = quadcc (f, a, b, 1.0e-6, [ 1 ]);\n\ -@end example\n\ -\n\ -The result of the integration is returned in @var{q}.\n\ -\n\ -@var{err} is an estimate of the absolute integration error.\n\ -\n\ -@var{nr_points} is the number of points at which the integrand was\n\ -evaluated.\n\ -\n\ -If the adaptive integration did not converge, the value of @var{err} will be\n\ -larger than the requested tolerance. Therefore, it is recommended to verify\n\ -this value for difficult integrands.\n\ -\n\ -@code{quadcc} is capable of dealing with non-numeric values of the integrand\n\ -such as @code{NaN} or @code{Inf}. If the integral diverges, and\n\ -@code{quadcc} detects this, then a warning is issued and @code{Inf} or\n\ -@code{-Inf} is returned.\n\ -\n\ -Note: @code{quadcc} is a general purpose quadrature algorithm and, as such,\n\ -may be less efficient for a smooth or otherwise well-behaved integrand than\n\ -other methods such as @code{quadgk}.\n\ -\n\ -The algorithm uses @nospell{Clenshaw-Curtis} quadrature rules of increasing\n\ -degree in each interval and bisects the interval if either the function does\n\ -not appear to be smooth or a rule of maximum degree has been reached. The\n\ -error estimate is computed from the L2-norm of the difference between two\n\ -successive interpolations of the integrand over the nodes of the respective\n\ -quadrature rules.\n\ -\n\ -Reference: @nospell{P. Gonnet}, @cite{Increasing the Reliability of Adaptive\n\ -Quadrature Using Explicit Interpolants}, ACM Transactions on\n\ -Mathematical Software, Vol. 37, Issue 3, Article No. 3, 2010.\n\ -@seealso{quad, quadv, quadl, quadgk, trapz, dblquad, triplequad}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{q} =} quadcc (@var{f}, @var{a}, @var{b}) +@deftypefnx {} {@var{q} =} quadcc (@var{f}, @var{a}, @var{b}, @var{tol}) +@deftypefnx {} {@var{q} =} quadcc (@var{f}, @var{a}, @var{b}, @var{tol}, @var{sing}) +@deftypefnx {} {[@var{q}, @var{err}, @var{nr_points}] =} quadcc (@dots{}) +Numerically evaluate the integral of @var{f} from @var{a} to @var{b} +using doubly-adaptive @nospell{Clenshaw-Curtis} quadrature. + +@var{f} is a function handle, inline function, or string containing the name +of the function to evaluate. The function @var{f} must be vectorized and +must return a vector of output values if given a vector of input values. +For example, + +@example +f = @@(x) x .* sin (1./x) .* sqrt (abs (1 - x)); +@end example + +@noindent +which uses the element-by-element ``dot'' form for all operators. + +@var{a} and @var{b} are the lower and upper limits of integration. Either +or both limits may be infinite. @code{quadcc} handles an inifinite limit +by substituting the variable of integration with @code{x = tan (pi/2*u)}. + +The optional argument @var{tol} defines the relative tolerance used to stop +the integration procedure. The default value is @math{1e^{-6}}. + +The optional argument @var{sing} contains a list of points where the +integrand has known singularities, or discontinuities +in any of its derivatives, inside the integration interval. +For the example above, which has a discontinuity at x=1, the call to +@code{quadcc} would be as follows + +@example +int = quadcc (f, a, b, 1.0e-6, [ 1 ]); +@end example + +The result of the integration is returned in @var{q}. + +@var{err} is an estimate of the absolute integration error. + +@var{nr_points} is the number of points at which the integrand was +evaluated. + +If the adaptive integration did not converge, the value of @var{err} will be +larger than the requested tolerance. Therefore, it is recommended to verify +this value for difficult integrands. + +@code{quadcc} is capable of dealing with non-numeric values of the integrand +such as @code{NaN} or @code{Inf}. If the integral diverges, and +@code{quadcc} detects this, then a warning is issued and @code{Inf} or +@code{-Inf} is returned. + +Note: @code{quadcc} is a general purpose quadrature algorithm and, as such, +may be less efficient for a smooth or otherwise well-behaved integrand than +other methods such as @code{quadgk}. + +The algorithm uses @nospell{Clenshaw-Curtis} quadrature rules of increasing +degree in each interval and bisects the interval if either the function does +not appear to be smooth or a rule of maximum degree has been reached. The +error estimate is computed from the L2-norm of the difference between two +successive interpolations of the integrand over the nodes of the respective +quadrature rules. + +Reference: @nospell{P. Gonnet}, @cite{Increasing the Reliability of Adaptive +Quadrature Using Explicit Interpolants}, ACM Transactions on +Mathematical Software, Vol. 37, Issue 3, Article No. 3, 2010. +@seealso{quad, quadv, quadl, quadgk, trapz, dblquad, triplequad} +@end deftypefn */) { // Some constants that we will need. static const int n[4] = { 4, 8, 16, 32 };