Mercurial > hg > octave-lyh
annotate src/DLD-FUNCTIONS/spparms.cc @ 10155:d0ce5e973937
DLD-FUNCTIONS/*.cc: delete Emacs local-variables settings
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 20 Jan 2010 17:40:53 -0500 |
parents | 40dfc0c99116 |
children | fbd7843974fa |
rev | line source |
---|---|
5164 | 1 /* |
2 | |
8920 | 3 Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 David Bateman |
7016 | 4 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 Andy Adler |
5164 | 5 |
7016 | 6 This file is part of Octave. |
7 | |
8 Octave is free software; you can redistribute it and/or modify it | |
5164 | 9 under the terms of the GNU General Public License as published by the |
7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
11 option) any later version. | |
5164 | 12 |
7016 | 13 Octave is distributed in the hope that it will be useful, but WITHOUT |
5164 | 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
16 for more details. | |
17 | |
18 You should have received a copy of the GNU General Public License | |
7016 | 19 along with Octave; see the file COPYING. If not, see |
20 <http://www.gnu.org/licenses/>. | |
5164 | 21 |
22 */ | |
23 | |
24 #ifdef HAVE_CONFIG_H | |
25 #include <config.h> | |
26 #endif | |
27 | |
28 #include "defun-dld.h" | |
29 #include "ov.h" | |
30 #include "pager.h" | |
31 #include "error.h" | |
32 #include "gripes.h" | |
33 | |
34 #include "oct-spparms.h" | |
35 | |
36 DEFUN_DLD (spparms, args, nargout, | |
37 "-*- texinfo -*-\n\ | |
38 @deftypefn {Loadable Function} { } spparms ()\n\ | |
39 @deftypefnx {Loadable Function} {@var{vals} =} spparms ()\n\ | |
40 @deftypefnx {Loadable Function} {[@var{keys}, @var{vals}] =} spparms ()\n\ | |
41 @deftypefnx {Loadable Function} {@var{val} =} spparms (@var{key})\n\ | |
42 @deftypefnx {Loadable Function} { } spparms (@var{vals})\n\ | |
43 @deftypefnx {Loadable Function} { } spparms ('defaults')\n\ | |
44 @deftypefnx {Loadable Function} { } spparms ('tight')\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\ | |
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
47 functions. The first four calls above get information about the current\n\ |
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
48 settings, while the others change the current settings. The parameters are\n\ |
5164 | 49 stored as pairs of keys and values, where the values are all floats and the\n\ |
8828 | 50 keys are one of the following strings:\n\ |
5164 | 51 \n\ |
8828 | 52 @table @code\n\ |
5164 | 53 @item spumoni\n\ |
54 Printing level of debugging information of the solvers (default 0)\n\ | |
55 @item ths_rel\n\ | |
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
56 Included for compatibility. Not used. (default 1)\n\ |
5164 | 57 @item ths_abs\n\ |
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
58 Included for compatibility. Not used. (default 1)\n\ |
5164 | 59 @item exact_d\n\ |
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
60 Included for compatibility. Not used. (default 0)\n\ |
5164 | 61 @item supernd\n\ |
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
62 Included for compatibility. Not used. (default 3)\n\ |
5164 | 63 @item rreduce\n\ |
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
64 Included for compatibility. Not used. (default 3)\n\ |
5164 | 65 @item wh_frac\n\ |
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
66 Included for compatibility. Not used. (default 0.5)\n\ |
5164 | 67 @item autommd\n\ |
68 Flag whether the LU/QR and the '\\' and '/' operators will automatically\n\ | |
69 use the sparsity preserving mmd functions (default 1)\n\ | |
70 @item autoamd\n\ | |
71 Flag whether the LU and the '\\' and '/' operators will automatically\n\ | |
72 use the sparsity preserving amd functions (default 1)\n\ | |
73 @item piv_tol\n\ | |
74 The pivot tolerance of the UMFPACK solvers (default 0.1)\n\ | |
7515
f3c00dc0912b
Eliminate the rest of the dispatched sparse functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
75 @item sym_tol\n\ |
f3c00dc0912b
Eliminate the rest of the dispatched sparse functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
76 The pivot tolerance of the UMFPACK symmetric solvers (default 0.001)\n\ |
5164 | 77 @item bandden\n\ |
7515
f3c00dc0912b
Eliminate the rest of the dispatched sparse functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
78 The density of non-zero elements in a banded matrix before it is treated\n\ |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9064
diff
changeset
|
79 by the @sc{lapack} banded solvers (default 0.5)\n\ |
5164 | 80 @item umfpack\n\ |
81 Flag whether the UMFPACK or mmd solvers are used for the LU, '\\' and\n\ | |
82 '/' operations (default 1)\n\ | |
8828 | 83 @end table\n\ |
5164 | 84 \n\ |
85 The value of individual keys can be set with @code{spparms (@var{key},\n\ | |
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
86 @var{val})}. The default values can be restored with the special keyword\n\ |
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
87 'defaults'. The special keyword 'tight' can be used to set the mmd solvers\n\ |
7001 | 88 to attempt for a sparser solution at the potential cost of longer running\n\ |
5164 | 89 time.\n\ |
90 @end deftypefn") | |
91 { | |
92 octave_value_list retval; | |
93 int nargin = args.length (); | |
94 | |
95 if (nargin == 0) | |
96 { | |
97 if (nargout == 0) | |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
98 octave_sparse_params::print_info (octave_stdout, ""); |
5164 | 99 else if (nargout == 1) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
100 retval(0) = octave_sparse_params::get_vals (); |
5164 | 101 else if (nargout == 2) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
102 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
103 retval (0) = octave_sparse_params::get_keys (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
104 retval (1) = octave_sparse_params::get_vals (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
105 } |
5164 | 106 else |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
107 error ("spparms: too many output arguments"); |
5164 | 108 } |
109 else if (nargin == 1) | |
110 { | |
111 if (args(0).is_string ()) | |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
112 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
113 std::string str = args(0).string_value (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
114 int len = str.length (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
115 for (int i = 0; i < len; i++) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
116 str [i] = tolower (str [i]); |
5164 | 117 |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
118 if (str == "defaults") |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
119 octave_sparse_params::defaults (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
120 else if (str == "tight") |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
121 octave_sparse_params::tight (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
122 else |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
123 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
124 double val = octave_sparse_params::get_key (str); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
125 if (xisnan (val)) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
126 error ("spparams: unrecognized key"); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
127 else |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
128 retval (0) = val; |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
129 } |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
130 } |
5164 | 131 else |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
132 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
133 NDArray vals = args(0).array_value (); |
5164 | 134 |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
135 if (error_state) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
136 error ("spparms: input must be a string or a vector"); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
137 else if (vals.numel () > OCTAVE_SPARSE_CONTROLS_SIZE) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
138 error ("spparams: too many elements in values vector"); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
139 else |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
140 octave_sparse_params::set_vals (vals); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
141 } |
5164 | 142 } |
143 else if (nargin == 2) | |
144 { | |
145 if (args(0).is_string ()) | |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
146 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
147 std::string str = args(0).string_value (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
148 |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
149 double val = args(1).double_value (); |
5164 | 150 |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
151 if (error_state) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
152 error ("spparms: second argument must be a real scalar"); |
5164 | 153 else if (str == "umfpack") |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
154 warning ("spparms: request to disable umfpack solvers ignored"); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
155 else if (!octave_sparse_params::set_key (str, val)) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
156 error ("spparms: key not found"); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
157 } |
5164 | 158 else |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
159 error ("spparms: first argument must be a string"); |
5164 | 160 } |
161 else | |
162 error ("spparms: too many input arguments"); | |
163 | |
164 return retval; | |
165 } |