Mercurial > octave
diff libinterp/corefcn/besselj.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 | df064166f180 |
children | 278fc29b69ca |
line wrap: on
line diff
--- a/libinterp/corefcn/besselj.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/corefcn/besselj.cc Tue Jun 21 16:07:51 2016 -0400 @@ -300,75 +300,75 @@ } DEFUN (besselj, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {[@var{j}, @var{ierr}] =} besselj (@var{alpha}, @var{x}, @var{opt})\n\ -@deftypefnx {} {[@var{y}, @var{ierr}] =} bessely (@var{alpha}, @var{x}, @var{opt})\n\ -@deftypefnx {} {[@var{i}, @var{ierr}] =} besseli (@var{alpha}, @var{x}, @var{opt})\n\ -@deftypefnx {} {[@var{k}, @var{ierr}] =} besselk (@var{alpha}, @var{x}, @var{opt})\n\ -@deftypefnx {} {[@var{h}, @var{ierr}] =} besselh (@var{alpha}, @var{k}, @var{x}, @var{opt})\n\ -Compute Bessel or Hankel functions of various kinds:\n\ -\n\ -@table @code\n\ -@item besselj\n\ -Bessel functions of the first kind. If the argument @var{opt} is 1 or true,\n\ -the result is multiplied by @w{@code{exp (-abs (imag (@var{x})))}}.\n\ -\n\ -@item bessely\n\ -Bessel functions of the second kind. If the argument @var{opt} is 1 or\n\ -true, the result is multiplied by @code{exp (-abs (imag (@var{x})))}.\n\ -\n\ -@item besseli\n\ -\n\ -Modified Bessel functions of the first kind. If the argument @var{opt} is 1\n\ -or true, the result is multiplied by @code{exp (-abs (real (@var{x})))}.\n\ -\n\ -@item besselk\n\ -\n\ -Modified Bessel functions of the second kind. If the argument @var{opt} is\n\ -1 or true, the result is multiplied by @code{exp (@var{x})}.\n\ -\n\ -@item besselh\n\ -Compute Hankel functions of the first (@var{k} = 1) or second (@var{k}\n\ -= 2) kind. If the argument @var{opt} is 1 or true, the result is multiplied\n\ -by @code{exp (-I*@var{x})} for @var{k} = 1 or @code{exp (I*@var{x})} for\n\ -@var{k} = 2.\n\ -@end table\n\ -\n\ -If @var{alpha} is a scalar, the result is the same size as @var{x}.\n\ -If @var{x} is a scalar, the result is the same size as @var{alpha}.\n\ -If @var{alpha} is a row vector and @var{x} is a column vector, the\n\ -result is a matrix with @code{length (@var{x})} rows and\n\ -@code{length (@var{alpha})} columns. Otherwise, @var{alpha} and\n\ -@var{x} must conform and the result will be the same size.\n\ -\n\ -The value of @var{alpha} must be real. The value of @var{x} may be\n\ -complex.\n\ -\n\ -If requested, @var{ierr} contains the following status information\n\ -and is the same size as the result.\n\ -\n\ -@enumerate 0\n\ -@item\n\ -Normal return.\n\ -\n\ -@item\n\ -Input error, return @code{NaN}.\n\ -\n\ -@item\n\ -Overflow, return @code{Inf}.\n\ -\n\ -@item\n\ -Loss of significance by argument reduction results in less than\n\ -half of machine accuracy.\n\ -\n\ -@item\n\ -Complete loss of significance by argument reduction, return @code{NaN}.\n\ -\n\ -@item\n\ -Error---no computation, algorithm termination condition not met,\n\ -return @code{NaN}.\n\ -@end enumerate\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {[@var{j}, @var{ierr}] =} besselj (@var{alpha}, @var{x}, @var{opt}) +@deftypefnx {} {[@var{y}, @var{ierr}] =} bessely (@var{alpha}, @var{x}, @var{opt}) +@deftypefnx {} {[@var{i}, @var{ierr}] =} besseli (@var{alpha}, @var{x}, @var{opt}) +@deftypefnx {} {[@var{k}, @var{ierr}] =} besselk (@var{alpha}, @var{x}, @var{opt}) +@deftypefnx {} {[@var{h}, @var{ierr}] =} besselh (@var{alpha}, @var{k}, @var{x}, @var{opt}) +Compute Bessel or Hankel functions of various kinds: + +@table @code +@item besselj +Bessel functions of the first kind. If the argument @var{opt} is 1 or true, +the result is multiplied by @w{@code{exp (-abs (imag (@var{x})))}}. + +@item bessely +Bessel functions of the second kind. If the argument @var{opt} is 1 or +true, the result is multiplied by @code{exp (-abs (imag (@var{x})))}. + +@item besseli + +Modified Bessel functions of the first kind. If the argument @var{opt} is 1 +or true, the result is multiplied by @code{exp (-abs (real (@var{x})))}. + +@item besselk + +Modified Bessel functions of the second kind. If the argument @var{opt} is +1 or true, the result is multiplied by @code{exp (@var{x})}. + +@item besselh +Compute Hankel functions of the first (@var{k} = 1) or second (@var{k} += 2) kind. If the argument @var{opt} is 1 or true, the result is multiplied +by @code{exp (-I*@var{x})} for @var{k} = 1 or @code{exp (I*@var{x})} for +@var{k} = 2. +@end table + +If @var{alpha} is a scalar, the result is the same size as @var{x}. +If @var{x} is a scalar, the result is the same size as @var{alpha}. +If @var{alpha} is a row vector and @var{x} is a column vector, the +result is a matrix with @code{length (@var{x})} rows and +@code{length (@var{alpha})} columns. Otherwise, @var{alpha} and +@var{x} must conform and the result will be the same size. + +The value of @var{alpha} must be real. The value of @var{x} may be +complex. + +If requested, @var{ierr} contains the following status information +and is the same size as the result. + +@enumerate 0 +@item +Normal return. + +@item +Input error, return @code{NaN}. + +@item +Overflow, return @code{Inf}. + +@item +Loss of significance by argument reduction results in less than +half of machine accuracy. + +@item +Complete loss of significance by argument reduction, return @code{NaN}. + +@item +Error---no computation, algorithm termination condition not met, +return @code{NaN}. +@end enumerate +@end deftypefn */) { return do_bessel (BESSEL_J, "besselj", args, nargout); } @@ -378,10 +378,10 @@ */ DEFUN (bessely, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {[@var{y}, @var{ierr}] =} bessely (@var{alpha}, @var{x}, @var{opt})\n\ -See besselj.\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {[@var{y}, @var{ierr}] =} bessely (@var{alpha}, @var{x}, @var{opt}) +See besselj. +@end deftypefn */) { return do_bessel (BESSEL_Y, "bessely", args, nargout); } @@ -391,10 +391,10 @@ */ DEFUN (besseli, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {[@var{i}, @var{ierr}] =} besseli (@var{alpha}, @var{x}, @var{opt})\n\ -See besselj.\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {[@var{i}, @var{ierr}] =} besseli (@var{alpha}, @var{x}, @var{opt}) +See besselj. +@end deftypefn */) { return do_bessel (BESSEL_I, "besseli", args, nargout); } @@ -404,10 +404,10 @@ */ DEFUN (besselk, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {[@var{k}, @var{ierr}] =} besselk (@var{alpha}, @var{x}, @var{opt})\n\ -See besselj.\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {[@var{k}, @var{ierr}] =} besselk (@var{alpha}, @var{x}, @var{opt}) +See besselj. +@end deftypefn */) { return do_bessel (BESSEL_K, "besselk", args, nargout); } @@ -417,10 +417,10 @@ */ DEFUN (besselh, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {[@var{h}, @var{ierr}] =} besselh (@var{alpha}, @var{k}, @var{x}, @var{opt})\n\ -See besselj.\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {[@var{h}, @var{ierr}] =} besselh (@var{alpha}, @var{k}, @var{x}, @var{opt}) +See besselj. +@end deftypefn */) { int nargin = args.length (); @@ -461,51 +461,51 @@ */ DEFUN (airy, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {[@var{a}, @var{ierr}] =} airy (@var{k}, @var{z}, @var{opt})\n\ -Compute Airy functions of the first and second kind, and their derivatives.\n\ -\n\ -@example\n\ -@group\n\ - K Function Scale factor (if \"opt\" is supplied)\n\ ---- -------- ---------------------------------------\n\ - 0 Ai (Z) exp ((2/3) * Z * sqrt (Z))\n\ - 1 dAi(Z)/dZ exp ((2/3) * Z * sqrt (Z))\n\ - 2 Bi (Z) exp (-abs (real ((2/3) * Z * sqrt (Z))))\n\ - 3 dBi(Z)/dZ exp (-abs (real ((2/3) * Z * sqrt (Z))))\n\ -@end group\n\ -@end example\n\ -\n\ -The function call @code{airy (@var{z})} is equivalent to\n\ -@code{airy (0, @var{z})}.\n\ -\n\ -The result is the same size as @var{z}.\n\ -\n\ -If requested, @var{ierr} contains the following status information and\n\ -is the same size as the result.\n\ -\n\ -@enumerate 0\n\ -@item\n\ -Normal return.\n\ -\n\ -@item\n\ -Input error, return @code{NaN}.\n\ -\n\ -@item\n\ -Overflow, return @code{Inf}.\n\ -\n\ -@item\n\ -Loss of significance by argument reduction results in less than half\n\ - of machine accuracy.\n\ -\n\ -@item\n\ -Complete loss of significance by argument reduction, return @code{NaN}.\n\ -\n\ -@item\n\ -Error---no computation, algorithm termination condition not met,\n\ -return @code{NaN}.\n\ -@end enumerate\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {[@var{a}, @var{ierr}] =} airy (@var{k}, @var{z}, @var{opt}) +Compute Airy functions of the first and second kind, and their derivatives. + +@example +@group + K Function Scale factor (if "opt" is supplied) +--- -------- --------------------------------------- + 0 Ai (Z) exp ((2/3) * Z * sqrt (Z)) + 1 dAi(Z)/dZ exp ((2/3) * Z * sqrt (Z)) + 2 Bi (Z) exp (-abs (real ((2/3) * Z * sqrt (Z)))) + 3 dBi(Z)/dZ exp (-abs (real ((2/3) * Z * sqrt (Z)))) +@end group +@end example + +The function call @code{airy (@var{z})} is equivalent to +@code{airy (0, @var{z})}. + +The result is the same size as @var{z}. + +If requested, @var{ierr} contains the following status information and +is the same size as the result. + +@enumerate 0 +@item +Normal return. + +@item +Input error, return @code{NaN}. + +@item +Overflow, return @code{Inf}. + +@item +Loss of significance by argument reduction results in less than half + of machine accuracy. + +@item +Complete loss of significance by argument reduction, return @code{NaN}. + +@item +Error---no computation, algorithm termination condition not met, +return @code{NaN}. +@end enumerate +@end deftypefn */) { int nargin = args.length ();