Mercurial > octave-nkf

comparison src/DLD-FUNCTIONS/spparms.cc @ 10840:89f4d7e294cc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammarcheck .cc files
author Rik <octave@nomad.inbox5.com>
date Sat, 31 Jul 2010 11:18:11 -0700
parents fbd7843974fa
children fd0a3ac60b0e
comparison
equal deleted inserted replaced
10839:65bc065bec95 10840:89f4d7e294cc
33 33
34 #include "oct-spparms.h" 34 #include "oct-spparms.h"
35 35
36 DEFUN_DLD (spparms, args, nargout, 36 DEFUN_DLD (spparms, args, nargout,
37 "-*- texinfo -*-\n\ 37 "-*- texinfo -*-\n\
38 @deftypefn {Loadable Function} { } spparms ()\n\ 38 @deftypefn {Loadable Function} { } spparms ()\n\
39 @deftypefnx {Loadable Function} {@var{vals} =} spparms ()\n\ 39 @deftypefnx {Loadable Function} {@var{vals} =} spparms ()\n\
40 @deftypefnx {Loadable Function} {[@var{keys}, @var{vals}] =} spparms ()\n\ 40 @deftypefnx {Loadable Function} {[@var{keys}, @var{vals}] =} spparms ()\n\
41 @deftypefnx {Loadable Function} {@var{val} =} spparms (@var{key})\n\ 41 @deftypefnx {Loadable Function} {@var{val} =} spparms (@var{key})\n\
42 @deftypefnx {Loadable Function} { } spparms (@var{vals})\n\ 42 @deftypefnx {Loadable Function} { } spparms (@var{vals})\n\
43 @deftypefnx {Loadable Function} { } spparms ('defaults')\n\ 43 @deftypefnx {Loadable Function} { } spparms ('defaults')\n\
50 keys are one of the following strings:\n\ 50 keys are one of the following strings:\n\
51 \n\ 51 \n\
52 @table @code\n\ 52 @table @code\n\
53 @item spumoni\n\ 53 @item spumoni\n\
54 Printing level of debugging information of the solvers (default 0)\n\ 54 Printing level of debugging information of the solvers (default 0)\n\
55 \n\
55 @item ths_rel\n\ 56 @item ths_rel\n\
56 Included for compatibility. Not used. (default 1)\n\ 57 Included for compatibility. Not used. (default 1)\n\
58 \n\
57 @item ths_abs\n\ 59 @item ths_abs\n\
58 Included for compatibility. Not used. (default 1)\n\ 60 Included for compatibility. Not used. (default 1)\n\
61 \n\
59 @item exact_d\n\ 62 @item exact_d\n\
60 Included for compatibility. Not used. (default 0)\n\ 63 Included for compatibility. Not used. (default 0)\n\
64 \n\
61 @item supernd\n\ 65 @item supernd\n\
62 Included for compatibility. Not used. (default 3)\n\ 66 Included for compatibility. Not used. (default 3)\n\
67 \n\
63 @item rreduce\n\ 68 @item rreduce\n\
64 Included for compatibility. Not used. (default 3)\n\ 69 Included for compatibility. Not used. (default 3)\n\
70 \n\
65 @item wh_frac\n\ 71 @item wh_frac\n\
66 Included for compatibility. Not used. (default 0.5)\n\ 72 Included for compatibility. Not used. (default 0.5)\n\
73 \n\
67 @item autommd\n\ 74 @item autommd\n\
68 Flag whether the LU/QR and the '\\' and '/' operators will automatically\n\ 75 Flag whether the LU/QR and the '\\' and '/' operators will automatically\n\
69 use the sparsity preserving mmd functions (default 1)\n\ 76 use the sparsity preserving mmd functions (default 1)\n\
77 \n\
70 @item autoamd\n\ 78 @item autoamd\n\
71 Flag whether the LU and the '\\' and '/' operators will automatically\n\ 79 Flag whether the LU and the '\\' and '/' operators will automatically\n\
72 use the sparsity preserving amd functions (default 1)\n\ 80 use the sparsity preserving amd functions (default 1)\n\
81 \n\
73 @item piv_tol\n\ 82 @item piv_tol\n\
74 The pivot tolerance of the @sc{umfpack} solvers (default 0.1)\n\ 83 The pivot tolerance of the @sc{umfpack} solvers (default 0.1)\n\
84 \n\
75 @item sym_tol\n\ 85 @item sym_tol\n\
76 The pivot tolerance of the @sc{umfpack} symmetric solvers (default 0.001)\n\ 86 The pivot tolerance of the @sc{umfpack} symmetric solvers (default 0.001)\n\
87 \n\
77 @item bandden\n\ 88 @item bandden\n\
78 The density of non-zero elements in a banded matrix before it is treated\n\ 89 The density of non-zero elements in a banded matrix before it is treated\n\
79 by the @sc{lapack} banded solvers (default 0.5)\n\ 90 by the @sc{lapack} banded solvers (default 0.5)\n\
91 \n\
80 @item umfpack\n\ 92 @item umfpack\n\
81 Flag whether the @sc{umfpack} or mmd solvers are used for the LU, '\\' and\n\ 93 Flag whether the @sc{umfpack} or mmd solvers are used for the LU, '\\' and\n\
82 '/' operations (default 1)\n\ 94 '/' operations (default 1)\n\
83 @end table\n\ 95 @end table\n\
84 \n\ 96 \n\