Mercurial > octave-nkf

comparison src/DLD-FUNCTIONS/spparms.cc @ 9064:7c02ec148a3c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Check grammar on all .cc files Same check as previously done on .m files Attempt to enforce some conformity in documentation text for rules such as two spaces after a period, commas around latin abbreviations, etc.
author Rik <rdrider0-list@yahoo.com>
date Sat, 28 Mar 2009 13:57:22 -0700
parents eb63fbe60fab
children 923c7cb7f13f
comparison
equal deleted inserted replaced
9063:a6cf0ad87eee 9064:7c02ec148a3c
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\
44 @deftypefnx {Loadable Function} { } spparms ('tight')\n\ 44 @deftypefnx {Loadable Function} { } spparms ('tight')\n\
45 @deftypefnx {Loadable Function} { } spparms (@var{key}, @var{val})\n\ 45 @deftypefnx {Loadable Function} { } spparms (@var{key}, @var{val})\n\
46 Sets or displays the parameters used by the sparse solvers and factorization\n\ 46 Sets or displays the parameters used by the sparse solvers and factorization\n\
47 functions. The first four calls above get information about the current\n\ 47 functions. The first four calls above get information about the current\n\
48 settings, while the others change the current settings. The parameters are\n\ 48 settings, while the others change the current settings. The parameters are\n\
49 stored as pairs of keys and values, where the values are all floats and the\n\ 49 stored as pairs of keys and values, where the values are all floats and the\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 @item ths_rel\n\ 55 @item ths_rel\n\
56 Included for compatibility. Not used. (default 1)\n\ 56 Included for compatibility. Not used. (default 1)\n\
57 @item ths_abs\n\ 57 @item ths_abs\n\
58 Included for compatibility. Not used. (default 1)\n\ 58 Included for compatibility. Not used. (default 1)\n\
59 @item exact_d\n\ 59 @item exact_d\n\
60 Included for compatibility. Not used. (default 0)\n\ 60 Included for compatibility. Not used. (default 0)\n\
61 @item supernd\n\ 61 @item supernd\n\
62 Included for compatibility. Not used. (default 3)\n\ 62 Included for compatibility. Not used. (default 3)\n\
63 @item rreduce\n\ 63 @item rreduce\n\
64 Included for compatibility. Not used. (default 3)\n\ 64 Included for compatibility. Not used. (default 3)\n\
65 @item wh_frac\n\ 65 @item wh_frac\n\
66 Included for compatibility. Not used. (default 0.5)\n\ 66 Included for compatibility. Not used. (default 0.5)\n\
67 @item autommd\n\ 67 @item autommd\n\
68 Flag whether the LU/QR and the '\\' and '/' operators will automatically\n\ 68 Flag whether the LU/QR and the '\\' and '/' operators will automatically\n\
69 use the sparsity preserving mmd functions (default 1)\n\ 69 use the sparsity preserving mmd functions (default 1)\n\
70 @item autoamd\n\ 70 @item autoamd\n\
71 Flag whether the LU and the '\\' and '/' operators will automatically\n\ 71 Flag whether the LU and the '\\' and '/' operators will automatically\n\
81 Flag whether the UMFPACK or mmd solvers are used for the LU, '\\' and\n\ 81 Flag whether the UMFPACK or mmd solvers are used for the LU, '\\' and\n\
82 '/' operations (default 1)\n\ 82 '/' operations (default 1)\n\
83 @end table\n\ 83 @end table\n\
84 \n\ 84 \n\
85 The value of individual keys can be set with @code{spparms (@var{key},\n\ 85 The value of individual keys can be set with @code{spparms (@var{key},\n\
86 @var{val})}. The default values can be restored with the special keyword\n\ 86 @var{val})}. The default values can be restored with the special keyword\n\
87 'defaults'. The special keyword 'tight' can be used to set the mmd solvers\n\ 87 'defaults'. The special keyword 'tight' can be used to set the mmd solvers\n\
88 to attempt for a sparser solution at the potential cost of longer running\n\ 88 to attempt for a sparser solution at the potential cost of longer running\n\
89 time.\n\ 89 time.\n\
90 @end deftypefn") 90 @end deftypefn")
91 { 91 {
92 octave_value_list retval; 92 octave_value_list retval;