Mercurial > octave
annotate libinterp/corefcn/spparms.cc @ 21100:e39e05d90788
Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
* libinterp/corefcn/errwarn.h, libinterp/corefcn/errwarn.cc: New header and .cc
file with common errors and warnings for libinterp.
* libinterp/corefcn/module.mk: Add errwarn.h, errwarn.cc to build system.
* liboctave/util/lo-array-errwarn.h, liboctave/util/lo-array-errwarn.cc: New
header and .cc file with common errors and warnings for liboctave.
* liboctave/util/module.mk: Add lo-array-errwarn.h, lo-array-errwarn.cc to
build system.
* lo-array-gripes.h: #include "lo-array-errwarn.h" for access to class
index_exception. Remove const char *error_id_XXX prototypes.
* lo-array-gripes.cc: Remove const char *error_id_XXX initializations.
Remove index_exception method definitions.
* Cell.cc, __pchip_deriv__.cc, __qp__.cc, balance.cc, betainc.cc, cellfun.cc,
daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc,
dirfns.cc, eig.cc, fft.cc, fft2.cc, fftn.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, graphics.in.h, help.cc, hess.cc, hex2num.cc,
input.cc, inv.cc, jit-typeinfo.cc, load-save.cc, lookup.cc, ls-hdf5.cc,
ls-mat-ascii.cc, ls-mat4.cc, ls-mat5.cc, ls-oct-binary.cc, ls-oct-text.cc,
lsode.cc, lu.cc, luinc.cc, max.cc, mgorth.cc, oct-hist.cc, oct-procbuf.cc,
oct-stream.cc, oct.h, pager.cc, pinv.cc, pr-output.cc, quad.cc, qz.cc, rand.cc,
rcond.cc, regexp.cc, schur.cc, sparse-xdiv.cc, sparse-xpow.cc, sparse.cc,
spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc,
sylvester.cc, syscalls.cc, typecast.cc, utils.cc, variables.cc, xdiv.cc,
xnorm.cc, xpow.cc, __eigs__.cc, __glpk__.cc, __magick_read__.cc,
__osmesa_print__.cc, audiodevinfo.cc, audioread.cc, chol.cc, dmperm.cc,
fftw.cc, qr.cc, symbfact.cc, symrcm.cc, ov-base-diag.cc, ov-base-int.cc,
ov-base-mat.cc, ov-base-scalar.cc, ov-base-sparse.cc, ov-base.cc,
ov-bool-mat.cc, ov-bool-sparse.cc, ov-bool.cc, ov-builtin.cc, ov-cell.cc,
ov-ch-mat.cc, ov-class.cc, ov-complex.cc, ov-complex.h, ov-cs-list.cc,
ov-cx-diag.cc, ov-cx-mat.cc, ov-cx-sparse.cc, ov-fcn-handle.cc,
ov-fcn-inline.cc, ov-float.cc, ov-float.h, ov-flt-complex.cc, ov-flt-complex.h,
ov-flt-cx-diag.cc, ov-flt-cx-mat.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-intx.h, ov-mex-fcn.cc, ov-perm.cc,
ov-range.cc, ov-re-mat.cc, ov-re-sparse.cc, ov-scalar.cc, ov-scalar.h,
ov-str-mat.cc, ov-struct.cc, ov-type-conv.h, ov-uint16.cc, ov-uint32.cc,
ov-uint64.cc, ov-uint8.cc, ov-usr-fcn.cc, ov.cc, op-b-b.cc, op-b-bm.cc,
op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc,
op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc,
op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc,
op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc,
op-dms-template.cc, op-double-conv.cc, op-fcdm-fcdm.cc, op-fcdm-fdm.cc,
op-fcm-fcm.cc, op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc,
op-fcs-fcm.cc, op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc,
op-float-conv.cc, op-fm-fcm.cc, op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc,
op-fs-fcm.cc, op-fs-fcs.cc, op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc,
op-i32-i32.cc, op-i64-i64.cc, op-i8-i8.cc, op-int-concat.cc, op-int-conv.cc,
op-int.h, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc, op-m-scm.cc,
op-m-sm.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc, op-range.cc, op-s-cm.cc,
op-s-cs.cc, op-s-m.cc, op-s-s.cc, op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc,
op-sbm-bm.cc, op-sbm-sbm.cc, op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc,
op-scm-s.cc, op-scm-scm.cc, op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc,
op-sm-s.cc, op-sm-scm.cc, op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc,
op-struct.cc, op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc,
ops.h, lex.ll, pt-assign.cc, pt-eval.cc, pt-idx.cc, pt-loop.cc, pt-mat.cc,
pt-stmt.cc, Array-util.cc, Array-util.h, Array.cc, CColVector.cc,
CDiagMatrix.cc, CMatrix.cc, CNDArray.cc, CRowVector.cc, CSparse.cc,
DiagArray2.cc, MDiagArray2.cc, MSparse.cc, PermMatrix.cc, Range.cc, Sparse.cc,
dColVector.cc, dDiagMatrix.cc, dMatrix.cc, dNDArray.cc, dRowVector.cc,
dSparse.cc, fCColVector.cc, fCDiagMatrix.cc, fCMatrix.cc, fCNDArray.cc,
fCRowVector.cc, fColVector.cc, fDiagMatrix.cc, fMatrix.cc, fNDArray.cc,
fRowVector.cc, idx-vector.cc, CmplxGEPBAL.cc, dbleGEPBAL.cc, fCmplxGEPBAL.cc,
floatGEPBAL.cc, Sparse-diag-op-defs.h, Sparse-op-defs.h, Sparse-perm-op-defs.h,
mx-inlines.cc, mx-op-defs.h, oct-binmap.h:
Replace 'include "gripes.h"' with 'include "errwarn.h". Change all gripe_XXX
to err_XXX or warn_XXX or errwarn_XXX.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 18 Jan 2016 18:28:06 -0800 |
| parents | 5e00ed38a58b |
| children | fcac5dbbf9ed |
| rev | line source |
|---|---|
| 5164 | 1 /* |
| 2 | |
|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19645
diff
changeset
|
3 Copyright (C) 2004-2015 David Bateman |
| 11523 | 4 Copyright (C) 1998-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 | |
|
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
15020
diff
changeset
|
28 #include "defun.h" |
| 5164 | 29 #include "ov.h" |
| 30 #include "pager.h" | |
| 31 #include "error.h" | |
|
21100
e39e05d90788
Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
Rik <rik@octave.org>
parents:
21055
diff
changeset
|
32 #include "errwarn.h" |
| 5164 | 33 |
| 34 #include "oct-spparms.h" | |
| 35 | |
|
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
15020
diff
changeset
|
36 DEFUN (spparms, args, nargout, |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
37 "-*- texinfo -*-\n\ |
|
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
38 @deftypefn {} { } spparms ()\n\ |
|
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
39 @deftypefnx {} {@var{vals} =} spparms ()\n\ |
|
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
40 @deftypefnx {} {[@var{keys}, @var{vals}] =} spparms ()\n\ |
|
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
41 @deftypefnx {} {@var{val} =} spparms (@var{key})\n\ |
|
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
42 @deftypefnx {} { } spparms (@var{vals})\n\ |
|
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
43 @deftypefnx {} { } spparms (\"default\")\n\ |
|
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
44 @deftypefnx {} { } spparms (\"tight\")\n\ |
|
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
45 @deftypefnx {} { } spparms (@var{key}, @var{val})\n\ |
|
11553
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
46 Query or set the parameters used by the sparse solvers and factorization\n\ |
|
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
47 functions.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
48 \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
49 The first four calls above get information about the current settings, while\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
50 the others change the current settings. The parameters are stored as pairs\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
51 of keys and values, where the values are all floats and the keys are one of\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
52 the following strings:\n\ |
| 5164 | 53 \n\ |
|
11553
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
54 @table @samp\n\ |
| 5164 | 55 @item spumoni\n\ |
| 56 Printing level of debugging information of the solvers (default 0)\n\ | |
| 10840 | 57 \n\ |
| 5164 | 58 @item ths_rel\n\ |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
59 Included for compatibility. Not used. (default 1)\n\ |
| 10840 | 60 \n\ |
| 5164 | 61 @item ths_abs\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 1)\n\ |
| 10840 | 63 \n\ |
| 5164 | 64 @item exact_d\n\ |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
65 Included for compatibility. Not used. (default 0)\n\ |
| 10840 | 66 \n\ |
| 5164 | 67 @item supernd\n\ |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
68 Included for compatibility. Not used. (default 3)\n\ |
| 10840 | 69 \n\ |
| 5164 | 70 @item rreduce\n\ |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
71 Included for compatibility. Not used. (default 3)\n\ |
| 10840 | 72 \n\ |
| 5164 | 73 @item wh_frac\n\ |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
74 Included for compatibility. Not used. (default 0.5)\n\ |
| 10840 | 75 \n\ |
| 5164 | 76 @item autommd\n\ |
| 77 Flag whether the LU/QR and the '\\' and '/' operators will automatically\n\ | |
| 78 use the sparsity preserving mmd functions (default 1)\n\ | |
| 10840 | 79 \n\ |
| 5164 | 80 @item autoamd\n\ |
| 81 Flag whether the LU and the '\\' and '/' operators will automatically\n\ | |
| 82 use the sparsity preserving amd functions (default 1)\n\ | |
| 10840 | 83 \n\ |
| 5164 | 84 @item piv_tol\n\ |
|
10711
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10155
diff
changeset
|
85 The pivot tolerance of the @sc{umfpack} solvers (default 0.1)\n\ |
| 10840 | 86 \n\ |
|
7515
f3c00dc0912b
Eliminate the rest of the dispatched sparse functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
87 @item sym_tol\n\ |
|
10711
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10155
diff
changeset
|
88 The pivot tolerance of the @sc{umfpack} symmetric solvers (default 0.001)\n\ |
| 10840 | 89 \n\ |
| 5164 | 90 @item bandden\n\ |
|
18812
9ac2357f19bc
doc: Replace "non-zero" with "nonzero" to match existing usage.
Rik <rik@octave.org>
parents:
18809
diff
changeset
|
91 The density of nonzero 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
|
92 by the @sc{lapack} banded solvers (default 0.5)\n\ |
| 10840 | 93 \n\ |
| 5164 | 94 @item umfpack\n\ |
|
10711
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10155
diff
changeset
|
95 Flag whether the @sc{umfpack} or mmd solvers are used for the LU, '\\' and\n\ |
| 5164 | 96 '/' operations (default 1)\n\ |
| 8828 | 97 @end table\n\ |
| 5164 | 98 \n\ |
|
11553
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
99 The value of individual keys can be set with\n\ |
|
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
100 @code{spparms (@var{key}, @var{val})}.\n\ |
|
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
101 The default values can be restored with the special keyword\n\ |
|
19332
eb20020f36b5
spparms.cc: accept "default" as argument instead of "defaults" (bug #43602)
Marco Vitetta <marcovitetta@gmail.com>
parents:
18812
diff
changeset
|
102 @qcode{\"default\"}. The special keyword @qcode{\"tight\"} can be used to\n\ |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
15195
diff
changeset
|
103 set the mmd solvers to attempt a sparser solution at the potential cost of\n\ |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
15195
diff
changeset
|
104 longer running time.\n\ |
|
18809
53af80da6781
doc: Update documentation of sparse functions including seealso links.
Rik <rik@octave.org>
parents:
17787
diff
changeset
|
105 @seealso{chol, colamd, lu, qr, symamd}\n\ |
| 5164 | 106 @end deftypefn") |
| 107 { | |
| 108 octave_value_list retval; | |
| 109 int nargin = args.length (); | |
| 110 | |
| 111 if (nargin == 0) | |
| 112 { | |
| 113 if (nargout == 0) | |
|
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
114 octave_sparse_params::print_info (octave_stdout, ""); |
| 5164 | 115 else if (nargout == 1) |
| 20892 | 116 retval = ovl (octave_sparse_params::get_vals ()); |
| 5164 | 117 else if (nargout == 2) |
| 20892 | 118 retval = ovl (octave_sparse_params::get_keys (), |
| 119 octave_sparse_params::get_vals ()); | |
| 5164 | 120 else |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
121 error ("spparms: too many output arguments"); |
| 5164 | 122 } |
| 123 else if (nargin == 1) | |
| 124 { | |
| 125 if (args(0).is_string ()) | |
|
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
126 { |
|
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
127 std::string str = args(0).string_value (); |
|
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
128 int len = str.length (); |
|
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
129 for (int i = 0; i < len; i++) |
|
15020
560317fd5977
maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents:
14844
diff
changeset
|
130 str[i] = tolower (str[i]); |
| 5164 | 131 |
|
19332
eb20020f36b5
spparms.cc: accept "default" as argument instead of "defaults" (bug #43602)
Marco Vitetta <marcovitetta@gmail.com>
parents:
18812
diff
changeset
|
132 if (str == "defaults" || str == "default") |
|
19333
bcec6f9d1596
spparms.cc: deprecate option "defaults" in favour of "default" (bug #43602)
Carnë Draug <carandraug@octave.org>
parents:
19332
diff
changeset
|
133 { |
|
19645
ebd27d8c63fd
update default branch to release as 4.0
John W. Eaton <jwe@octave.org>
parents:
19333
diff
changeset
|
134 // FIXME: deprecated in 4.0, remove "defaults" for 4.4 release |
|
19333
bcec6f9d1596
spparms.cc: deprecate option "defaults" in favour of "default" (bug #43602)
Carnë Draug <carandraug@octave.org>
parents:
19332
diff
changeset
|
135 static bool warned = false; |
|
bcec6f9d1596
spparms.cc: deprecate option "defaults" in favour of "default" (bug #43602)
Carnë Draug <carandraug@octave.org>
parents:
19332
diff
changeset
|
136 if (! warned && str == "defaults") |
|
bcec6f9d1596
spparms.cc: deprecate option "defaults" in favour of "default" (bug #43602)
Carnë Draug <carandraug@octave.org>
parents:
19332
diff
changeset
|
137 { |
|
bcec6f9d1596
spparms.cc: deprecate option "defaults" in favour of "default" (bug #43602)
Carnë Draug <carandraug@octave.org>
parents:
19332
diff
changeset
|
138 warning ("spparms: use \"default\" instead of \"defaults\""); |
|
bcec6f9d1596
spparms.cc: deprecate option "defaults" in favour of "default" (bug #43602)
Carnë Draug <carandraug@octave.org>
parents:
19332
diff
changeset
|
139 warned = true; |
|
bcec6f9d1596
spparms.cc: deprecate option "defaults" in favour of "default" (bug #43602)
Carnë Draug <carandraug@octave.org>
parents:
19332
diff
changeset
|
140 } |
|
bcec6f9d1596
spparms.cc: deprecate option "defaults" in favour of "default" (bug #43602)
Carnë Draug <carandraug@octave.org>
parents:
19332
diff
changeset
|
141 octave_sparse_params::defaults (); |
|
bcec6f9d1596
spparms.cc: deprecate option "defaults" in favour of "default" (bug #43602)
Carnë Draug <carandraug@octave.org>
parents:
19332
diff
changeset
|
142 } |
|
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
143 else if (str == "tight") |
|
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
144 octave_sparse_params::tight (); |
|
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
145 else |
|
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 double val = octave_sparse_params::get_key (str); |
|
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
148 if (xisnan (val)) |
|
13080
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
149 error ("spparms: KEY not recognized"); |
|
21055
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20955
diff
changeset
|
150 |
|
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20955
diff
changeset
|
151 retval = ovl (val); |
|
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
152 } |
|
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
153 } |
| 5164 | 154 else |
|
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
155 { |
|
20704
571508c1ed06
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
156 NDArray vals = args(0).xarray_value ("spparms: input must be a string or a vector"); |
|
571508c1ed06
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
157 if (vals.numel () > OCTAVE_SPARSE_CONTROLS_SIZE) |
|
13080
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
158 error ("spparms: too many elements in vector VALS"); |
|
21055
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20955
diff
changeset
|
159 |
|
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20955
diff
changeset
|
160 octave_sparse_params::set_vals (vals); |
|
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
161 } |
| 5164 | 162 } |
| 163 else if (nargin == 2) | |
| 164 { | |
|
20700
68e3a747ca02
rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents:
20582
diff
changeset
|
165 std::string str = args(0).xstring_value ("spparms: first argument must be a string"); |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
166 |
|
20704
571508c1ed06
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
167 double val = args(1).xdouble_value ("spparms: second argument must be a real scalar"); |
| 5164 | 168 |
|
20704
571508c1ed06
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
169 if (str == "umfpack") |
|
20582
ba2b07c13913
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20172
diff
changeset
|
170 warning ("spparms: request to disable umfpack solvers ignored"); |
|
20955
77f5591878bf
maint: Use '! expr' rather than '!expr' to conform to coding guidelines.
Rik <rik@octave.org>
parents:
20892
diff
changeset
|
171 else if (! octave_sparse_params::set_key (str, val)) |
|
20582
ba2b07c13913
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20172
diff
changeset
|
172 error ("spparms: KEY not found"); |
| 5164 | 173 } |
| 174 else | |
| 175 error ("spparms: too many input arguments"); | |
| 176 | |
| 177 return retval; | |
| 178 } | |
|
13080
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
179 |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
180 /* |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
181 %!test |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
182 %! old_vals = spparms (); # save state |
|
19332
eb20020f36b5
spparms.cc: accept "default" as argument instead of "defaults" (bug #43602)
Marco Vitetta <marcovitetta@gmail.com>
parents:
18812
diff
changeset
|
183 %! spparms ("default"); |
|
13080
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
184 %! vals = spparms (); |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
185 %! assert (vals, [0 1 1 0 3 3 0.5 1.0 1.0 0.1 0.5 1.0 0.001]'); |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
186 %! [keys, vals] = spparms (); |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
187 %! assert (rows (keys), 13); |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
188 %! assert (keys(2,:), "ths_rel"); |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
189 %! assert (vals, [0 1 1 0 3 3 0.5 1.0 1.0 0.1 0.5 1.0 0.001]'); |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
190 %! spparms ([3 2 1]); |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
191 %! assert (spparms ()(1:3), [3, 2, 1]'); |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
192 %! assert (spparms ("ths_rel"), 2); |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
193 %! spparms ("exact_d", 5); |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
194 %! assert (spparms ("exact_d"), 5); |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
195 %! spparms (old_vals); # restore state |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
196 |
|
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
197 %% Test input validation |
|
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
198 %!error <too many input arguments> spparms (1, 2, 3) |
|
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
199 %!error <too many output arguments> [x, y, z] = spparms () |
|
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
200 %!error <KEY not recognized> spparms ("UNKNOWN_KEY") |
|
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
201 %!#error <input must be a string> spparms ({1, 2, 3}) |
|
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
202 %!error spparms ({1, 2, 3}) |
|
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
203 %!error <too many elements in vector VALS> spparms (ones (14, 1)) |
|
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
204 %!error <first argument must be a string> spparms (1, 1) |
|
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
205 %!#error <second argument must be a real scalar> spparms ("ths_rel", "hello") |
|
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
206 %!error spparms ("ths_rel", "hello") |
|
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
207 %!error <KEY not found> spparms ("UNKNOWN_KEY", 1) |
|
13080
5f86bde27700
codesprint: Tests for spparms()
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
208 */ |