octave: libinterp/corefcn/pinv.cc annotate

annotate libinterp/corefcn/pinv.cc @ 29958:32c3a5805893

move DEFUN and DEFMETHOD functions inside octave namespace * mk-opts.pl: Surround emitted function definitions with OCTAVE_NAMESPACE_BEGIN and OCTAVE_NAMESPACE_END tags. * mk-builtins.pl: Surround emitted function declarations with OCTAVE_NAMESPACE_BEGIN and OCTAVE_NAMESPACE_END tags. Emit deprecated global inline functions. * __betainc__.cc, __contourc__.cc, __dsearchn__.cc, __eigs__.cc, __expint__.cc, __ftp__.cc, __gammainc__.cc, __ichol__.cc, __ilu__.cc, __lin_interpn__.cc, __magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, balance.cc, besselj.cc, bitfcns.cc, bsxfun.cc, call-stack.cc, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, defun.cc, det.cc, dirfns.cc, display.cc, dlmread.cc, dmperm.cc, dot.cc, eig.cc, ellipj.cc, environment.cc, error.cc, event-manager.cc, fcn-info.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc, gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc, gsvd.cc, hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, interpreter.cc, inv.cc, jsondecode.cc, jsonencode.cc, kron.cc, load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc, oct-hist.cc, ordqz.cc, ordschur.cc, pager.cc, pinv.cc, pr-flt-fmt.cc, pr-output.cc, psi.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, settings.cc, sighandlers.cc, sparse.cc, spparms.cc, sqrtm.cc, stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc, symbfact.cc, symrcm.cc, symtab.cc, syscalls.cc, sysdep.cc, time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc, utils.cc, variables.cc, __delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc, audioread.cc, convhulln.cc, fftw.cc, gzip.cc, ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc, ov-fcn-handle.cc, ov-java.cc, ov-null-mat.cc, ov-oncleanup.cc, ov-struct.cc, ov-typeinfo.cc, ov-usr-fcn.cc, ov.cc, octave.cc, lex.ll, oct-parse.yy, profiler.cc, pt-eval.cc: Surround DEFUN and DEFMETHOD function defnitions with OCTAVE_NAMESPACE_BEGIN and OCTAVE_NAMESPACE_END tags.

author	John W. Eaton <jwe@octave.org>
date	Fri, 13 Aug 2021 21:53:51 -0400
parents	0a5b15007766
children	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: 14179 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: 20941 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: 20939 diff changeset	33 #include "ovl.h"
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	34 #include "ops.h"
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	35 #include "ov-re-diag.h"
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	36 #include "ov-cx-diag.h"
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	37 #include "ov-flt-re-diag.h"
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	38 #include "ov-flt-cx-diag.h"
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 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: 29358 diff changeset	41 OCTAVE_NAMESPACE_BEGIN
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	42
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14179 diff changeset	43 DEFUN (pinv, args, ,
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 {} {} pinv (@var{x})
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 {} {} pinv (@var{x}, @var{tol})
25003 2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release. Rik <rik@octave.org> parents: 24534 diff changeset	47 Return the @nospell{Moore-Penrose} pseudoinverse of @var{x}.
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
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	49 Singular values less than @var{tol} are ignored.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	50
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	51 If the second argument is omitted, it is taken to be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	52
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	53 @example
24197 63fc7a75a3d7 doc: Update docstring for pinv and inv. Rik <rik@octave.org> parents: 23219 diff changeset	54 tol = max ([rows(@var{x}), columns(@var{x})]) * norm (@var{x}) * eps
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	55 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	56
24200 140f1403d603 doc: Update docstring for pinv. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 24197 diff changeset	57 @seealso{inv, ldivide}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	58 @end deftypefn */)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	59 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	60 int nargin = args.length ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	61
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	62 if (nargin < 1 \|\| nargin > 2)
20802 8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	63 print_usage ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	64
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	65 octave_value arg = args(0);
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	66
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23220 diff changeset	67 if (arg.isempty ())
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21100 diff changeset	68 return ovl (Matrix ());
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	69
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	70 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	71
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	72 bool isfloat = arg.is_single_type ();
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	73
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	74 if (arg.is_diag_matrix ())
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	75 {
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	76 if (isfloat)
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	77 {
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	78 float tol = 0.0;
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	79 if (nargin == 2)
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	80 tol = args(1).float_value ();
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	81
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	82 if (tol < 0.0)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20802 diff changeset	83 error ("pinv: TOL must be greater than zero");
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	84
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	85 if (arg.isreal ())
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	86 retval = arg.float_diag_matrix_value ().pseudo_inverse (tol);
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	87 else
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	88 retval = arg.float_complex_diag_matrix_value ().pseudo_inverse (tol);
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	89 }
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	90 else
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	91 {
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	92 double tol = 0.0;
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	93 if (nargin == 2)
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	94 tol = args(1).double_value ();
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	95
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	96 if (tol < 0.0)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20802 diff changeset	97 error ("pinv: TOL must be greater than zero");
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	98
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	99 if (arg.isreal ())
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	100 retval = arg.diag_matrix_value ().pseudo_inverse (tol);
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	101 else
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	102 retval = arg.complex_diag_matrix_value ().pseudo_inverse (tol);
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	103 }
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	104 }
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	105 else if (arg.is_perm_matrix ())
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	106 {
8960 93f18f166aba remove float perm matrices Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	107 retval = arg.perm_matrix_value ().inverse ();
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	108 }
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	109 else if (isfloat)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	110 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	111 float tol = 0.0;
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	112 if (nargin == 2)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	113 tol = args(1).float_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	114
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	115 if (tol < 0.0)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20802 diff changeset	116 error ("pinv: TOL must be greater than zero");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	117
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	118 if (arg.isreal ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	119 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	120 FloatMatrix m = arg.float_matrix_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	121
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	122 retval = m.pseudo_inverse (tol);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	123 }
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23577 diff changeset	124 else if (arg.iscomplex ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	125 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	126 FloatComplexMatrix m = arg.float_complex_matrix_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	127
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	128 retval = m.pseudo_inverse (tol);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	129 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	130 else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20941 diff changeset	131 err_wrong_type_arg ("pinv", arg);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	132 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	133 else
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	134 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	135 double tol = 0.0;
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	136 if (nargin == 2)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	137 tol = args(1).double_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	138
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	139 if (tol < 0.0)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20802 diff changeset	140 error ("pinv: TOL must be greater than zero");
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	141
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	142 if (arg.isreal ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	143 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	144 Matrix m = arg.matrix_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	145
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	146 retval = m.pseudo_inverse (tol);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	147 }
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23577 diff changeset	148 else if (arg.iscomplex ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	149 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	150 ComplexMatrix m = arg.complex_matrix_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	151
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	152 retval = m.pseudo_inverse (tol);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	153 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	154 else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20941 diff changeset	155 err_wrong_type_arg ("pinv", arg);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	156 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	157
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	158 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	159 }
13042 ca7aaf2689c3 codesprint: 8 tests for pinv.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	160
ca7aaf2689c3 codesprint: 8 tests for pinv.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	161 /*
13079 9512d7272d5b codesprint: Fix tolerance for pinv test Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 13042 diff changeset	162 %!shared a, b, tol, hitol, d, u, x, y
25124 435645a627dd Fix random seed for pinv BIST tests (bug #53560). Rik <rik@octave.org> parents: 25054 diff changeset	163 %! old_state = rand ("state");
435645a627dd Fix random seed for pinv BIST tests (bug #53560). Rik <rik@octave.org> parents: 25054 diff changeset	164 %! restore_state = onCleanup (@() rand ("state", old_state));
435645a627dd Fix random seed for pinv BIST tests (bug #53560). Rik <rik@octave.org> parents: 25054 diff changeset	165 %! rand ("state", 42); # initialize generator to make behavior reproducible
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 15195 diff changeset	166 %! a = reshape (rand*[1:16], 4, 4); # Rank 2 matrix
13042 ca7aaf2689c3 codesprint: 8 tests for pinv.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	167 %! b = pinv (a);
14179 a7a020cd6106 Relax tolerance for pinv tests so that it fails less than 1% of the time. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	168 %! tol = 4e-14;
a7a020cd6106 Relax tolerance for pinv tests so that it fails less than 1% of the time. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	169 %! hitol = 40*sqrt (eps);
13042 ca7aaf2689c3 codesprint: 8 tests for pinv.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	170 %! d = diag ([rand, rand, hitol, hitol]);
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 15195 diff changeset	171 %! u = rand (4); # Could be singular by freak accident
13042 ca7aaf2689c3 codesprint: 8 tests for pinv.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	172 %! x = inv (u)du;
14179 a7a020cd6106 Relax tolerance for pinv tests so that it fails less than 1% of the time. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	173 %! y = pinv (x, sqrt (eps));
25124 435645a627dd Fix random seed for pinv BIST tests (bug #53560). Rik <rik@octave.org> parents: 25054 diff changeset	174
435645a627dd Fix random seed for pinv BIST tests (bug #53560). Rik <rik@octave.org> parents: 25054 diff changeset	175 ## Verify Penrose conditions for pseudoinverse
14179 a7a020cd6106 Relax tolerance for pinv tests so that it fails less than 1% of the time. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	176 %!assert (aba, a, tol)
a7a020cd6106 Relax tolerance for pinv tests so that it fails less than 1% of the time. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	177 %!assert (bab, b, tol)
a7a020cd6106 Relax tolerance for pinv tests so that it fails less than 1% of the time. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	178 %!assert ((ba)', ba, tol)
a7a020cd6106 Relax tolerance for pinv tests so that it fails less than 1% of the time. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	179 %!assert ((ab)', ab, tol)
a7a020cd6106 Relax tolerance for pinv tests so that it fails less than 1% of the time. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	180 %!assert (xyx, x, -hitol)
a7a020cd6106 Relax tolerance for pinv tests so that it fails less than 1% of the time. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	181 %!assert (yxy, y, -hitol)
a7a020cd6106 Relax tolerance for pinv tests so that it fails less than 1% of the time. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	182 %!assert ((xy)', xy, hitol)
a7a020cd6106 Relax tolerance for pinv tests so that it fails less than 1% of the time. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	183 %!assert ((yx)', yx, hitol)
18494 1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	184
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	185 ## Clear shared variables
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	186 %!shared
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	187
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	188 ## Test pinv for Diagonal matrices
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	189 %!test
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	190 %! x = diag ([3 2 1 0 -0.5]);
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	191 %! y = pinv (x);
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	192 %! assert (typeinfo (y)(1:8), "diagonal");
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	193 %! assert (isa (y, "double"));
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	194 %! assert (diag (y), [1/3, 1/2, 1, 0 1/-0.5]');
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	195 %! y = pinv (x, 1);
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	196 %! assert (diag (y), [1/3 1/2 1 0 0]');
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	197 %! y = pinv (x, 2);
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	198 %! assert (diag (y), [1/3 1/2 0 0 0]');
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	199
24195 d3dc76efb38b Return correct value for pinv of zero vectors and scalars (bug #51246). Rik <rik@octave.org> parents: 23582 diff changeset	200 ## Test special case of 0 scalars and vectors
d3dc76efb38b Return correct value for pinv of zero vectors and scalars (bug #51246). Rik <rik@octave.org> parents: 23582 diff changeset	201 %!assert (pinv (0), 0)
d3dc76efb38b Return correct value for pinv of zero vectors and scalars (bug #51246). Rik <rik@octave.org> parents: 23582 diff changeset	202 %!assert (pinv ([0, 0, 0]), [0; 0; 0])
d3dc76efb38b Return correct value for pinv of zero vectors and scalars (bug #51246). Rik <rik@octave.org> parents: 23582 diff changeset	203 %!assert (pinv (single (0)), single (0))
d3dc76efb38b Return correct value for pinv of zero vectors and scalars (bug #51246). Rik <rik@octave.org> parents: 23582 diff changeset	204 %!assert (pinv (single ([0, 0, 0])), single ([0; 0; 0]))
d3dc76efb38b Return correct value for pinv of zero vectors and scalars (bug #51246). Rik <rik@octave.org> parents: 23582 diff changeset	205 %!assert (pinv (complex (0,0)), 0)
d3dc76efb38b Return correct value for pinv of zero vectors and scalars (bug #51246). Rik <rik@octave.org> parents: 23582 diff changeset	206 %!assert (pinv (complex ([0,0,0], [0,0,0])), [0; 0; 0])
d3dc76efb38b Return correct value for pinv of zero vectors and scalars (bug #51246). Rik <rik@octave.org> parents: 23582 diff changeset	207 %!assert (pinv (complex (single (0),0)), single (0))
d3dc76efb38b Return correct value for pinv of zero vectors and scalars (bug #51246). Rik <rik@octave.org> parents: 23582 diff changeset	208 %!assert (pinv (complex (single ([0,0,0]), [0,0,0])), single ([0; 0; 0]))
13042 ca7aaf2689c3 codesprint: 8 tests for pinv.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	209 */
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	210
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	211 OCTAVE_NAMESPACE_END

Mercurial > octave

annotate libinterp/corefcn/pinv.cc @ 29958:32c3a5805893