octave: libinterp/corefcn/inv.cc annotate

annotate libinterp/corefcn/inv.cc @ 30554:117ebe363f56 stable

Fix handling of scalar exceptional values in inv() (bug #61689) * inv.cc (Finv): Pass "true" rather than '1' to inverse() function to match 'bool' argument. Pass 5th argument of true to inverse() to force calculation of condition number. Rename variable "rcond_plus_one_eq_one" to "is_singular" for clarity. Use isnan() to also catch singular matrices with NaN as reciprocal condition number. Don't emit warning for inverse of a scalar which thereby matches '/' and '\' operators. Add many BIST tests for various exceptional value inputs. * CMatrix.cc, dMatrix.cc, fCMatrix.cc, fMatrix.cc (inverse): Expand if conditional for MatrixType::Diagonal to check input parameter "calc_cond" and use an if/else tree to determine the reciprocal condition number (rcond) for a scalar.

author	Rik <rik@octave.org>
date	Sat, 25 Dec 2021 19:16:44 -0800
parents	98400baa509f
children	72cea722ca21 796f54d4ddbf

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
29358 0a5b15007766 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	3 // Copyright (C) 1996-2021 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	25
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	26 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	27 # include "config.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	28 #endif
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	29
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	30 #include "defun.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	31 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21024 diff changeset	32 #include "errwarn.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20898 diff changeset	33 #include "ovl.h"
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	34 #include "ops.h"
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	35 #include "ov-re-diag.h"
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	36 #include "ov-cx-diag.h"
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	37 #include "ov-flt-re-diag.h"
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	38 #include "ov-flt-cx-diag.h"
8371 c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	39 #include "ov-perm.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	40
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	41 OCTAVE_NAMESPACE_BEGIN
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	42
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	43 DEFUN (inv, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	44 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	45 @deftypefn {} {@var{x} =} inv (@var{A})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	46 @deftypefnx {} {[@var{x}, @var{rcond}] =} inv (@var{A})
27253 7f5008aec7a1 doc: Add function index entry for alias "inverse" bug #56629). Rik <rik@octave.org> parents: 26376 diff changeset	47 @deftypefnx {} {[@dots{}] =} inverse (@dots{})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	48 Compute the inverse of the square matrix @var{A}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	49
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	50 Return an estimate of the reciprocal condition number if requested,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	51 otherwise warn of an ill-conditioned matrix if the reciprocal condition
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	52 number is small.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	53
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	54 In general it is best to avoid calculating the inverse of a matrix directly.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	55 For example, it is both faster and more accurate to solve systems of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	56 equations (@var{A}*@math{x} = @math{b}) with
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	57 @code{@var{y} = @var{A} \ @math{b}}, rather than
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	58 @code{@var{y} = inv (@var{A}) * @math{b}}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	59
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	60 If called with a sparse matrix, then in general @var{x} will be a full
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	61 matrix requiring significantly more storage. Avoid forming the inverse of a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	62 sparse matrix if possible.
27253 7f5008aec7a1 doc: Add function index entry for alias "inverse" bug #56629). Rik <rik@octave.org> parents: 26376 diff changeset	63
7f5008aec7a1 doc: Add function index entry for alias "inverse" bug #56629). Rik <rik@octave.org> parents: 26376 diff changeset	64 @code{inverse} is an alias and may be used identically in place of @code{inv}.
24197 63fc7a75a3d7 doc: Update docstring for pinv and inv. Rik <rik@octave.org> parents: 23219 diff changeset	65 @seealso{ldivide, rdivide, pinv}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	66 @end deftypefn */)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	67 {
20819 f428cbe7576f eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20802 diff changeset	68 if (args.length () != 1)
20802 8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20678 diff changeset	69 print_usage ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	70
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	71 octave_value arg = args(0);
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	72
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23453 diff changeset	73 if (arg.isempty ())
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21112 diff changeset	74 return ovl (Matrix ());
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	75
22372 0c0de2205d38 utils.h: deprecated out of date arg_is_empty function. Carnë Draug <carandraug@octave.org> parents: 22327 diff changeset	76 if (arg.rows () != arg.columns ())
21110 3d0d84305600 Use err_square_matrix_required more widely. Rik <rik@octave.org> parents: 21100 diff changeset	77 err_square_matrix_required ("inverse", "A");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	78
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	79 octave_value result;
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	80 octave_idx_type info;
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	81 double rcond = 0.0;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7650 diff changeset	82 float frcond = 0.0;
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7650 diff changeset	83 bool isfloat = arg.is_single_type ();
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7650 diff changeset	84
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	85 if (arg.is_diag_matrix ())
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	86 {
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	87 rcond = 1.0;
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	88 frcond = 1.0f;
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23577 diff changeset	89 if (arg.iscomplex ())
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	90 {
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	91 if (isfloat)
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	92 {
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	93 result = arg.float_complex_diag_matrix_value ().inverse (info);
27093 6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	94 if (info == -1)
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	95 frcond = 0.0f;
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	96 else if (nargout > 1)
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	97 frcond = arg.float_complex_diag_matrix_value ().rcond ();
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	98 }
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	99 else
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	100 {
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	101 result = arg.complex_diag_matrix_value ().inverse (info);
27093 6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	102 if (info == -1)
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	103 rcond = 0.0;
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	104 else if (nargout > 1)
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	105 rcond = arg.complex_diag_matrix_value ().rcond ();
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	106 }
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	107 }
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	108 else
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	109 {
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	110 if (isfloat)
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	111 {
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	112 result = arg.float_diag_matrix_value ().inverse (info);
27093 6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	113 if (info == -1)
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	114 frcond = 0.0f;
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	115 else if (nargout > 1)
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	116 frcond = arg.float_diag_matrix_value ().rcond ();
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	117 }
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	118 else
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	119 {
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	120 result = arg.diag_matrix_value ().inverse (info);
27093 6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	121 if (info == -1)
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	122 rcond = 0.0;
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	123 else if (nargout > 1)
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	124 rcond = arg.diag_matrix_value ().rcond ();
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	125 }
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	126 }
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	127 }
8371 c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	128 else if (arg.is_perm_matrix ())
c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	129 {
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	130 info = 0;
8371 c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	131 rcond = 1.0;
8960 93f18f166aba remove float perm matrices Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	132 result = arg.perm_matrix_value ().inverse ();
8371 c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	133 }
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	134 else if (isfloat)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	135 {
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	136 if (arg.isreal ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	137 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	138 FloatMatrix m = arg.float_matrix_value ();
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	139
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	140 MatrixType mattyp = args(0).matrix_type ();
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	141 result = m.inverse (mattyp, info, frcond, true, true);
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	142 args(0).matrix_type (mattyp);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	143 }
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23577 diff changeset	144 else if (arg.iscomplex ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	145 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	146 FloatComplexMatrix m = arg.float_complex_matrix_value ();
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	147
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	148 MatrixType mattyp = args(0).matrix_type ();
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	149 result = m.inverse (mattyp, info, frcond, true, true);
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	150 args(0).matrix_type (mattyp);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	151 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	152 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7650 diff changeset	153 else
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	154 {
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	155 if (arg.isreal ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	156 {
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	157 if (arg.issparse ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	158 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	159 SparseMatrix m = arg.sparse_matrix_value ();
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	160
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	161 MatrixType mattyp = args(0).matrix_type ();
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	162 result = m.inverse (mattyp, info, rcond, true, true);
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	163 args(0).matrix_type (mattyp);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	164 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	165 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	166 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	167 Matrix m = arg.matrix_value ();
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	168
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	169 MatrixType mattyp = args(0).matrix_type ();
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	170 result = m.inverse (mattyp, info, rcond, true, true);
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	171 args(0).matrix_type (mattyp);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	172 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	173 }
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23577 diff changeset	174 else if (arg.iscomplex ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	175 {
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23582 diff changeset	176 if (arg.issparse ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	177 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	178 SparseComplexMatrix m = arg.sparse_complex_matrix_value ();
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	179
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	180 MatrixType mattyp = args(0).matrix_type ();
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	181 result = m.inverse (mattyp, info, rcond, true, true);
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	182 args(0).matrix_type (mattyp);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	183 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	184 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	185 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	186 ComplexMatrix m = arg.complex_matrix_value ();
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	187
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	188 MatrixType mattyp = args(0).matrix_type ();
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	189 result = m.inverse (mattyp, info, rcond, true, true);
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	190 args(0).matrix_type (mattyp);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	191 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	192 }
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	193 else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21024 diff changeset	194 err_wrong_type_arg ("inv", arg);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	195 }
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	196
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20892 diff changeset	197 octave_value_list retval (nargout > 1 ? 2 : 1);
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20892 diff changeset	198
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20892 diff changeset	199 retval(0) = result;
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	200 if (nargout > 1)
23450 855122b993da maint: Wrap tertiary operator in parentheses "(COND ? x : y)". Rik <rik@octave.org> parents: 23220 diff changeset	201 retval(1) = (isfloat ? octave_value (frcond) : octave_value (rcond));
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	202
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	203 if (nargout < 2)
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	204 {
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	205 bool is_singular;
18243 36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	206
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	207 if (isfloat)
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	208 is_singular = ((frcond + 1.0f == 1.0f) \|\| octave::math::isnan (frcond))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	209 && ! arg.is_scalar_type ();
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	210 else
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	211 is_singular = ((rcond + 1.0 == 1.0) \|\| octave::math::isnan (rcond))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	212 && ! arg.is_scalar_type ();
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	213
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	214 if (info == -1 \|\| is_singular)
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	215 warn_singular_matrix (isfloat ? frcond : rcond);
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	216 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	217
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	218 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	219 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	220
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	221 /*
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	222 ## Basic test for double/single matrices
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	223 %!assert (inv ([1, 2; 3, 4]), [-2, 1; 1.5, -0.5], 5*eps)
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	224 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	225 %! [xinv, rcond] = inv ([1,2;3,4]);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	226 %! assert (xinv, [-2, 1; 1.5, -0.5], 5*eps);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	227 %! assert (isa (rcond, "double"));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	228
30313 98400baa509f Return Inf for inv(0) for compatibility with division operator and Matlab (bug #52285). Rik <rik@octave.org> parents: 29961 diff changeset	229 %!assert (inv (single ([1, 2; 3, 4])), single ([-2, 1; 1.5, -0.5]),
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	230 %! 5*eps ("single"))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	231 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	232 %! [xinv, rcond] = inv (single ([1,2;3,4]));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	233 %! assert (xinv, single ([-2, 1; 1.5, -0.5]), 5*eps ("single"));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	234 %! assert (isa (rcond, "single"));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	235
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	236 ## Normal scalar cases
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	237 %!assert (inv (2), 0.5)
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	238 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	239 %! [xinv, rcond] = inv (2);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	240 %! assert (xinv, 0.5);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	241 %! assert (rcond, 1);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	242 %!assert (inv (single (2)), single (0.5))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	243 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	244 %! [xinv, rcond] = inv (single (2));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	245 %! assert (xinv, single (0.5));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	246 %! assert (rcond, single (1));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	247 %!assert (inv (complex (1, -1)), 0.5+0.5i)
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	248 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	249 %! [xinv, rcond] = inv (complex (1, -1));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	250 %! assert (xinv, 0.5+0.5i);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	251 %! assert (rcond, 1);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	252 %!assert (inv (complex (single (1), -1)), single (0.5+0.5i))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	253 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	254 %! [xinv, rcond] = inv (complex (single (1), -1));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	255 %! assert (xinv, single (0.5+0.5i));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	256 %! assert (rcond, single (1));
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	257
22849 1d242ae72240 Return 0 for special case of scalar Inf input to inverse (bug #49690). Rik <rik@octave.org> parents: 22755 diff changeset	258 ## Test special inputs
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	259 ## Empty matrix
22849 1d242ae72240 Return 0 for special case of scalar Inf input to inverse (bug #49690). Rik <rik@octave.org> parents: 22755 diff changeset	260 %!assert (inv (zeros (2,0)), [])
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	261
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	262 ## Scalar "0"
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	263 %!assert (inv (0), Inf)
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	264 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	265 %! [xinv, rcond] = inv (0);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	266 %! assert (xinv, Inf);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	267 %! assert (rcond, 0);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	268 %!assert (inv (single (0)), single (Inf))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	269 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	270 %! [xinv, rcond] = inv (single (0));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	271 %! assert (xinv, single (Inf));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	272 %! assert (rcond, single (0));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	273 %!assert (inv (complex (0, 0)), Inf)
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	274 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	275 %! [xinv, rcond] = inv (complex (0, 0));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	276 %! assert (xinv, Inf);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	277 %! assert (rcond, 0);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	278 %!assert (inv (complex (single (0), 0)), single (Inf))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	279 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	280 %! [xinv, rcond] = inv (complex (single (0), 0));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	281 %! assert (xinv, single (Inf));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	282 %! assert (rcond, single (0));
30313 98400baa509f Return Inf for inv(0) for compatibility with division operator and Matlab (bug #52285). Rik <rik@octave.org> parents: 29961 diff changeset	283 ## NOTE: Matlab returns +Inf for -0 input, but it returns -Inf for 1/-0.
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	284 ## These should be the same, and in Octave they are.
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	285 %!assert (inv (-0), -Inf)
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	286 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	287 %! [xinv, rcond] = inv (-0);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	288 %! assert (xinv, -Inf);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	289 %! assert (rcond, 0);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	290
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	291 ## Scalar "Inf"
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	292 %!assert (inv (Inf), 0)
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	293 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	294 %! [xinv, rcond] = inv (Inf);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	295 %! assert (xinv, 0);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	296 %! assert (rcond, 0);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	297 %!assert (inv (single (Inf)), single (0))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	298 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	299 %! [xinv, rcond] = inv (single (Inf));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	300 %! assert (xinv, single (0));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	301 %! assert (rcond, single (0));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	302 %!assert (inv (complex (1, Inf)), 0)
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	303 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	304 %! [xinv, rcond] = inv (complex (1, Inf));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	305 %! assert (xinv, 0);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	306 %! assert (rcond, 0);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	307 %!assert (inv (complex (single (1), Inf)), single (0))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	308 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	309 %! [xinv, rcond] = inv (complex (single (1), Inf));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	310 %! assert (xinv, single (0));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	311 %! assert (rcond, single (0));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	312
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	313 ## Scalar "NaN"
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	314 %!assert (inv (NaN), NaN)
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	315 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	316 %! [xinv, rcond] = inv (NaN);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	317 %! assert (xinv, NaN);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	318 %! assert (rcond, NaN);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	319 %!assert (inv (single (NaN)), single (NaN))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	320 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	321 %! [xinv, rcond] = inv (single (NaN));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	322 %! assert (xinv, single (NaN));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	323 %! assert (rcond, single (NaN));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	324 %!assert (inv (complex (1, NaN)), complex (NaN, NaN))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	325 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	326 %! [xinv, rcond] = inv (complex (1, NaN));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	327 %! assert (xinv, complex (NaN, NaN));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	328 %! assert (rcond, NaN);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	329 %!assert (inv (complex (single (1), NaN)), complex (single (NaN), NaN))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	330 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	331 %! [xinv, rcond] = inv (complex (single (1), NaN));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	332 %! assert (xinv, complex (single (NaN), NaN));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	333 %! assert (rcond, single (NaN));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	334
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	335 ## Matrix special values
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	336 ## Matrix of all zeroes
30313 98400baa509f Return Inf for inv(0) for compatibility with division operator and Matlab (bug #52285). Rik <rik@octave.org> parents: 29961 diff changeset	337 %!warning <matrix singular> assert (inv (zeros (2,2)), Inf (2,2))
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	338 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	339 %! [xinv, rcond] = inv (zeros (2,2));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	340 %! assert (xinv, Inf (2,2));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	341 %! assert (rcond, 0);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	342 ## Matrix of all Inf
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	343 %!warning <rcond = > assert (inv (Inf (2,2)), NaN (2,2))
22849 1d242ae72240 Return 0 for special case of scalar Inf input to inverse (bug #49690). Rik <rik@octave.org> parents: 22755 diff changeset	344 %!test
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	345 %! [xinv, rcond] = inv (Inf (2,2));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	346 %! assert (xinv, NaN (2,2));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	347 %! assert (rcond, NaN);
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	348 ## Matrix of all NaN
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	349 %!warning <rcond = > assert (inv (NaN (2,2)), NaN (2,2))
22849 1d242ae72240 Return 0 for special case of scalar Inf input to inverse (bug #49690). Rik <rik@octave.org> parents: 22755 diff changeset	350 %!test
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	351 %! [xinv, rcond] = inv (NaN (2,2));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	352 %! assert (xinv, NaN (2,2));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	353 %! assert (rcond, NaN);
22849 1d242ae72240 Return 0 for special case of scalar Inf input to inverse (bug #49690). Rik <rik@octave.org> parents: 22755 diff changeset	354
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	355 ## Special diagonal matrices
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	356 %!test
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	357 %! fail ("A = inv (diag ([1, 0, 1]))", "warning", "matrix singular");
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	358 %! assert (A, diag ([Inf, Inf, Inf]));
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	359
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	360 ## Special sparse matrices
27122 d0d176ac575d make new tests for inv of singular sparse matrices conditional on HAVE_UMFPACK John W. Eaton <jwe@octave.org> parents: 27093 diff changeset	361 %!testif HAVE_UMFPACK <*56232>
27093 6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	362 %! fail ("A = inv (sparse ([1, 2;0 ,0]))", "warning", "matrix singular");
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	363 %! assert (A, sparse ([Inf, Inf; 0, 0]));
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	364
27122 d0d176ac575d make new tests for inv of singular sparse matrices conditional on HAVE_UMFPACK John W. Eaton <jwe@octave.org> parents: 27093 diff changeset	365 %!testif HAVE_UMFPACK <*56232>
27093 6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	366 %! fail ("A = inv (sparse ([1i, 2;0 ,0]))", "warning", "matrix singular");
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	367 %! assert (A, sparse ([Inf, Inf; 0, 0]));
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	368
27122 d0d176ac575d make new tests for inv of singular sparse matrices conditional on HAVE_UMFPACK John W. Eaton <jwe@octave.org> parents: 27093 diff changeset	369 %!testif HAVE_UMFPACK <*56232>
27093 6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	370 %! fail ("A = inv (sparse ([1, 0, 0; 0, 0, 0; 0, 0, 1]))", "warning", "matrix singular");
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	371 %! assert (A, sparse ([Inf, 0, 0; 0, 0, 0; 0, 0, Inf]));
6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	372
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	373 %!error inv ()
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	374 %!error inv ([1, 2; 3, 4], 2)
21110 3d0d84305600 Use err_square_matrix_required more widely. Rik <rik@octave.org> parents: 21100 diff changeset	375 %!error <must be a square matrix> inv ([1, 2; 3, 4; 5, 6])
27093 6e18f0ce268c Inverse of a sparse/diagonal singular matrix should be a sparse/diagonal matrix of Infs. marco.caliari@univr.it parents: 26376 diff changeset	376 %!error <inverse of the null matrix not defined> inv (sparse (2, 2, 0))
30554 117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	377 %!error <inverse of the null matrix not defined> inv (diag ([0, 0]))
117ebe363f56 Fix handling of scalar exceptional values in inv() (bug #61689) Rik <rik@octave.org> parents: 30313 diff changeset	378 %!error <inverse of the null matrix not defined> inv (diag (complex ([0, 0])))
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	379 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	380
23453 2eb7dc15f9fa use DEFALIAS to define inverse John W. Eaton <jwe@octave.org> parents: 23450 diff changeset	381 DEFALIAS (inverse, inv);
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	382
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	383 OCTAVE_NAMESPACE_END

Mercurial > octave

annotate libinterp/corefcn/inv.cc @ 30554:117ebe363f56 stable