#include "defun-dld.h"#include "ov.h"#include "pager.h"#include "error.h"#include "gripes.h"#include "oct-spparms.h"
Go to the source code of this file.
Functions | |
| DEFUN_DLD (spparms, args, nargout,"-*- texinfo -*-\n\ @deftypefn {Loadable Function} { } spparms ()\n\ @deftypefnx {Loadable Function} {@var{vals} =} spparms ()\n\ @deftypefnx {Loadable Function} {[@var{keys}, @var{vals}] =} spparms ()\n\ @deftypefnx {Loadable Function} {@var{val} =} spparms (@var{key})\n\ @deftypefnx {Loadable Function} { } spparms (@var{vals})\n\ @deftypefnx {Loadable Function} { } spparms ('defaults')\n\ @deftypefnx {Loadable Function} { } spparms ('tight')\n\ @deftypefnx {Loadable Function} { } spparms (@var{key}, @var{val})\n\ Query or set the parameters used by the sparse solvers and factorization\n\ functions. The first four calls above get information about the current\n\ settings, while the others change the current settings. The parameters are\n\ stored as pairs of keys and values, where the values are all floats and the\n\ keys are one of the following strings:\n\ \n\ @table @samp\n\ @item spumoni\n\ Printing level of debugging information of the solvers (default 0)\n\ \n\ @item ths_rel\n\ Included for compatibility. Not used. (default 1)\n\ \n\ @item ths_abs\n\ Included for compatibility. Not used. (default 1)\n\ \n\ @item exact_d\n\ Included for compatibility. Not used. (default 0)\n\ \n\ @item supernd\n\ Included for compatibility. Not used. (default 3)\n\ \n\ @item rreduce\n\ Included for compatibility. Not used. (default 3)\n\ \n\ @item wh_frac\n\ Included for compatibility. Not used. (default 0.5)\n\ \n\ @item autommd\n\ Flag whether the LU/QR and the '\\' and '/' operators will automatically\n\ use the sparsity preserving mmd functions (default 1)\n\ \n\ @item autoamd\n\ Flag whether the LU and the '\\' and '/' operators will automatically\n\ use the sparsity preserving amd functions (default 1)\n\ \n\ @item piv_tol\n\ The pivot tolerance of the @sc{umfpack} solvers (default 0.1)\n\ \n\ @item sym_tol\n\ The pivot tolerance of the @sc{umfpack} symmetric solvers (default 0.001)\n\ \n\ @item bandden\n\ The density of non-zero elements in a banded matrix before it is treated\n\ by the @sc{lapack} banded solvers (default 0.5)\n\ \n\ @item umfpack\n\ Flag whether the @sc{umfpack} or mmd solvers are used for the LU, '\\' and\n\ '/' operations (default 1)\n\ @end table\n\ \n\ The value of individual keys can be set with\n\ @code{spparms (@var{key}, @var{val})}.\n\ The default values can be restored with the special keyword\n\ 'defaults'. The special keyword 'tight' can be used to set the mmd solvers\n\ to attempt a sparser solution at the potential cost of longer running\n\ time.\n\ @end deftypefn") | |
| DEFUN_DLD | ( | spparms | , | |
| args | , | |||
| nargout | ||||
| ) |
Definition at line 36 of file spparms.cc.
References octave_sparse_params::defaults(), error(), error_state, octave_sparse_params::get_key(), octave_sparse_params::get_keys(), octave_sparse_params::get_vals(), Array< T >::numel(), octave_stdout, octave_sparse_params::print_info(), octave_sparse_params::set_key(), octave_sparse_params::set_vals(), octave_sparse_params::tight(), warning(), and xisnan().
1.7.1