Mercurial > octave
view libinterp/corefcn/inv.cc @ 31607:aac27ad79be6 stable
maint: Re-indent code after switch to using namespace macros.
* build-env.h, build-env.in.cc, Cell.h, __betainc__.cc, __eigs__.cc,
__ftp__.cc, __ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __magick_read__.cc,
__pchip_deriv__.cc, amd.cc, base-text-renderer.cc, base-text-renderer.h,
besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.h, call-stack.cc,
call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc, dasrt.cc, data.cc,
debug.cc, defaults.cc, defaults.h, det.cc, display.cc, display.h, dlmread.cc,
dynamic-ld.cc, dynamic-ld.h, ellipj.cc, environment.cc, environment.h,
error.cc, error.h, errwarn.h, event-manager.cc, event-manager.h,
event-queue.cc, event-queue.h, fcn-info.cc, fcn-info.h, fft.cc, fft2.cc,
file-io.cc, filter.cc, find.cc, ft-text-renderer.cc, ft-text-renderer.h,
gcd.cc, gl-render.cc, gl-render.h, gl2ps-print.cc, gl2ps-print.h,
graphics-toolkit.cc, graphics-toolkit.h, graphics.cc, gsvd.cc, gtk-manager.cc,
gtk-manager.h, help.cc, help.h, hook-fcn.cc, hook-fcn.h, input.cc, input.h,
interpreter-private.cc, interpreter-private.h, interpreter.cc, interpreter.h,
inv.cc, jsondecode.cc, jsonencode.cc, latex-text-renderer.cc,
latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h,
lookup.cc, ls-hdf5.cc, ls-mat4.cc, ls-mat5.cc, lsode.cc, lu.cc, mappers.cc,
matrix_type.cc, max.cc, mex.cc, mexproto.h, mxarray.h, mxtypes.in.h,
oct-errno.in.cc, oct-hdf5-types.cc, oct-hist.cc, oct-hist.h, oct-map.cc,
oct-map.h, oct-opengl.h, oct-prcstrm.h, oct-process.cc, oct-process.h,
oct-stdstrm.h, oct-stream.cc, oct-stream.h, oct-strstrm.h,
octave-default-image.h, ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc,
pow2.cc, pr-output.cc, psi.cc, qr.cc, quadcc.cc, rand.cc, regexp.cc,
settings.cc, settings.h, sighandlers.cc, sighandlers.h, sparse-xpow.cc,
sqrtm.cc, stack-frame.cc, stack-frame.h, stream-euler.cc, strfns.cc, svd.cc,
syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h, symscope.cc, symscope.h,
symtab.cc, symtab.h, sysdep.cc, sysdep.h, text-engine.cc, text-engine.h,
text-renderer.cc, text-renderer.h, time.cc, toplev.cc, typecast.cc,
url-handle-manager.cc, url-handle-manager.h, urlwrite.cc, utils.cc, utils.h,
variables.cc, variables.h, xdiv.cc, __delaunayn__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audioread.cc, convhulln.cc,
gzip.cc, cdef-class.cc, cdef-class.h, cdef-fwd.h, cdef-manager.cc,
cdef-manager.h, cdef-method.cc, cdef-method.h, cdef-object.cc, cdef-object.h,
cdef-package.cc, cdef-package.h, cdef-property.cc, cdef-property.h,
cdef-utils.cc, cdef-utils.h, ov-base-diag.cc, ov-base-int.cc, ov-base-mat.cc,
ov-base-mat.h, ov-base-scalar.cc, ov-base.cc, ov-base.h, ov-bool-mat.cc,
ov-bool-mat.h, ov-bool-sparse.cc, ov-bool.cc, ov-builtin.h, ov-cell.cc,
ov-ch-mat.cc, ov-class.cc, ov-class.h, ov-classdef.cc, ov-classdef.h,
ov-complex.cc, ov-cx-diag.cc, ov-cx-mat.cc, ov-cx-sparse.cc, ov-dld-fcn.cc,
ov-dld-fcn.h, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h, ov-float.cc,
ov-flt-complex.cc, ov-flt-cx-diag.cc, ov-flt-cx-mat.cc, ov-flt-re-diag.cc,
ov-flt-re-mat.cc, ov-flt-re-mat.h, ov-intx.h, ov-java.cc, ov-lazy-idx.cc,
ov-legacy-range.cc, ov-magic-int.cc, ov-mex-fcn.cc, ov-mex-fcn.h,
ov-null-mat.cc, ov-perm.cc, ov-range.cc, ov-re-diag.cc, ov-re-mat.cc,
ov-re-mat.h, ov-re-sparse.cc, ov-scalar.cc, ov-str-mat.cc, ov-struct.cc,
ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h, ov.cc, ov.h, ovl.h,
octave.cc, octave.h, op-b-sbm.cc, op-bm-sbm.cc, op-cs-scm.cc, op-fm-fcm.cc,
op-fs-fcm.cc, op-s-scm.cc, op-scm-cs.cc, op-scm-s.cc, op-sm-cs.cc, ops.h,
anon-fcn-validator.cc, anon-fcn-validator.h, bp-table.cc, bp-table.h,
comment-list.cc, comment-list.h, filepos.h, lex.h, oct-lvalue.cc, oct-lvalue.h,
parse.h, profiler.cc, profiler.h, pt-anon-scopes.cc, pt-anon-scopes.h,
pt-arg-list.cc, pt-arg-list.h, pt-args-block.cc, pt-args-block.h,
pt-array-list.cc, pt-array-list.h, pt-assign.cc, pt-assign.h, pt-binop.cc,
pt-binop.h, pt-bp.cc, pt-bp.h, pt-cbinop.cc, pt-cbinop.h, pt-cell.cc,
pt-cell.h, pt-check.cc, pt-check.h, pt-classdef.cc, pt-classdef.h, pt-cmd.h,
pt-colon.cc, pt-colon.h, pt-const.cc, pt-const.h, pt-decl.cc, pt-decl.h,
pt-eval.cc, pt-eval.h, pt-except.cc, pt-except.h, pt-exp.cc, pt-exp.h,
pt-fcn-handle.cc, pt-fcn-handle.h, pt-id.cc, pt-id.h, pt-idx.cc, pt-idx.h,
pt-jump.h, pt-loop.cc, pt-loop.h, pt-mat.cc, pt-mat.h, pt-misc.cc, pt-misc.h,
pt-pr-code.cc, pt-pr-code.h, pt-select.cc, pt-select.h, pt-spmd.cc, pt-spmd.h,
pt-stmt.cc, pt-stmt.h, pt-tm-const.cc, pt-tm-const.h, pt-unop.cc, pt-unop.h,
pt-walk.cc, pt-walk.h, pt.cc, pt.h, token.cc, token.h, Range.cc, Range.h,
idx-vector.cc, idx-vector.h, range-fwd.h, CollocWt.cc, CollocWt.h,
aepbalance.cc, aepbalance.h, chol.cc, chol.h, gepbalance.cc, gepbalance.h,
gsvd.cc, gsvd.h, hess.cc, hess.h, lo-mappers.cc, lo-mappers.h, lo-specfun.cc,
lo-specfun.h, lu.cc, lu.h, oct-convn.cc, oct-convn.h, oct-fftw.cc, oct-fftw.h,
oct-norm.cc, oct-norm.h, oct-rand.cc, oct-rand.h, oct-spparms.cc,
oct-spparms.h, qr.cc, qr.h, qrp.cc, qrp.h, randgamma.cc, randgamma.h,
randmtzig.cc, randmtzig.h, randpoisson.cc, randpoisson.h, schur.cc, schur.h,
sparse-chol.cc, sparse-chol.h, sparse-lu.cc, sparse-lu.h, sparse-qr.cc,
sparse-qr.h, svd.cc, svd.h, child-list.cc, child-list.h, dir-ops.cc, dir-ops.h,
file-ops.cc, file-ops.h, file-stat.cc, file-stat.h, lo-sysdep.cc, lo-sysdep.h,
lo-sysinfo.cc, lo-sysinfo.h, mach-info.cc, mach-info.h, oct-env.cc, oct-env.h,
oct-group.cc, oct-group.h, oct-password.cc, oct-password.h, oct-syscalls.cc,
oct-syscalls.h, oct-time.cc, oct-time.h, oct-uname.cc, oct-uname.h,
action-container.cc, action-container.h, base-list.h, cmd-edit.cc, cmd-edit.h,
cmd-hist.cc, cmd-hist.h, f77-fcn.h, file-info.cc, file-info.h,
lo-array-errwarn.cc, lo-array-errwarn.h, lo-hash.cc, lo-hash.h, lo-ieee.h,
lo-regexp.cc, lo-regexp.h, lo-utils.cc, lo-utils.h, oct-base64.cc,
oct-base64.h, oct-glob.cc, oct-glob.h, oct-inttypes.h, oct-mutex.cc,
oct-mutex.h, oct-refcount.h, oct-shlib.cc, oct-shlib.h, oct-sparse.cc,
oct-sparse.h, oct-string.h, octave-preserve-stream-state.h, pathsearch.cc,
pathsearch.h, quit.cc, quit.h, unwind-prot.cc, unwind-prot.h, url-transfer.cc,
url-transfer.h:
Re-indent code after switch to using namespace macros.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 01 Dec 2022 18:02:15 -0800 |
parents | e88a07dec498 |
children | 597f3ee61a48 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1996-2022 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // 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 // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include "defun.h" #include "error.h" #include "errwarn.h" #include "ovl.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" OCTAVE_BEGIN_NAMESPACE(octave) DEFUN (inv, args, nargout, doc: /* -*- texinfo -*- @deftypefn {} {@var{x} =} inv (@var{A}) @deftypefnx {} {[@var{x}, @var{rcond}] =} inv (@var{A}) @deftypefnx {} {[@dots{}] =} inverse (@dots{}) Compute the inverse of the square matrix @var{A}. Return an estimate of the reciprocal condition number if requested, otherwise warn of an ill-conditioned matrix if the reciprocal condition number is small. In general it is best to avoid calculating the inverse of a matrix directly. For example, it is both faster and more accurate to solve systems of equations (@var{A}*@math{x} = @math{b}) with @code{@var{y} = @var{A} \ @math{b}}, rather than @code{@var{y} = inv (@var{A}) * @math{b}}. If called with a sparse matrix, then in general @var{x} will be a full matrix requiring significantly more storage. Avoid forming the inverse of a sparse matrix if possible. @code{inverse} is an alias and may be used identically in place of @code{inv}. @seealso{ldivide, rdivide, pinv} @end deftypefn */) { if (args.length () != 1) print_usage (); octave_value arg = args(0); if (! arg.isnumeric ()) err_wrong_type_arg ("inv", arg); if (arg.isempty ()) return ovl (Matrix ()); if (arg.rows () != arg.columns ()) err_square_matrix_required ("inv", "A"); octave_value result; octave_idx_type info = 0; 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.iscomplex ()) { if (isfloat) { result = arg.float_complex_diag_matrix_value ().inverse (info); if (info == -1) frcond = 0.0f; else if (nargout > 1) frcond = arg.float_complex_diag_matrix_value ().rcond (); } else { result = arg.complex_diag_matrix_value ().inverse (info); if (info == -1) rcond = 0.0; else if (nargout > 1) rcond = arg.complex_diag_matrix_value ().rcond (); } } else { if (isfloat) { result = arg.float_diag_matrix_value ().inverse (info); if (info == -1) frcond = 0.0f; else if (nargout > 1) frcond = arg.float_diag_matrix_value ().rcond (); } else { result = arg.diag_matrix_value ().inverse (info); if (info == -1) rcond = 0.0; else if (nargout > 1) rcond = arg.diag_matrix_value ().rcond (); } } } else if (arg.is_perm_matrix ()) { info = 0; rcond = 1.0; result = arg.perm_matrix_value ().inverse (); } else if (isfloat) { if (arg.isreal ()) { FloatMatrix m = arg.float_matrix_value (); MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, frcond, true, true); args(0).matrix_type (mattyp); } else if (arg.iscomplex ()) { FloatComplexMatrix m = arg.float_complex_matrix_value (); MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, frcond, true, true); args(0).matrix_type (mattyp); } } else { if (arg.isreal ()) { if (arg.issparse ()) { SparseMatrix m = arg.sparse_matrix_value (); MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, rcond, true, true); args(0).matrix_type (mattyp); } else { Matrix m = arg.matrix_value (); MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, rcond, true, true); args(0).matrix_type (mattyp); } } else if (arg.iscomplex ()) { if (arg.issparse ()) { SparseComplexMatrix m = arg.sparse_complex_matrix_value (); MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, rcond, true, true); args(0).matrix_type (mattyp); } else { ComplexMatrix m = arg.complex_matrix_value (); MatrixType mattyp = args(0).matrix_type (); result = m.inverse (mattyp, info, rcond, true, true); args(0).matrix_type (mattyp); } } else // Shouldn't get here since we checked for suitable arg earlier. // Maybe for some user-defined classes? err_wrong_type_arg ("inv", arg); } octave_value_list retval (nargout > 1 ? 2 : 1); retval(0) = result; if (nargout > 1) retval(1) = (isfloat ? octave_value (frcond) : octave_value (rcond)); if (nargout < 2) { bool is_singular; if (isfloat) is_singular = ((frcond + 1.0f == 1.0f) || octave::math::isnan (frcond)) && ! arg.is_scalar_type (); else is_singular = ((rcond + 1.0 == 1.0) || octave::math::isnan (rcond)) && ! arg.is_scalar_type (); if (info == -1 || is_singular) warn_singular_matrix (isfloat ? frcond : rcond); } return retval; } /* ## Basic test for double/single matrices %!assert (inv ([1, 2; 3, 4]), [-2, 1; 1.5, -0.5], 5*eps) %!test %! [xinv, rcond] = inv ([1,2;3,4]); %! assert (xinv, [-2, 1; 1.5, -0.5], 5*eps); %! assert (isa (rcond, "double")); %!assert (inv (single ([1, 2; 3, 4])), single ([-2, 1; 1.5, -0.5]), %! 5* eps ("single")) %!test %! [xinv, rcond] = inv (single ([1,2;3,4])); %! assert (xinv, single ([-2, 1; 1.5, -0.5]), 5* eps ("single")); %! assert (isa (rcond, "single")); ## Basic test for integer inputs %!assert (inv (int32 (2)), 0.5) %!assert (inv (uint32 (2)), 0.5) %!assert (inv (int64 (2)), 0.5) %!assert (inv (uint64 (2)), 0.5) ## Normal scalar cases %!assert (inv (2), 0.5) %!test %! [xinv, rcond] = inv (2); %! assert (xinv, 0.5); %! assert (rcond, 1); %!assert (inv (single (2)), single (0.5)) %!test %! [xinv, rcond] = inv (single (2)); %! assert (xinv, single (0.5)); %! assert (rcond, single (1)); %!assert (inv (complex (1, -1)), 0.5+0.5i) %!test %! [xinv, rcond] = inv (complex (1, -1)); %! assert (xinv, 0.5+0.5i); %! assert (rcond, 1); %!assert (inv (complex (single (1), -1)), single (0.5+0.5i)) %!test %! [xinv, rcond] = inv (complex (single (1), -1)); %! assert (xinv, single (0.5+0.5i)); %! assert (rcond, single (1)); ## Test special inputs ## Empty matrix %!assert (inv (zeros (2,0)), []) ## Scalar "0" %!assert (inv (0), Inf) %!test %! [xinv, rcond] = inv (0); %! assert (xinv, Inf); %! assert (rcond, 0); %!assert (inv (single (0)), single (Inf)) %!test %! [xinv, rcond] = inv (single (0)); %! assert (xinv, single (Inf)); %! assert (rcond, single (0)); %!assert (inv (complex (0, 0)), Inf) %!test %! [xinv, rcond] = inv (complex (0, 0)); %! assert (xinv, Inf); %! assert (rcond, 0); %!assert (inv (complex (single (0), 0)), single (Inf)) %!test %! [xinv, rcond] = inv (complex (single (0), 0)); %! assert (xinv, single (Inf)); %! assert (rcond, single (0)); ## NOTE: Matlab returns +Inf for -0 input, but it returns -Inf for 1/-0. ## These should be the same, and in Octave they are. %!assert (inv (-0), -Inf) %!test %! [xinv, rcond] = inv (-0); %! assert (xinv, -Inf); %! assert (rcond, 0); ## Scalar "Inf" %!assert (inv (Inf), 0) %!test %! [xinv, rcond] = inv (Inf); %! assert (xinv, 0); %! assert (rcond, 0); %!assert (inv (single (Inf)), single (0)) %!test %! [xinv, rcond] = inv (single (Inf)); %! assert (xinv, single (0)); %! assert (rcond, single (0)); %!assert (inv (complex (1, Inf)), 0) %!test %! [xinv, rcond] = inv (complex (1, Inf)); %! assert (xinv, 0); %! assert (rcond, 0); %!assert (inv (complex (single (1), Inf)), single (0)) %!test %! [xinv, rcond] = inv (complex (single (1), Inf)); %! assert (xinv, single (0)); %! assert (rcond, single (0)); ## Scalar "NaN" %!assert (inv (NaN), NaN) %!test %! [xinv, rcond] = inv (NaN); %! assert (xinv, NaN); %! assert (rcond, NaN); %!assert (inv (single (NaN)), single (NaN)) %!test %! [xinv, rcond] = inv (single (NaN)); %! assert (xinv, single (NaN)); %! assert (rcond, single (NaN)); %!assert (inv (complex (1, NaN)), complex (NaN, NaN)) %!test %! [xinv, rcond] = inv (complex (1, NaN)); %! assert (xinv, complex (NaN, NaN)); %! assert (rcond, NaN); %!assert (inv (complex (single (1), NaN)), complex (single (NaN), NaN)) %!test %! [xinv, rcond] = inv (complex (single (1), NaN)); %! assert (xinv, complex (single (NaN), NaN)); %! assert (rcond, single (NaN)); ## Matrix special values ## Matrix of all zeroes %!warning <matrix singular> assert (inv (zeros (2,2)), Inf (2,2)) %!test %! [xinv, rcond] = inv (zeros (2,2)); %! assert (xinv, Inf (2,2)); %! assert (rcond, 0); ## Matrix of all Inf %!warning <rcond = > assert (inv (Inf (2,2)), NaN (2,2)) %!test %! [xinv, rcond] = inv (Inf (2,2)); %! assert (xinv, NaN (2,2)); %! assert (rcond, NaN); ## Matrix of all NaN %!warning <rcond = > assert (inv (NaN (2,2)), NaN (2,2)) %!test %! [xinv, rcond] = inv (NaN (2,2)); %! assert (xinv, NaN (2,2)); %! assert (rcond, NaN); ## Special diagonal matrices %!test %! fail ("A = inv (diag ([1, 0, 1]))", "warning", "matrix singular"); %! assert (A, diag ([Inf, Inf, Inf])); ## Special sparse matrices %!testif HAVE_UMFPACK <*56232> %! fail ("A = inv (sparse ([1, 2;0 ,0]))", "warning", "matrix singular"); %! assert (A, sparse ([Inf, Inf; 0, 0])); %!testif HAVE_UMFPACK <*56232> %! fail ("A = inv (sparse ([1i, 2;0 ,0]))", "warning", "matrix singular"); %! assert (A, sparse ([Inf, Inf; 0, 0])); %!testif HAVE_UMFPACK <*56232> %! fail ("A = inv (sparse ([1, 0, 0; 0, 0, 0; 0, 0, 1]))", %! "warning", "matrix singular"); %! assert (A, sparse ([Inf, 0, 0; 0, 0, 0; 0, 0, Inf])); %!error <Invalid call> inv () %!error <Invalid call> inv ([1, 2; 3, 4], 2) %!error <wrong type argument> inv ("Hello World") %!error <wrong type argument> inv ({1}) %!error <wrong type argument> inv (true) %!error <must be a square matrix> inv ([1, 2; 3, 4; 5, 6]) %!error <inverse of the null matrix not defined> inv (sparse (2, 2, 0)) %!error <inverse of the null matrix not defined> inv (diag ([0, 0])) %!error <inverse of the null matrix not defined> inv (diag (complex ([0, 0]))) */ DEFALIAS (inverse, inv); OCTAVE_END_NAMESPACE(octave)