Mercurial > octave-nkf
view libinterp/corefcn/sqrtm.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 | 4197fc428c7d |
children | f90c8372b7ba |
line wrap: on
line source
/* Copyright (C) 2001-2015 Ross Lippert and Paul Kienzle Copyright (C) 2010 VZLU Prague 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 <float.h> #include "CmplxSCHUR.h" #include "fCmplxSCHUR.h" #include "lo-ieee.h" #include "lo-mappers.h" #include "oct-norm.h" #include "defun.h" #include "error.h" #include "gripes.h" #include "utils.h" #include "xnorm.h" template <class Matrix> static void sqrtm_utri_inplace (Matrix& T) { typedef typename Matrix::element_type element_type; const element_type zero = element_type (); bool singular = false; // The following code is equivalent to this triple loop: // // n = rows (T); // for j = 1:n // T(j,j) = sqrt (T(j,j)); // for i = j-1:-1:1 // T(i,j) /= (T(i,i) + T(j,j)); // k = 1:i-1; // T(k,j) -= T(k,i) * T(i,j); // endfor // endfor // // this is an in-place, cache-aligned variant of the code // given in Higham's paper. const octave_idx_type n = T.rows (); element_type *Tp = T.fortran_vec (); for (octave_idx_type j = 0; j < n; j++) { element_type *colj = Tp + n*j; if (colj[j] != zero) colj[j] = sqrt (colj[j]); else singular = true; for (octave_idx_type i = j-1; i >= 0; i--) { const element_type *coli = Tp + n*i; const element_type colji = colj[i] /= (coli[i] + colj[j]); for (octave_idx_type k = 0; k < i; k++) colj[k] -= coli[k] * colji; } } if (singular) warning_with_id ("Octave:sqrtm:SingularMatrix", "sqrtm: matrix is singular, may not have a square root"); } template <class Matrix, class ComplexMatrix, class ComplexSCHUR> static octave_value do_sqrtm (const octave_value& arg) { octave_value retval; MatrixType mt = arg.matrix_type (); bool iscomplex = arg.is_complex_type (); typedef typename Matrix::element_type real_type; real_type cutoff = 0; real_type one = 1; real_type eps = std::numeric_limits<real_type>::epsilon (); if (! iscomplex) { Matrix x = octave_value_extract<Matrix> (arg); if (mt.is_unknown ()) // if type is not known, compute it now. arg.matrix_type (mt = MatrixType (x)); switch (mt.type ()) { case MatrixType::Upper: case MatrixType::Diagonal: if (! x.diag ().any_element_is_negative ()) { // Do it in real arithmetic. sqrtm_utri_inplace (x); retval = x; retval.matrix_type (mt); } else iscomplex = true; break; case MatrixType::Lower: if (! x.diag ().any_element_is_negative ()) { x = x.transpose (); sqrtm_utri_inplace (x); retval = x.transpose (); retval.matrix_type (mt); } else iscomplex = true; break; default: iscomplex = true; break; } if (iscomplex) cutoff = 10 * x.rows () * eps * xnorm (x, one); } if (iscomplex) { ComplexMatrix x = octave_value_extract<ComplexMatrix> (arg); if (mt.is_unknown ()) // if type is not known, compute it now. arg.matrix_type (mt = MatrixType (x)); switch (mt.type ()) { case MatrixType::Upper: case MatrixType::Diagonal: sqrtm_utri_inplace (x); retval = x; retval.matrix_type (mt); break; case MatrixType::Lower: x = x.transpose (); sqrtm_utri_inplace (x); retval = x.transpose (); retval.matrix_type (mt); break; default: { ComplexMatrix u; do { ComplexSCHUR schur (x, std::string (), true); x = schur.schur_matrix (); u = schur.unitary_matrix (); } while (0); // schur no longer needed. sqrtm_utri_inplace (x); x = u * x; // original x no longer needed. ComplexMatrix res = xgemm (x, u, blas_no_trans, blas_conj_trans); if (cutoff > 0 && xnorm (imag (res), one) <= cutoff) retval = real (res); else retval = res; } break; } } return retval; } DEFUN (sqrtm, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{s} =} sqrtm (@var{A})\n\ @deftypefnx {Built-in Function} {[@var{s}, @var{error_estimate}] =} sqrtm (@var{A})\n\ Compute the matrix square root of the square matrix @var{A}.\n\ \n\ Ref: @nospell{N.J. Higham}. @cite{A New sqrtm for @sc{matlab}}. Numerical\n\ Analysis Report No. 336, Manchester @nospell{Centre} for Computational\n\ Mathematics, Manchester, England, January 1999.\n\ @seealso{expm, logm}\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 n = arg.rows (); octave_idx_type nc = arg.columns (); if (n != nc || arg.ndims () > 2) { gripe_square_matrix_required ("sqrtm"); return retval; } if (nargout > 1) { retval.resize (1, 2); retval(2) = -1.0; } if (arg.is_diag_matrix ()) // sqrtm of a diagonal matrix is just sqrt. retval(0) = arg.sqrt (); else if (arg.is_single_type ()) retval(0) = do_sqrtm<FloatMatrix, FloatComplexMatrix, FloatComplexSCHUR> (arg); else if (arg.is_numeric_type ()) retval(0) = do_sqrtm<Matrix, ComplexMatrix, ComplexSCHUR> (arg); if (nargout > 1 && ! error_state) { // This corresponds to generic code // // norm (s*s - x, "fro") / norm (x, "fro"); octave_value s = retval(0); retval(1) = xfrobnorm (s*s - arg) / xfrobnorm (arg); } return retval; } /* %!assert (sqrtm (2*ones (2)), ones (2), 3*eps) ## The following two tests are from the reference in the docstring above. %!test %! x = [0 1; 0 0]; %! assert (any (isnan (sqrtm (x))(:))); %!test %! x = eye (4); x(2,2) = x(3,3) = 2^-26; x(1,4) = 1; %! z = eye (4); z(2,2) = z(3,3) = 2^-13; z(1,4) = 0.5; %! [y, err] = sqrtm (x); %! assert (y, z); %! assert (err, 0); # Yes, this one has to hold exactly */