octave-nkf: src/DLD-FUNCTIONS/spparms.cc annotate

annotate src/DLD-FUNCTIONS/spparms.cc @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012

author	John W. Eaton <jwe@octave.org>
date	Mon, 02 Jan 2012 14:25:41 -0500
parents	de90542b7afc
children	8de863b7126b

rev	line source
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	1 /*
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	2
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 14022 diff changeset	3 Copyright (C) 2004-2012 David Bateman
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 10840 diff changeset	4 Copyright (C) 1998-2004 Andy Adler
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	5
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	6 This file is part of Octave.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	7
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	8 Octave is free software; you can redistribute it and/or modify it
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	9 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	11 option) any later version.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	12
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	13 Octave is distributed in the hope that it will be useful, but WITHOUT
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	16 for more details.
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	17
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	18 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	20 <http://www.gnu.org/licenses/>.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	21
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	22 */
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	23
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	24 #ifdef HAVE_CONFIG_H
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	25 #include <config.h>
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	26 #endif
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	27
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	28 #include "defun-dld.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	29 #include "ov.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	30 #include "pager.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	31 #include "error.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	32 #include "gripes.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	33
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	34 #include "oct-spparms.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	35
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	36 DEFUN_DLD (spparms, args, nargout,
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	37 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	38 @deftypefn {Loadable Function} { } spparms ()\n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	39 @deftypefnx {Loadable Function} {@var{vals} =} spparms ()\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	40 @deftypefnx {Loadable Function} {[@var{keys}, @var{vals}] =} spparms ()\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	41 @deftypefnx {Loadable Function} {@var{val} =} spparms (@var{key})\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	42 @deftypefnx {Loadable Function} { } spparms (@var{vals})\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	43 @deftypefnx {Loadable Function} { } spparms ('defaults')\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	44 @deftypefnx {Loadable Function} { } spparms ('tight')\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	45 @deftypefnx {Loadable Function} { } 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\
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 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	49 stored as pairs of keys and values, where the values are all floats and the\n\
8828 8463d1a2e544 Doc fixes. Brian Gough <bjg@network-theory.co.uk> parents: 7515 diff changeset	50 keys are one of the following strings:\n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	51 \n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	52 @table @samp\n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	53 @item spumoni\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	54 Printing level of debugging information of the solvers (default 0)\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	55 \n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	56 @item ths_rel\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	57 Included for compatibility. Not used. (default 1)\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	58 \n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	59 @item ths_abs\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 1)\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	61 \n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	62 @item exact_d\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	63 Included for compatibility. Not used. (default 0)\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	64 \n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	65 @item supernd\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 3)\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	67 \n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	68 @item rreduce\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	69 Included for compatibility. Not used. (default 3)\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	70 \n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	71 @item wh_frac\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	72 Included for compatibility. Not used. (default 0.5)\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	73 \n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	74 @item autommd\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	75 Flag whether the LU/QR and the '\\' and '/' operators will automatically\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	76 use the sparsity preserving mmd functions (default 1)\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	77 \n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	78 @item autoamd\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	79 Flag whether the LU and the '\\' and '/' operators will automatically\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	80 use the sparsity preserving amd functions (default 1)\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	81 \n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	82 @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	83 The pivot tolerance of the @sc{umfpack} solvers (default 0.1)\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	84 \n\
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	85 @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	86 The pivot tolerance of the @sc{umfpack} symmetric solvers (default 0.001)\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	87 \n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	88 @item bandden\n\
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	89 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	90 by the @sc{lapack} banded solvers (default 0.5)\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	91 \n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	92 @item umfpack\n\
10711 fbd7843974fa Periodic grammar check of documentation files to ensure common format. Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	93 Flag whether the @sc{umfpack} or mmd solvers are used for the LU, '\\' and\n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	94 '/' operations (default 1)\n\
8828 8463d1a2e544 Doc fixes. Brian Gough <bjg@network-theory.co.uk> parents: 7515 diff changeset	95 @end table\n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	96 \n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	97 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	98 @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	99 The default values can be restored with the special keyword\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	100 'defaults'. The special keyword 'tight' can be used to set the mmd solvers\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	101 to attempt a sparser solution at the potential cost of longer running\n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	102 time.\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	103 @end deftypefn")
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	104 {
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	105 octave_value_list retval;
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	106 int nargin = args.length ();
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	107
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	108 if (nargin == 0)
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	109 {
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	110 if (nargout == 0)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	111 octave_sparse_params::print_info (octave_stdout, "");
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	112 else if (nargout == 1)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	113 retval(0) = octave_sparse_params::get_vals ();
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	114 else if (nargout == 2)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	115 {
14022 de90542b7afc Return retval(1) before retval(0) to avoid re-sizing call on retval. Rik <octave@nomad.inbox5.com> parents: 13080 diff changeset	116 retval (1) = octave_sparse_params::get_vals ();
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	117 retval (0) = octave_sparse_params::get_keys ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	118 }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	119 else
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	120 error ("spparms: too many output arguments");
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	121 }
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	122 else if (nargin == 1)
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	123 {
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	124 if (args(0).is_string ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	125 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	126 std::string str = args(0).string_value ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	127 int len = str.length ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	128 for (int i = 0; i < len; i++)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	129 str [i] = tolower (str [i]);
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	130
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	131 if (str == "defaults")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	132 octave_sparse_params::defaults ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	133 else if (str == "tight")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	134 octave_sparse_params::tight ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	135 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	136 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	137 double val = octave_sparse_params::get_key (str);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	138 if (xisnan (val))
13080 5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	139 error ("spparms: KEY not recognized");
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	140 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	141 retval (0) = val;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	142 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	143 }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	144 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	145 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	146 NDArray vals = args(0).array_value ();
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	147
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	148 if (error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	149 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	150 else if (vals.numel () > OCTAVE_SPARSE_CONTROLS_SIZE)
13080 5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	151 error ("spparms: too many elements in vector VALS");
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	152 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	153 octave_sparse_params::set_vals (vals);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	154 }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	155 }
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	156 else if (nargin == 2)
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	157 {
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	158 if (args(0).is_string ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	159 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	160 std::string str = args(0).string_value ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	161
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	162 double val = args(1).double_value ();
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	163
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	164 if (error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	165 error ("spparms: second argument must be a real scalar");
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	166 else if (str == "umfpack")
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	167 warning ("spparms: request to disable umfpack solvers ignored");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	168 else if (!octave_sparse_params::set_key (str, val))
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	169 error ("spparms: KEY not found");
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	170 }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	171 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9209 diff changeset	172 error ("spparms: first argument must be a string");
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	173 }
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	174 else
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	175 error ("spparms: too many input arguments");
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	176
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	177 return retval;
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	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
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	182 %!test
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	183 %! old_vals = spparms (); # save state
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	184 %! spparms ("defaults");
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	185 %! vals = spparms ();
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	186 %! 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	187 %! [keys, vals] = spparms ();
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	188 %! assert (rows (keys), 13);
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	189 %! assert (keys(2,:), "ths_rel");
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	190 %! 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	191 %! spparms ([3 2 1]);
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	192 %! assert (spparms ()(1:3), [3, 2, 1]');
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	193 %! assert (spparms ("ths_rel"), 2);
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	194 %! spparms ("exact_d", 5);
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	195 %! assert (spparms ("exact_d"), 5);
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	196 %! spparms (old_vals); # restore state
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	197
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	198 %% Test input validation
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	199 %!error (spparms (1, 2, 3))
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	200 %!error ([x, y, z] = spparms ())
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	201 %!error (spparms ("UNKNOWN_KEY"))
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	202 %!error (spparms ({1, 2, 3}))
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	203 %!error (spparms (ones (14, 1)))
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	204 %!error (spparms (1, 1))
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	205 %!error (spparms ("ths_rel", "hello"))
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	206 %!error (spparms ("UNKNOWN_KEY", 1))
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	207
5f86bde27700 codesprint: Tests for spparms() Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	208 */

Mercurial > octave-nkf

annotate src/DLD-FUNCTIONS/spparms.cc @ 14138:72c96de7a403 stable