Mercurial > octave
diff libinterp/corefcn/spparms.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 | 2aef506f3fec |
children | bac0d6f07a3e |
line wrap: on
line diff
--- a/libinterp/corefcn/spparms.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/corefcn/spparms.cc Tue Jun 21 16:07:51 2016 -0400 @@ -34,76 +34,76 @@ #include "oct-spparms.h" DEFUN (spparms, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} { } spparms ()\n\ -@deftypefnx {} {@var{vals} =} spparms ()\n\ -@deftypefnx {} {[@var{keys}, @var{vals}] =} spparms ()\n\ -@deftypefnx {} {@var{val} =} spparms (@var{key})\n\ -@deftypefnx {} { } spparms (@var{vals})\n\ -@deftypefnx {} { } spparms (\"default\")\n\ -@deftypefnx {} { } spparms (\"tight\")\n\ -@deftypefnx {} { } spparms (@var{key}, @var{val})\n\ -Query or set the parameters used by the sparse solvers and factorization\n\ -functions.\n\ -\n\ -The first four calls above get information about the current settings, while\n\ -the others change the current settings. The parameters are stored as pairs\n\ -of keys and values, where the values are all floats and the keys are one of\n\ -the following strings:\n\ -\n\ -@table @samp\n\ -@item spumoni\n\ -Printing level of debugging information of the solvers (default 0)\n\ -\n\ -@item ths_rel\n\ -Included for compatibility. Not used. (default 1)\n\ -\n\ -@item ths_abs\n\ -Included for compatibility. Not used. (default 1)\n\ -\n\ -@item exact_d\n\ -Included for compatibility. Not used. (default 0)\n\ -\n\ -@item supernd\n\ -Included for compatibility. Not used. (default 3)\n\ -\n\ -@item rreduce\n\ -Included for compatibility. Not used. (default 3)\n\ -\n\ -@item wh_frac\n\ -Included for compatibility. Not used. (default 0.5)\n\ -\n\ -@item autommd\n\ -Flag whether the LU/QR and the '\\' and '/' operators will automatically\n\ -use the sparsity preserving mmd functions (default 1)\n\ -\n\ -@item autoamd\n\ -Flag whether the LU and the '\\' and '/' operators will automatically\n\ -use the sparsity preserving amd functions (default 1)\n\ -\n\ -@item piv_tol\n\ -The pivot tolerance of the @sc{umfpack} solvers (default 0.1)\n\ -\n\ -@item sym_tol\n\ -The pivot tolerance of the @sc{umfpack} symmetric solvers (default 0.001)\n\ -\n\ -@item bandden\n\ -The density of nonzero elements in a banded matrix before it is treated\n\ -by the @sc{lapack} banded solvers (default 0.5)\n\ -\n\ -@item umfpack\n\ -Flag whether the @sc{umfpack} or mmd solvers are used for the LU, '\\' and\n\ -'/' operations (default 1)\n\ -@end table\n\ -\n\ -The value of individual keys can be set with\n\ -@code{spparms (@var{key}, @var{val})}.\n\ -The default values can be restored with the special keyword\n\ -@qcode{\"default\"}. The special keyword @qcode{\"tight\"} can be used to\n\ -set the mmd solvers to attempt a sparser solution at the potential cost of\n\ -longer running time.\n\ -@seealso{chol, colamd, lu, qr, symamd}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} { } spparms () +@deftypefnx {} {@var{vals} =} spparms () +@deftypefnx {} {[@var{keys}, @var{vals}] =} spparms () +@deftypefnx {} {@var{val} =} spparms (@var{key}) +@deftypefnx {} { } spparms (@var{vals}) +@deftypefnx {} { } spparms ("default") +@deftypefnx {} { } spparms ("tight") +@deftypefnx {} { } spparms (@var{key}, @var{val}) +Query or set the parameters used by the sparse solvers and factorization +functions. + +The first four calls above get information about the current settings, while +the others change the current settings. The parameters are stored as pairs +of keys and values, where the values are all floats and the keys are one of +the following strings: + +@table @samp +@item spumoni +Printing level of debugging information of the solvers (default 0) + +@item ths_rel +Included for compatibility. Not used. (default 1) + +@item ths_abs +Included for compatibility. Not used. (default 1) + +@item exact_d +Included for compatibility. Not used. (default 0) + +@item supernd +Included for compatibility. Not used. (default 3) + +@item rreduce +Included for compatibility. Not used. (default 3) + +@item wh_frac +Included for compatibility. Not used. (default 0.5) + +@item autommd +Flag whether the LU/QR and the '\' and '/' operators will automatically +use the sparsity preserving mmd functions (default 1) + +@item autoamd +Flag whether the LU and the '\' and '/' operators will automatically +use the sparsity preserving amd functions (default 1) + +@item piv_tol +The pivot tolerance of the @sc{umfpack} solvers (default 0.1) + +@item sym_tol +The pivot tolerance of the @sc{umfpack} symmetric solvers (default 0.001) + +@item bandden +The density of nonzero elements in a banded matrix before it is treated +by the @sc{lapack} banded solvers (default 0.5) + +@item umfpack +Flag whether the @sc{umfpack} or mmd solvers are used for the LU, '\' and +'/' operations (default 1) +@end table + +The value of individual keys can be set with +@code{spparms (@var{key}, @var{val})}. +The default values can be restored with the special keyword +@qcode{"default"}. The special keyword @qcode{"tight"} can be used to +set the mmd solvers to attempt a sparser solution at the potential cost of +longer running time. +@seealso{chol, colamd, lu, qr, symamd} +@end deftypefn */) { octave_value_list retval; int nargin = args.length ();