Mercurial > octave-nkf
view libinterp/corefcn/inv.cc @ 20569:b70cc4bd8109
begin removal of global error_state variable
* gripes.h, gripes.cc (gripe_library_execution_error): Delete.
* error.cc (warning_state): Delete unused variable.
(reset_error_handler): Don't set warning_state or error_state.
(debug_or_throw_exception): New static function.
(verror): Don't check error_state.
(vmessage): Call debug_or_throw_exception instead of setting
error_state.
(error_1, error_2): Combine into single function, error_1 that prints
error message and ultimately calls debug_or_throw_exception.
(verror, verror_with_cfn, verror_with_id_cfn): Call error_1. Don't
check or set warning_state.
(error): Don't check error_state.
(Flasterror, Flasterr): Adapt to not using error_state.
(interpreter_try): Don't unwind_protect error_state.
* NEWS: Update.
* doc/interpreter/external.txi: Explain octave_execution_exception
instead of error_state for matrix addition example.
* jit-typeinfo.cc (octave_jit_gripe_nan_to_logical_conversion,
octave_jit_ginvalid_index, octave_jit_gindex_range,
octave_jit_paren_scalar, octave_jit_paren_scalar_subsasgn):
Don't catch octave_execution_exception.
* cellfun.cc (Fcellfun): Use exceptions instead of error_state.
* ls-mat-ascii.cc (save_mat_ascii_data): Likewise.
* mex.cc (mexCallMATLAB, mexEvalString): Likewise.
* variables.cc (safe_symbol_lookup): Likewise.
* svd.cc (Fsvd): Eliminate use of error_state.
* __magick_read__.cc (read_file, write_file): Likewise.
* variables.cc (generate_struct_completions): Eliminate use of
obsolete warning_state variable.
* ov-builtin.cc (octave_builtin::do_multi_index_op): Don't catch
octave_execution_exception and call gripe_library_execution_error.
* ov-class.cc (octave_class::reconstruct_exemplar): Eliminate use of
error_state. Catch possible octave_execution_exception in
do_multi_index_op.
* ov-mex-fcn.cc (octave_mex_function::do_multi_index_op): Eliminate
use of error_state. Catch possible octave_execution_exception in
call_mex.
* ov-fcn-handle.cc (octave_fcn_binder::maybe_binder): Eliminate use of
error_state.
* ov-oncleanup.cc (octave_oncleanup::~octave_oncleanup): Eliminate use
of error_state. Propagate possible octave_execution_exception from
do_multi_index_op.
* ov.cc (octave_value::assign, do_binary_op, do_unary_op,
octave_value::do_non_const_unary_op): Don't catch
octave_execution_exception here.
* oct-parse.in.yy (octave_base_parser::finish_colon_expression,
octave_base_parser::finish_array_list): Eliminate use of warning_state
and error_state.
(Feval, Fevalin): Use exceptions instead of error_state.
* pt-eval.cc, pt-eval.h (tree_evaluator::unwind_protect_exception):
New static variable.
* (tree_evaluator::visit_statement): Don't catch
octave_execution_exception here.
(tree_evaluator::visit_try_catch_command,
tree_evaluator::do_unwind_protect_cleanup): Eliminate use of error_state.
(tree_evaluator::visit_unwind_protect_command): Use
unwind_protect_exception to track whether an exception has occurred in
the try block.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 01 Oct 2015 16:18:19 -0400 |
parents | 4f45eaf83908 |
children |
line wrap: on
line source
/* Copyright (C) 1996-2015 John W. Eaton This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include "defun.h" #include "error.h" #include "gripes.h" #include "oct-obj.h" #include "ops.h" #include "ov-re-diag.h" #include "ov-cx-diag.h" #include "ov-flt-re-diag.h" #include "ov-flt-cx-diag.h" #include "ov-perm.h" #include "utils.h" DEFUN (inv, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{x} =} inv (@var{A})\n\ @deftypefnx {Built-in Function} {[@var{x}, @var{rcond}] =} inv (@var{A})\n\ Compute the inverse of the square matrix @var{A}.\n\ \n\ Return an estimate of the reciprocal condition number if requested,\n\ otherwise warn of an ill-conditioned matrix if the reciprocal condition\n\ number is small.\n\ \n\ In general it is best to avoid calculating the inverse of a matrix directly.\n\ For example, it is both faster and more accurate to solve systems of\n\ equations (@var{A}*@math{x} = @math{b}) with\n\ @code{@var{y} = @var{A} \\ @math{b}}, rather than\n\ @code{@var{y} = inv (@var{A}) * @math{b}}.\n\ \n\ If called with a sparse matrix, then in general @var{x} will be a full\n\ matrix requiring significantly more storage. Avoid forming the inverse of a\n\ sparse matrix if possible.\n\ @seealso{ldivide, rdivide}\n\ @end deftypefn") { octave_value_list retval; int nargin = args.length (); if (nargin != 1) { print_usage (); return retval; } octave_value arg = args(0); octave_idx_type nr = arg.rows (); octave_idx_type nc = arg.columns (); int arg_is_empty = empty_arg ("inverse", nr, nc); if (arg_is_empty < 0) return retval; else if (arg_is_empty > 0) return octave_value (Matrix ()); if (nr != nc) { gripe_square_matrix_required ("inverse"); return retval; } octave_value result; octave_idx_type info; double rcond = 0.0; float frcond = 0.0; bool isfloat = arg.is_single_type (); if (arg.is_diag_matrix ()) { rcond = 1.0; frcond = 1.0f; if (arg.is_complex_type ()) { if (isfloat) { result = arg.float_complex_diag_matrix_value ().inverse (info); if (nargout > 1) frcond = arg.float_complex_diag_matrix_value ().rcond (); } else { result = arg.complex_diag_matrix_value ().inverse (info); if (nargout > 1) rcond = arg.complex_diag_matrix_value ().rcond (); } } else { if (isfloat) { result = arg.float_diag_matrix_value ().inverse (info); if (nargout > 1) frcond = arg.float_diag_matrix_value ().rcond (); } else { result = arg.diag_matrix_value ().inverse (info); if (nargout > 1) rcond = arg.diag_matrix_value ().rcond (); } } } else if (arg.is_perm_matrix ()) { rcond = 1.0; info = 0; result = arg.perm_matrix_value ().inverse (); } else if (isfloat) { if (arg.is_real_type ()) { FloatMatrix m = arg.float_matrix_value (); if (! error_state) { MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, frcond, 1); args(0).matrix_type (mattyp); } } else if (arg.is_complex_type ()) { FloatComplexMatrix m = arg.float_complex_matrix_value (); if (! error_state) { MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, frcond, 1); args(0).matrix_type (mattyp); } } } else { if (arg.is_real_type ()) { if (arg.is_sparse_type ()) { SparseMatrix m = arg.sparse_matrix_value (); if (! error_state) { MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, rcond, 1); args(0).matrix_type (mattyp); } } else { Matrix m = arg.matrix_value (); if (! error_state) { MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, rcond, 1); args(0).matrix_type (mattyp); } } } else if (arg.is_complex_type ()) { if (arg.is_sparse_type ()) { SparseComplexMatrix m = arg.sparse_complex_matrix_value (); if (! error_state) { MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, rcond, 1); args(0).matrix_type (mattyp); } } else { ComplexMatrix m = arg.complex_matrix_value (); if (! error_state) { MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, rcond, 1); args(0).matrix_type (mattyp); } } } else gripe_wrong_type_arg ("inv", arg); } if (! error_state) { if (nargout > 1) retval(1) = isfloat ? octave_value (frcond) : octave_value (rcond); retval(0) = result; bool rcond_plus_one_eq_one = false; if (isfloat) { volatile float xrcond = frcond; rcond_plus_one_eq_one = xrcond + 1.0F == 1.0F; } else { volatile double xrcond = rcond; rcond_plus_one_eq_one = xrcond + 1.0 == 1.0; } if (nargout < 2 && (info == -1 || rcond_plus_one_eq_one)) gripe_singular_matrix (isfloat ? frcond : rcond); } return retval; } /* %!assert (inv ([1, 2; 3, 4]), [-2, 1; 1.5, -0.5], sqrt (eps)) %!assert (inv (single ([1, 2; 3, 4])), single ([-2, 1; 1.5, -0.5]), sqrt (eps ("single"))) %!error inv () %!error inv ([1, 2; 3, 4], 2) %!error <argument must be a square matrix> inv ([1, 2; 3, 4; 5, 6]) %!test %! [xinv, rcond] = inv (single ([1,2;3,4])); %! assert (isa (xinv, 'single')); %! assert (isa (rcond, 'single')); %!test %! [xinv, rcond] = inv ([1,2;3,4]); %! assert (isa (xinv, 'double')); %! assert (isa (rcond, 'double')); */ // FIXME: this should really be done with an alias, but // alias_builtin() won't do the right thing if we are actually using // dynamic linking. DEFUN (inverse, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{x} =} inverse (@var{A})\n\ @deftypefnx {Built-in Function} {[@var{x}, @var{rcond}] =} inverse (@var{A})\n\ Compute the inverse of the square matrix @var{A}.\n\ \n\ This is an alias for @code{inv}.\n\ @seealso{inv}\n\ @end deftypefn") { return Finv (args, nargout); }