|
5164
|
1 /* |
|
|
2 |
|
|
3 Copyright (C) 2004 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\ |
|
|
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\ |
|
|
49 stored as pairs of keys and values, where the values are all floats and the\n\ |
|
|
50 keys are one of the strings\n\ |
|
|
51 \n\ |
|
|
52 @itemize\n\ |
|
|
53 @item spumoni\n\ |
|
|
54 Printing level of debugging information of the solvers (default 0)\n\ |
|
|
55 @item ths_rel\n\ |
|
7001
|
56 Included for compatibility. Not used. (default 1)\n\ |
|
5164
|
57 @item ths_abs\n\ |
|
7001
|
58 Included for compatibility. Not used. (default 1)\n\ |
|
5164
|
59 @item exact_d\n\ |
|
7001
|
60 Included for compatibility. Not used. (default 0)\n\ |
|
5164
|
61 @item supernd\n\ |
|
7001
|
62 Included for compatibility. Not used. (default 3)\n\ |
|
5164
|
63 @item rreduce\n\ |
|
7001
|
64 Included for compatibility. Not used. (default 3)\n\ |
|
5164
|
65 @item wh_frac\n\ |
|
7001
|
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\ |
|
|
75 @item bandden\n\ |
|
|
76 ?? (default 0.5)\n\ |
|
|
77 @item umfpack\n\ |
|
|
78 Flag whether the UMFPACK or mmd solvers are used for the LU, '\\' and\n\ |
|
|
79 '/' operations (default 1)\n\ |
|
|
80 @end itemize\n\ |
|
|
81 \n\ |
|
|
82 The value of individual keys can be set with @code{spparms (@var{key},\n\ |
|
|
83 @var{val})}. The default values can be restored with the special keyword\n\ |
|
|
84 'defaults'. The special keyword 'tight' can be used to set the mmd solvers\n\ |
|
7001
|
85 to attempt for a sparser solution at the potential cost of longer running\n\ |
|
5164
|
86 time.\n\ |
|
|
87 @end deftypefn") |
|
|
88 { |
|
|
89 octave_value_list retval; |
|
|
90 int nargin = args.length (); |
|
|
91 |
|
|
92 if (nargin == 0) |
|
|
93 { |
|
|
94 if (nargout == 0) |
|
5893
|
95 octave_sparse_params::print_info (octave_stdout, ""); |
|
5164
|
96 else if (nargout == 1) |
|
5893
|
97 retval(0) = octave_sparse_params::get_vals (); |
|
5164
|
98 else if (nargout == 2) |
|
|
99 { |
|
5893
|
100 retval (0) = octave_sparse_params::get_keys (); |
|
|
101 retval (1) = octave_sparse_params::get_vals (); |
|
5164
|
102 } |
|
|
103 else |
|
5380
|
104 error ("spparms: too many output arguments"); |
|
5164
|
105 } |
|
|
106 else if (nargin == 1) |
|
|
107 { |
|
|
108 if (args(0).is_string ()) |
|
|
109 { |
|
|
110 std::string str = args(0).string_value (); |
|
|
111 int len = str.length (); |
|
|
112 for (int i = 0; i < len; i++) |
|
|
113 str [i] = tolower (str [i]); |
|
|
114 |
|
|
115 if (str == "defaults") |
|
5893
|
116 octave_sparse_params::defaults (); |
|
5164
|
117 else if (str == "tight") |
|
5893
|
118 octave_sparse_params::tight (); |
|
5164
|
119 else |
|
|
120 { |
|
5893
|
121 double val = octave_sparse_params::get_key (str); |
|
5164
|
122 if (xisnan (val)) |
|
|
123 error ("spparams: unrecognized key"); |
|
|
124 else |
|
|
125 retval (0) = val; |
|
|
126 } |
|
|
127 } |
|
|
128 else |
|
|
129 { |
|
|
130 NDArray vals = args(0).array_value (); |
|
|
131 |
|
|
132 if (error_state) |
|
|
133 error ("spparms: input must be a string or a vector"); |
|
|
134 else if (vals.numel () > OCTAVE_SPARSE_CONTROLS_SIZE) |
|
|
135 error ("spparams: too many elements in values vector"); |
|
|
136 else |
|
5893
|
137 octave_sparse_params::set_vals (vals); |
|
5164
|
138 } |
|
|
139 } |
|
|
140 else if (nargin == 2) |
|
|
141 { |
|
|
142 if (args(0).is_string ()) |
|
|
143 { |
|
|
144 std::string str = args(0).string_value (); |
|
|
145 |
|
|
146 double val = args(1).double_value (); |
|
|
147 |
|
|
148 if (error_state) |
|
|
149 error ("spparms: second argument must be a real scalar"); |
|
|
150 else if (str == "umfpack") |
|
|
151 warning ("spparms: request to disable umfpack solvers ignored"); |
|
5893
|
152 else if (!octave_sparse_params::set_key (str, val)) |
|
5164
|
153 error ("spparms: key not found"); |
|
|
154 } |
|
|
155 else |
|
|
156 error ("spparms: first argument must be a string"); |
|
|
157 } |
|
|
158 else |
|
|
159 error ("spparms: too many input arguments"); |
|
|
160 |
|
|
161 return retval; |
|
|
162 } |
|
|
163 |
|
|
164 /* |
|
|
165 ;;; Local Variables: *** |
|
|
166 ;;; mode: C++ *** |
|
|
167 ;;; End: *** |
|
|
168 */ |
