Mercurial > octave
view libinterp/corefcn/inv.cc @ 20232:a9574e3c6e9e
Deprecate Array::length() and Sparse::length() in favour of ::numel().
* liboctave/array/Array.h (Array::length): deprecate for ::numel.
* liboctave/array/Sparse.h (Sparse::length): deprecate for ::numel.
* libgui/graphics/QtHandlesUtils.cc, libgui/src/octave-qt-link.cc,
libinterp/corefcn/Cell.cc, libinterp/corefcn/__contourc__.cc,
libinterp/corefcn/__pchip_deriv__.cc, libinterp/corefcn/__qp__.cc,
libinterp/corefcn/cellfun.cc, libinterp/corefcn/daspk.cc,
libinterp/corefcn/dasrt.cc, libinterp/corefcn/dassl.cc,
libinterp/corefcn/data.cc, libinterp/corefcn/filter.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gl-render.cc,
libinterp/corefcn/gl-render.h, libinterp/corefcn/graphics.cc,
libinterp/corefcn/graphics.in.h, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.h, libinterp/corefcn/lsode.cc,
libinterp/corefcn/matrix_type.cc, libinterp/corefcn/oct-hist.cc,
libinterp/corefcn/oct-map.cc, libinterp/corefcn/oct-map.h,
libinterp/corefcn/oct-obj.h, libinterp/corefcn/oct-stream.cc,
libinterp/corefcn/oct-stream.h, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/quadcc.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/strfns.cc,
libinterp/corefcn/sub2ind.cc, libinterp/corefcn/symtab.h,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/tsearch.cc,
libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc,
libinterp/corefcn/variables.cc, libinterp/corefcn/xdiv.cc,
libinterp/corefcn/xpow.cc, libinterp/dldfcn/__glpk__.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/__magick_read__.cc,
libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/ccolamd.cc,
libinterp/dldfcn/colamd.cc, libinterp/octave-value/ov-cell.cc,
libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-class.h,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-perm.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov.cc,
libinterp/operators/op-int.h, libinterp/parse-tree/pt-pr-code.cc,
liboctave/array/Array-util.cc, liboctave/array/Array.cc,
liboctave/array/CColVector.cc, liboctave/array/CDiagMatrix.cc,
liboctave/array/CMatrix.cc, liboctave/array/CRowVector.cc,
liboctave/array/DiagArray2.cc, liboctave/array/DiagArray2.h,
liboctave/array/MArray.cc, liboctave/array/PermMatrix.cc,
liboctave/array/PermMatrix.h, liboctave/array/Sparse.cc,
liboctave/array/boolMatrix.cc, liboctave/array/chMatrix.cc,
liboctave/array/chNDArray.cc, liboctave/array/dColVector.cc,
liboctave/array/dDiagMatrix.cc, liboctave/array/dMatrix.cc,
liboctave/array/dRowVector.cc, liboctave/array/fCColVector.cc,
liboctave/array/fCDiagMatrix.cc, liboctave/array/fCMatrix.cc,
liboctave/array/fCRowVector.cc, liboctave/array/fColVector.cc,
liboctave/array/fDiagMatrix.cc, liboctave/array/fMatrix.cc,
liboctave/array/fRowVector.cc, liboctave/array/idx-vector.cc,
liboctave/array/intNDArray.cc, liboctave/numeric/CmplxCHOL.cc,
liboctave/numeric/CmplxLU.cc, liboctave/numeric/CmplxQR.cc,
liboctave/numeric/DASPK.cc, liboctave/numeric/DASRT.cc,
liboctave/numeric/DASSL.cc, liboctave/numeric/LSODE.cc,
liboctave/numeric/ODES.cc, liboctave/numeric/ODES.h,
liboctave/numeric/base-dae.h, liboctave/numeric/base-lu.cc,
liboctave/numeric/dbleCHOL.cc, liboctave/numeric/dbleLU.cc,
liboctave/numeric/dbleQR.cc, liboctave/numeric/eigs-base.cc,
liboctave/numeric/fCmplxCHOL.cc, liboctave/numeric/fCmplxLU.cc,
liboctave/numeric/fCmplxQR.cc, liboctave/numeric/floatCHOL.cc,
liboctave/numeric/floatLU.cc, liboctave/numeric/floatQR.cc,
liboctave/numeric/lo-specfun.cc, liboctave/numeric/oct-rand.cc,
liboctave/numeric/oct-spparms.cc, liboctave/numeric/sparse-base-chol.cc,
liboctave/operators/mx-inlines.cc, liboctave/system/file-ops.cc,
liboctave/util/glob-match.h, liboctave/util/kpse.cc,
liboctave/util/lo-regexp.cc, liboctave/util/oct-glob.cc,
liboctave/util/pathsearch.cc, liboctave/util/str-vec.cc,
liboctave/util/str-vec.h, liboctave/util/url-transfer.cc: replace all usage
of Array::length() and Sparse::length() with ::numel().
author | Carnë Draug <carandraug@octave.org> |
---|---|
date | Sat, 30 May 2015 03:14:07 +0100 |
parents | 4f45eaf83908 |
children | 4b00afb5e9c3 |
line wrap: on
line source
/* Copyright (C) 1996-2015 John W. Eaton This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include "defun.h" #include "error.h" #include "gripes.h" #include "oct-obj.h" #include "ops.h" #include "ov-re-diag.h" #include "ov-cx-diag.h" #include "ov-flt-re-diag.h" #include "ov-flt-cx-diag.h" #include "ov-perm.h" #include "utils.h" DEFUN (inv, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{x} =} inv (@var{A})\n\ @deftypefnx {Built-in Function} {[@var{x}, @var{rcond}] =} inv (@var{A})\n\ Compute the inverse of the square matrix @var{A}.\n\ \n\ Return an estimate of the reciprocal condition number if requested,\n\ otherwise warn of an ill-conditioned matrix if the reciprocal condition\n\ number is small.\n\ \n\ In general it is best to avoid calculating the inverse of a matrix directly.\n\ For example, it is both faster and more accurate to solve systems of\n\ equations (@var{A}*@math{x} = @math{b}) with\n\ @code{@var{y} = @var{A} \\ @math{b}}, rather than\n\ @code{@var{y} = inv (@var{A}) * @math{b}}.\n\ \n\ If called with a sparse matrix, then in general @var{x} will be a full\n\ matrix requiring significantly more storage. Avoid forming the inverse of a\n\ sparse matrix if possible.\n\ @seealso{ldivide, rdivide}\n\ @end deftypefn") { octave_value_list retval; int nargin = args.length (); if (nargin != 1) { print_usage (); return retval; } octave_value arg = args(0); octave_idx_type nr = arg.rows (); octave_idx_type nc = arg.columns (); int arg_is_empty = empty_arg ("inverse", nr, nc); if (arg_is_empty < 0) return retval; else if (arg_is_empty > 0) return octave_value (Matrix ()); if (nr != nc) { gripe_square_matrix_required ("inverse"); return retval; } octave_value result; octave_idx_type info; double rcond = 0.0; float frcond = 0.0; bool isfloat = arg.is_single_type (); if (arg.is_diag_matrix ()) { rcond = 1.0; frcond = 1.0f; if (arg.is_complex_type ()) { if (isfloat) { result = arg.float_complex_diag_matrix_value ().inverse (info); if (nargout > 1) frcond = arg.float_complex_diag_matrix_value ().rcond (); } else { result = arg.complex_diag_matrix_value ().inverse (info); if (nargout > 1) rcond = arg.complex_diag_matrix_value ().rcond (); } } else { if (isfloat) { result = arg.float_diag_matrix_value ().inverse (info); if (nargout > 1) frcond = arg.float_diag_matrix_value ().rcond (); } else { result = arg.diag_matrix_value ().inverse (info); if (nargout > 1) rcond = arg.diag_matrix_value ().rcond (); } } } else if (arg.is_perm_matrix ()) { rcond = 1.0; info = 0; result = arg.perm_matrix_value ().inverse (); } else if (isfloat) { if (arg.is_real_type ()) { FloatMatrix m = arg.float_matrix_value (); if (! error_state) { MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, frcond, 1); args(0).matrix_type (mattyp); } } else if (arg.is_complex_type ()) { FloatComplexMatrix m = arg.float_complex_matrix_value (); if (! error_state) { MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, frcond, 1); args(0).matrix_type (mattyp); } } } else { if (arg.is_real_type ()) { if (arg.is_sparse_type ()) { SparseMatrix m = arg.sparse_matrix_value (); if (! error_state) { MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, rcond, 1); args(0).matrix_type (mattyp); } } else { Matrix m = arg.matrix_value (); if (! error_state) { MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, rcond, 1); args(0).matrix_type (mattyp); } } } else if (arg.is_complex_type ()) { if (arg.is_sparse_type ()) { SparseComplexMatrix m = arg.sparse_complex_matrix_value (); if (! error_state) { MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, rcond, 1); args(0).matrix_type (mattyp); } } else { ComplexMatrix m = arg.complex_matrix_value (); if (! error_state) { MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, rcond, 1); args(0).matrix_type (mattyp); } } } else gripe_wrong_type_arg ("inv", arg); } if (! error_state) { if (nargout > 1) retval(1) = isfloat ? octave_value (frcond) : octave_value (rcond); retval(0) = result; bool rcond_plus_one_eq_one = false; if (isfloat) { volatile float xrcond = frcond; rcond_plus_one_eq_one = xrcond + 1.0F == 1.0F; } else { volatile double xrcond = rcond; rcond_plus_one_eq_one = xrcond + 1.0 == 1.0; } if (nargout < 2 && (info == -1 || rcond_plus_one_eq_one)) gripe_singular_matrix (isfloat ? frcond : rcond); } return retval; } /* %!assert (inv ([1, 2; 3, 4]), [-2, 1; 1.5, -0.5], sqrt (eps)) %!assert (inv (single ([1, 2; 3, 4])), single ([-2, 1; 1.5, -0.5]), sqrt (eps ("single"))) %!error inv () %!error inv ([1, 2; 3, 4], 2) %!error <argument must be a square matrix> inv ([1, 2; 3, 4; 5, 6]) %!test %! [xinv, rcond] = inv (single ([1,2;3,4])); %! assert (isa (xinv, 'single')); %! assert (isa (rcond, 'single')); %!test %! [xinv, rcond] = inv ([1,2;3,4]); %! assert (isa (xinv, 'double')); %! assert (isa (rcond, 'double')); */ // FIXME: this should really be done with an alias, but // alias_builtin() won't do the right thing if we are actually using // dynamic linking. DEFUN (inverse, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{x} =} inverse (@var{A})\n\ @deftypefnx {Built-in Function} {[@var{x}, @var{rcond}] =} inverse (@var{A})\n\ Compute the inverse of the square matrix @var{A}.\n\ \n\ This is an alias for @code{inv}.\n\ @seealso{inv}\n\ @end deftypefn") { return Finv (args, nargout); }