octave: libinterp/corefcn/inv.cc annotate

annotate libinterp/corefcn/inv.cc @ 20940:48b2ad5ee801

maint: Rename oct-obj.[cc|h] to ovl.[cc|h] for clarity. * libinterp/corefcn/oct-obj.h: Replaced. Contains a #warning issued if used in compilation and includes "ovl.h" instead. Original file renamed to libinterp/octave-value/ovl.h * libinterp/corefcn/oct-obj.cc: Renamed to libinterp/octave-value/ovl.cc. * oct-obj.cc (ovl ()): Added new function to return empty octave_value_list. * libinterp/corefcn/module.mk: Remove oct-obj.cc from build system. * libinterp/octave-value/module.mk: Add ovl.h and ovl.cc to build system. * mk-opts.pl, annotation-dialog.h, Cell.cc, __contourc__.cc, __dsearchn__.cc, __lin_interpn__.cc, __pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, defun.cc, det.cc, dirfns.cc, dlmread.cc, eig.cc, error.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc, gripes.cc, help.cc, hess.cc, hex2num.cc, hook-fcn.h, input.cc, input.h, inv.cc, kron.cc, load-save.cc, lookup.cc, ls-hdf5.cc, ls-mat-ascii.cc, ls-mat4.cc, ls-mat5.cc, ls-oct-binary.cc, ls-oct-text.cc, lsode.cc, lu.cc, luinc.cc, max.cc, mex.cc, oct-hist.cc, oct-lvalue.cc, oct-lvalue.h, oct-map.h, oct-stream.cc, oct.h, ordschur.cc, pager.cc, pinv.cc, pr-output.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sparse-xpow.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc, symtab.h, syscalls.cc, sysdep.cc, time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc, utils.cc, variables.cc, xpow.cc, __delaunayn__.cc, __glpk__.cc, __voronoi__.cc, audiodevinfo.cc, audioread.cc, chol.cc, convhulln.cc, dmperm.cc, qr.cc, symbfact.cc, mkbuiltins, ov-base-diag.h, ov-base-int.cc, ov-base-mat.cc, ov-base-mat.h, ov-base-scalar.cc, ov-base-sparse.cc, ov-base-sparse.h, ov-base.cc, ov-bool-mat.cc, ov-bool.cc, ov-builtin.cc, ov-cell.cc, ov-colon.cc, ov-complex.cc, ov-cs-list.h, ov-cx-mat.cc, ov-dld-fcn.cc, ov-fcn.cc, ov-fcn.h, ov-float.cc, ov-flt-complex.cc, ov-flt-cx-mat.cc, ov-flt-re-mat.cc, ov-int16.cc, ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.h, ov-mex-fcn.cc, ov-perm.h, ov-range.cc, ov-re-mat.cc, ov-scalar.cc, ov-str-mat.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc, ov-usr-fcn.cc, ov-usr-fcn.h, ov.cc, octave.cc, op-b-b.cc, op-b-bm.cc, op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc, op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc, op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc, op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc, op-double-conv.cc, op-fcdm-fcdm.cc, op-fcdm-fdm.cc, op-fcm-fcm.cc, op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc, op-fcs-fcm.cc, op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc, op-float-conv.cc, op-fm-fcm.cc, op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc, op-fs-fcm.cc, op-fs-fcs.cc, op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc, op-i32-i32.cc, op-i64-i64.cc, op-i8-i8.cc, op-int-concat.cc, op-int-conv.cc, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc, op-m-scm.cc, op-m-sm.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc, op-range.cc, op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc, op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc, op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc, op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc, op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc, op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc, parse.h, pt-arg-list.cc, pt-assign.cc, pt-binop.cc, pt-cbinop.cc, pt-cell.cc, pt-colon.cc, pt-const.cc, pt-eval.h, pt-fcn-handle.cc, pt-funcall.h, pt-id.cc, pt-idx.cc, pt-jump.cc, pt-mat.cc, pt-select.cc, pt-unop.cc, token.cc, Array-sym.cc: replace '#include "oct-obj.h"' with '#include "ovl.h"'.

author	Rik <rik@octave.org>
date	Fri, 18 Dec 2015 16:04:56 -0800
parents	8da80da1ac37
children	a4f5da7c5463

rev	line source
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	1 /*
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	2
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19408 diff changeset	3 Copyright (C) 1996-2015 John W. Eaton
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	4
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	6
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	8 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: 6207 diff changeset	9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6207 diff changeset	10 option) any later version.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	11
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	15 for more details.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	16
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	17 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: 6207 diff changeset	18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6207 diff changeset	19 <http://www.gnu.org/licenses/>.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	20
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	21 */
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	22
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	23 #ifdef HAVE_CONFIG_H
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	24 #include <config.h>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	25 #endif
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	26
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	27 #include "defun.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	28 #include "error.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	29 #include "gripes.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20898 diff changeset	30 #include "ovl.h"
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	31 #include "ops.h"
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	32 #include "ov-re-diag.h"
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	33 #include "ov-cx-diag.h"
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	34 #include "ov-flt-re-diag.h"
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	35 #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	36 #include "ov-perm.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	37 #include "utils.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	38
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	39 DEFUN (inv, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	40 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	41 @deftypefn {} {@var{x} =} inv (@var{A})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	42 @deftypefnx {} {[@var{x}, @var{rcond}] =} inv (@var{A})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	43 Compute the inverse of the square matrix @var{A}.\n\
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	44 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	45 Return an estimate of the reciprocal condition number if requested,\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	46 otherwise warn of an ill-conditioned matrix if the reciprocal condition\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	47 number is small.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	48 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	49 In general it is best to avoid calculating the inverse of a matrix directly.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	50 For example, it is both faster and more accurate to solve systems of\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	51 equations (@var{A}*@math{x} = @math{b}) with\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	52 @code{@var{y} = @var{A} \\ @math{b}}, rather than\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	53 @code{@var{y} = inv (@var{A}) * @math{b}}.\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	54 \n\
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	55 If called with a sparse matrix, then in general @var{x} will be a full\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	56 matrix requiring significantly more storage. Avoid forming the inverse of a\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	57 sparse matrix if possible.\n\
11572 7d6d8c1e471f Grammarcheck Texinfo for files in src directory. Rik <octave@nomad.inbox5.com> parents: 11553 diff changeset	58 @seealso{ldivide, rdivide}\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3325 diff changeset	59 @end deftypefn")
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	60 {
20819 f428cbe7576f eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20802 diff changeset	61 if (args.length () != 1)
20802 8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20678 diff changeset	62 print_usage ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	63
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	64 octave_value arg = args(0);
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	65
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5064 diff changeset	66 octave_idx_type nr = arg.rows ();
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5064 diff changeset	67 octave_idx_type nc = arg.columns ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	68
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	69 int arg_is_empty = empty_arg ("inverse", nr, nc);
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 if (arg_is_empty < 0)
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20892 diff changeset	72 return octave_value_list ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	73 else if (arg_is_empty > 0)
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 3808 diff changeset	74 return octave_value (Matrix ());
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	75
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	76 if (nr != nc)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	77 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	78 gripe_square_matrix_required ("inverse");
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20892 diff changeset	79 return octave_value_list ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	80 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	81
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	82 octave_value result;
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	83 octave_idx_type info;
f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	84 double rcond = 0.0;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7650 diff changeset	85 float frcond = 0.0;
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7650 diff changeset	86 bool isfloat = arg.is_single_type ();
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7650 diff changeset	87
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	88 if (arg.is_diag_matrix ())
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	89 {
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	90 rcond = 1.0;
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	91 frcond = 1.0f;
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	92 if (arg.is_complex_type ())
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	93 {
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	94 if (isfloat)
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	95 {
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	96 result = arg.float_complex_diag_matrix_value ().inverse (info);
8371 c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	97 if (nargout > 1)
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	98 frcond = arg.float_complex_diag_matrix_value ().rcond ();
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	99 }
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	100 else
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	101 {
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	102 result = arg.complex_diag_matrix_value ().inverse (info);
8371 c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	103 if (nargout > 1)
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	104 rcond = arg.complex_diag_matrix_value ().rcond ();
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	105 }
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 else
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	108 {
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	109 if (isfloat)
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	110 {
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	111 result = arg.float_diag_matrix_value ().inverse (info);
8371 c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	112 if (nargout > 1)
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	113 frcond = arg.float_diag_matrix_value ().rcond ();
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	114 }
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	115 else
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	116 {
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	117 result = arg.diag_matrix_value ().inverse (info);
8371 c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	118 if (nargout > 1)
8916 a2878ba31a9e add diag & perm matrix query methods to octave_value Jaroslav Hajek <highegg@gmail.com> parents: 8371 diff changeset	119 rcond = arg.diag_matrix_value ().rcond ();
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	120 }
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	121 }
8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	122 }
8371 c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	123 else if (arg.is_perm_matrix ())
c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	124 {
c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	125 rcond = 1.0;
c3f7e2549abb make det & inv aware of diagonal & permutation matrices Jaroslav Hajek <highegg@gmail.com> parents: 8366 diff changeset	126 info = 0;
8960 93f18f166aba remove float perm matrices Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	127 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	128 }
8366 8b1a2555c4e2 implement diagonal matrix objects Jaroslav Hajek <highegg@gmail.com> parents: 7911 diff changeset	129 else if (isfloat)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	130 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7650 diff changeset	131 if (arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	132 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	133 FloatMatrix m = arg.float_matrix_value ();
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	134
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	135 MatrixType mattyp = args(0).matrix_type ();
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	136 result = m.inverse (mattyp, info, frcond, 1);
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	137 args(0).matrix_type (mattyp);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	138 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7650 diff changeset	139 else if (arg.is_complex_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	140 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	141 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	142
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	143 MatrixType mattyp = args(0).matrix_type ();
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	144 result = m.inverse (mattyp, info, frcond, 1);
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	145 args(0).matrix_type (mattyp);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	146 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	147 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7650 diff changeset	148 else
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	149 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7650 diff changeset	150 if (arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	151 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	152 if (arg.is_sparse_type ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	153 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	154 SparseMatrix m = arg.sparse_matrix_value ();
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	155
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	156 MatrixType mattyp = args(0).matrix_type ();
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	157 result = m.inverse (mattyp, info, rcond, 1);
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	158 args(0).matrix_type (mattyp);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	159 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	160 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	161 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	162 Matrix m = arg.matrix_value ();
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	163
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	164 MatrixType mattyp = args(0).matrix_type ();
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	165 result = m.inverse (mattyp, info, rcond, 1);
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	166 args(0).matrix_type (mattyp);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	167 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	168 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7650 diff changeset	169 else if (arg.is_complex_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	170 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	171 if (arg.is_sparse_type ())
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 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	174
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	175 MatrixType mattyp = args(0).matrix_type ();
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	176 result = m.inverse (mattyp, info, rcond, 1);
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	177 args(0).matrix_type (mattyp);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	178 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	179 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	180 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	181 ComplexMatrix m = arg.complex_matrix_value ();
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	182
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	183 MatrixType mattyp = args(0).matrix_type ();
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	184 result = m.inverse (mattyp, info, rcond, 1);
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	185 args(0).matrix_type (mattyp);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	186 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	187 }
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	188 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	189 gripe_wrong_type_arg ("inv", arg);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	190 }
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	191
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20892 diff changeset	192 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	193
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20892 diff changeset	194 retval(0) = result;
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	195 if (nargout > 1)
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	196 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	197
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	198 bool rcond_plus_one_eq_one = false;
18243 36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	199
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	200 if (isfloat)
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	201 {
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	202 volatile float xrcond = frcond;
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	203 rcond_plus_one_eq_one = xrcond + 1.0F == 1.0F;
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	204 }
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	205 else
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	206 {
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	207 volatile double xrcond = rcond;
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	208 rcond_plus_one_eq_one = xrcond + 1.0 == 1.0;
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	209 }
18243 36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	210
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	211 if (nargout < 2 && (info == -1 \|\| rcond_plus_one_eq_one))
4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	212 gripe_singular_matrix (isfloat ? frcond : rcond);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	213
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	214 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	215 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	216
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	217 /*
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	218 %!assert (inv ([1, 2; 3, 4]), [-2, 1; 1.5, -0.5], sqrt (eps))
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	219 %!assert (inv (single ([1, 2; 3, 4])), single ([-2, 1; 1.5, -0.5]), sqrt (eps ("single")))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	220
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	221 %!error inv ()
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	222 %!error inv ([1, 2; 3, 4], 2)
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	223 %!error <argument must be a square matrix> inv ([1, 2; 3, 4; 5, 6])
18243 36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	224
36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	225 %!test
36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	226 %! [xinv, rcond] = inv (single ([1,2;3,4]));
36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	227 %! assert (isa (xinv, 'single'));
36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	228 %! assert (isa (rcond, 'single'));
36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	229
36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	230 %!test
36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	231 %! [xinv, rcond] = inv ([1,2;3,4]);
36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	232 %! assert (isa (xinv, 'double'));
36057e2411f8 test float rcond using float arithmetic in inv function (bug #41065) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	233 %! assert (isa (rcond, 'double'));
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	234 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	235
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	236 // FIXME: this should really be done with an alias, but
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	237 // alias_builtin() won't do the right thing if we are actually using
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	238 // dynamic linking.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	239
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	240 DEFUN (inverse, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	241 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	242 @deftypefn {} {@var{x} =} inverse (@var{A})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	243 @deftypefnx {} {[@var{x}, @var{rcond}] =} inverse (@var{A})\n\
12546 39ca02387a32 Improve docstrings for a number of functions. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	244 Compute the inverse of the square matrix @var{A}.\n\
39ca02387a32 Improve docstrings for a number of functions. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	245 \n\
39ca02387a32 Improve docstrings for a number of functions. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	246 This is an alias for @code{inv}.\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	247 @seealso{inv}\n\
3458 d25bc039237b [project @ 2000-01-19 09:36:14 by jwe] jwe parents: 3372 diff changeset	248 @end deftypefn")
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	249 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	250 return Finv (args, nargout);
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	251 }

Mercurial > octave

annotate libinterp/corefcn/inv.cc @ 20940:48b2ad5ee801