octave: libinterp/corefcn/pinv.cc annotate

annotate libinterp/corefcn/pinv.cc @ 21966:112b20240c87

move docstrings in C++ files out of C strings and into comments * __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc, __ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc, bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc, dlmread.cc, dot.cc, eig.cc, ellipj.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, hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.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, octave-link.cc, ordschur.cc, pager.cc, pinv.cc, pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc, sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.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, __eigs__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc, __init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc, audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc, convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc, ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc, ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc, ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc, ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc, ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc, ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc, pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy: Docstrings are now comments instead of C strings. * build-aux/mk-opts.pl: Emit docstrings as comments instead of C strings. * DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments. * builtins.h: Include builtin-defun-decls.h unconditionally. * defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration. (DEFALIAS): Always expand to nothing. * defun-dld.h: No special macro expansions for MAKE_BUILTINS. (DEFUN_DLD): Use FORWARD_DECLARE_FUN. (DEFUNX_DLD): Use FORWARD_DECLARE_FUNX. * defun-int.h: No special macro expansions for MAKE_BUILTINS. (FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros. (DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass "external-doc" to DEFINE_FUNX_INSTALLER_FUN. (DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL, DEFALIAS_INTERNAL): Delete. * common.mk (move_if_change_rule): New macro. (simple_move_if_change_rule): Define using move_if_change_rule. * find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file name extension to ".df". * libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files. * mkbuiltins: New argument, SRCDIR. Operate directly on source files. * mkdefs: Delete. * libinterp/module.mk (BUILT_SOURCES): Update list to contain only files included in other source files. (GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete. (LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here. (LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from the list. (libinterp_EXTRA_DIST): Remove mkdefs from the list. (FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES. (DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES. (SRC_DEFUN_FILES): Rename from SRC_DEF_FILES. (ALL_DEFUN_FILES): Rename from ALL_DEF_FILES. (%.df: %.cc): Delete pattern rule. (libinterp/build-env-features.cc, libinterp/builtins.cc, libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change. (libinterp/builtins.cc, libinterp/builtin-defun-decls.h): Update mkbuiltins command. ($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command. * liboctave/module.mk (BUILT_SOURCES): Don't include liboctave-build-info.cc in the list.

author	John W. Eaton <jwe@octave.org>
date	Tue, 21 Jun 2016 16:07:51 -0400
parents	aba2e6293dd8
children	bac0d6f07a3e

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: 18494 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: 5823 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: 5823 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: 5823 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: 5823 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
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	23 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	24 # include "config.h"
2928 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: 14179 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"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20941 diff changeset	29 #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	30 #include "ovl.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	31 #include "utils.h"
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	32 #include "ops.h"
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	33 #include "ov-re-diag.h"
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	34 #include "ov-cx-diag.h"
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	35 #include "ov-flt-re-diag.h"
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	36 #include "ov-flt-cx-diag.h"
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	37 #include "ov-perm.h"
2928 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: 14179 diff changeset	39 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	40 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	41 @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	42 @deftypefnx {} {} pinv (@var{x}, @var{tol})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	43 Return the pseudoinverse of @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	44
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	45 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	46
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	47 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	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 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	50 tol = max (size (@var{x})) * sigma_max (@var{x}) * eps,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	51 @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	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 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	54 where @code{sigma_max (@var{x})} is the maximal singular value of @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	55 @end deftypefn */)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	56 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	57 int nargin = args.length ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	58
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	59 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	60 print_usage ();
2928 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 octave_value arg = args(0);
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 int arg_is_empty = empty_arg ("pinv", arg.rows (), arg.columns ());
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	65
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	66 if (arg_is_empty < 0)
20941 a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()". Rik <rik@octave.org> parents: 20940 diff changeset	67 return ovl ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	68 else if (arg_is_empty > 0)
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21100 diff changeset	69 return ovl (Matrix ());
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	70
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	71 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	72
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	73 bool isfloat = arg.is_single_type ();
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	74
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	75 if (arg.is_diag_matrix ())
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	76 {
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	77 if (isfloat)
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	78 {
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	79 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	80 if (nargin == 2)
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	81 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	82
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	83 if (tol < 0.0)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20802 diff changeset	84 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	85
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	86 if (arg.is_real_type ())
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	87 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	88 else
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	89 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	90 }
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	91 else
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	92 {
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	93 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	94 if (nargin == 2)
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	95 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	96
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	97 if (tol < 0.0)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20802 diff changeset	98 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	99
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	100 if (arg.is_real_type ())
c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	101 retval = arg.diag_matrix_value ().pseudo_inverse (tol);
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	102 else
18467 c5a101de2d88 Allow pinv to work on Diagonal Matrices with a tolerance (bug #41546). Rik <rik@octave.org> parents: 17787 diff changeset	103 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	104 }
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	105 }
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	106 else if (arg.is_perm_matrix ())
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	107 {
8960 93f18f166aba remove float perm matrices Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	108 retval = arg.perm_matrix_value ().inverse ();
8840 c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	109 }
c690e3772583 support diagonal matrices in pinv Jaroslav Hajek <highegg@gmail.com> parents: 7789 diff changeset	110 else if (isfloat)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	111 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	112 float tol = 0.0;
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	113 if (nargin == 2)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	114 tol = args(1).float_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	115
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	116 if (tol < 0.0)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20802 diff changeset	117 error ("pinv: TOL must be greater than zero");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	118
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	119 if (arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	120 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	121 FloatMatrix m = arg.float_matrix_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	122
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	123 retval = m.pseudo_inverse (tol);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	124 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	125 else if (arg.is_complex_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	126 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	127 FloatComplexMatrix m = arg.float_complex_matrix_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	128
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	129 retval = m.pseudo_inverse (tol);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	130 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	131 else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20941 diff changeset	132 err_wrong_type_arg ("pinv", arg);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	133 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	134 else
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	135 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	136 double tol = 0.0;
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	137 if (nargin == 2)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	138 tol = args(1).double_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	139
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	140 if (tol < 0.0)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20802 diff changeset	141 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	142
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	143 if (arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	144 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	145 Matrix m = arg.matrix_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	146
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	147 retval = m.pseudo_inverse (tol);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	148 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	149 else if (arg.is_complex_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	150 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	151 ComplexMatrix m = arg.complex_matrix_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	152
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	153 retval = m.pseudo_inverse (tol);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	154 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	155 else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20941 diff changeset	156 err_wrong_type_arg ("pinv", arg);
2928 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
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	159 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	160 }
13042 ca7aaf2689c3 codesprint: 8 tests for pinv.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	161
ca7aaf2689c3 codesprint: 8 tests for pinv.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	162 /*
13079 9512d7272d5b codesprint: Fix tolerance for pinv test Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 13042 diff changeset	163 %!shared a, b, tol, hitol, d, u, x, y
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 15195 diff changeset	164 %! 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	165 %! 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	166 %! 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	167 %! hitol = 40*sqrt (eps);
13042 ca7aaf2689c3 codesprint: 8 tests for pinv.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	168 %! 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	169 %! 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	170 %! 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	171 %! y = pinv (x, sqrt (eps));
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	172 %!
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 %!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	174 %!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	175 %!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	176 %!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	177 %!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	178 %!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	179 %!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	180 %!assert ((yx)', yx, hitol)
18494 1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	181
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	182 ## Clear shared variables
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	183 %!shared
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	184
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	185 ## Test pinv for Diagonal matrices
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	186 %!test
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	187 %! x = diag ([3 2 1 0 -0.5]);
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	188 %! y = pinv (x);
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	189 %! assert (typeinfo (y)(1:8), "diagonal");
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	190 %! assert (isa (y, "double"));
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	191 %! assert (diag (y), [1/3, 1/2, 1, 0 1/-0.5]');
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	192 %! y = pinv (x, 1);
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	193 %! assert (diag (y), [1/3 1/2 1 0 0]');
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	194 %! y = pinv (x, 2);
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	195 %! assert (diag (y), [1/3 1/2 0 0 0]');
1fa5bba16218 [mq]: pinv Rik <rik@octave.org> parents: 18467 diff changeset	196
13042 ca7aaf2689c3 codesprint: 8 tests for pinv.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	197 */

Mercurial > octave

annotate libinterp/corefcn/pinv.cc @ 21966:112b20240c87