octave: libinterp/corefcn/svd.cc annotate

annotate libinterp/corefcn/svd.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	469c817eb256

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: 17787 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: 6620 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: 6620 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: 6620 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: 6620 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: 21273 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
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	27 #include "svd.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	28
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	29 #include "defun.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	30 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20940 diff changeset	31 #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	32 #include "ovl.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	33 #include "pr-output.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	34 #include "utils.h"
10638 e1559a8a60b4 general mechanism for string enum variables Jaroslav Hajek <highegg@gmail.com> parents: 10601 diff changeset	35 #include "variables.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	36
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	37 static std::string Vsvd_driver = "gesvd";
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	38
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	39 template <typename T>
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	40 static typename svd<T>::type
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	41 svd_type (int nargin, int nargout)
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	42 {
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	43 return ((nargout == 0 \|\| nargout == 1)
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	44 ? svd<T>::sigma_only
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	45 : (nargin == 2) ? svd<T>::economy : svd<T>::std);
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	46 }
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	47
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	48 template <typename T>
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	49 static typename svd<T>::driver
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	50 svd_driver (void)
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	51 {
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	52 return Vsvd_driver == "gesvd" ? svd<T>::GESVD : svd<T>::GESDD;
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	53 }
10601 3ce0c530a9c9 implement svd_driver Jaroslav Hajek <highegg@gmail.com> parents: 10185 diff changeset	54
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	55 DEFUN (svd, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	56 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	57 @deftypefn {} {@var{s} =} svd (@var{A})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	58 @deftypefnx {} {[@var{U}, @var{S}, @var{V}] =} svd (@var{A})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	59 @deftypefnx {} {[@var{U}, @var{S}, @var{V}] =} svd (@var{A}, @var{econ})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	60 @cindex singular value decomposition
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	61 Compute the singular value decomposition of @var{A}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	62 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	63 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	64 A = U S V^{\dagger}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	65 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	66 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	67 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	68
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	69 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	70 A = USV'
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	71 @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	72
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	73 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	74
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	75 The function @code{svd} normally returns only the vector of singular values.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	76 When called with three return values, it computes
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	77 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	78 $U$, $S$, and $V$.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	79 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	80 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	81 @var{U}, @var{S}, and @var{V}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	82 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	83 For example,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	84
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	85 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	86 svd (hilb (3))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	87 @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	88
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	89 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	90 returns
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	91
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	92 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	93 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	94 ans =
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	95
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	96 1.4083189
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	97 0.1223271
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	98 0.0026873
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	99 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	100 @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	101
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	102 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	103 and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	104
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	105 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	106 [u, s, v] = svd (hilb (3))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	107 @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	108
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	109 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	110 returns
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	111
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	112 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	113 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	114 u =
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	115
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	116 -0.82704 0.54745 0.12766
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	117 -0.45986 -0.52829 -0.71375
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	118 -0.32330 -0.64901 0.68867
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	119
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	120 s =
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	121
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	122 1.40832 0.00000 0.00000
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	123 0.00000 0.12233 0.00000
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	124 0.00000 0.00000 0.00269
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	125
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	126 v =
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	127
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	128 -0.82704 0.54745 0.12766
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	129 -0.45986 -0.52829 -0.71375
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	130 -0.32330 -0.64901 0.68867
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	131 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	132 @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	133
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	134 If given a second argument, @code{svd} returns an economy-sized
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	135 decomposition, eliminating the unnecessary rows or columns of @var{U} or
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	136 @var{V}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	137 @seealso{svd_driver, svds, eig, lu, chol, hess, qr, qz}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	138 @end deftypefn */)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	139 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	140 int nargin = args.length ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	141
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	142 if (nargin < 1 \|\| nargin > 2 \|\| nargout == 2 \|\| nargout > 3)
20535 b70cc4bd8109 begin removal of global error_state variable John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	143 print_usage ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	144
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	145 octave_value arg = args(0);
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	146
10185 455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	147 if (arg.ndims () != 2)
20535 b70cc4bd8109 begin removal of global error_state variable John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	148 error ("svd: A must be a 2-D matrix");
10185 455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	149
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20873 diff changeset	150 octave_value_list retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20873 diff changeset	151
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	152 bool isfloat = arg.is_single_type ();
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	153
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	154 if (isfloat)
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	155 {
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	156 if (arg.is_real_type ())
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	157 {
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	158 FloatMatrix tmp = arg.float_matrix_value ();
10638 e1559a8a60b4 general mechanism for string enum variables Jaroslav Hajek <highegg@gmail.com> parents: 10601 diff changeset	159
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	160 if (tmp.any_element_is_inf_or_nan ())
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	161 error ("svd: cannot take SVD of matrix containing Inf or NaN values");
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	162
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	163 svd<FloatMatrix> result (tmp,
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	164 svd_type<FloatMatrix> (nargin, nargout),
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	165 svd_driver<FloatMatrix> ());
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	166
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	167 FloatDiagMatrix sigma = result.singular_values ();
20535 b70cc4bd8109 begin removal of global error_state variable John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	168
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	169 if (nargout == 0 \|\| nargout == 1)
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	170 retval(0) = sigma.extract_diag ();
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	171 else
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	172 retval = ovl (result.left_singular_matrix (),
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	173 sigma,
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	174 result.right_singular_matrix ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	175 }
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	176 else if (arg.is_complex_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	177 {
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	178 FloatComplexMatrix ctmp = arg.float_complex_matrix_value ();
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	179
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	180 if (ctmp.any_element_is_inf_or_nan ())
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	181 error ("svd: cannot take SVD of matrix containing Inf or NaN values");
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	182
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	183 svd<FloatComplexMatrix> result (ctmp,
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	184 svd_type<FloatComplexMatrix> (nargin, nargout),
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	185 svd_driver<FloatComplexMatrix> ());
20535 b70cc4bd8109 begin removal of global error_state variable John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	186
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	187 FloatDiagMatrix sigma = result.singular_values ();
20535 b70cc4bd8109 begin removal of global error_state variable John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	188
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	189 if (nargout == 0 \|\| nargout == 1)
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	190 retval(0) = sigma.extract_diag ();
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	191 else
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	192 retval = ovl (result.left_singular_matrix (),
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	193 sigma,
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	194 result.right_singular_matrix ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	195 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	196 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	197 else
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	198 {
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	199 if (arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	200 {
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	201 Matrix tmp = arg.matrix_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	202
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	203 if (tmp.any_element_is_inf_or_nan ())
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	204 error ("svd: cannot take SVD of matrix containing Inf or NaN values");
4478 7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe] jwe parents: 3548 diff changeset	205
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	206 svd<Matrix> result (tmp,
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	207 svd_type<Matrix> (nargin, nargout),
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	208 svd_driver<Matrix> ());
20535 b70cc4bd8109 begin removal of global error_state variable John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	209
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	210 DiagMatrix sigma = result.singular_values ();
4478 7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe] jwe parents: 3548 diff changeset	211
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	212 if (nargout == 0 \|\| nargout == 1)
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	213 retval(0) = sigma.extract_diag ();
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	214 else
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	215 retval = ovl (result.left_singular_matrix (),
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	216 sigma,
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	217 result.right_singular_matrix ());
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	218 }
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	219 else if (arg.is_complex_type ())
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	220 {
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	221 ComplexMatrix ctmp = arg.complex_matrix_value ();
4478 7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe] jwe parents: 3548 diff changeset	222
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	223 if (ctmp.any_element_is_inf_or_nan ())
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	224 error ("svd: cannot take SVD of matrix containing Inf or NaN values");
4478 7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe] jwe parents: 3548 diff changeset	225
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	226 svd<ComplexMatrix> result (ctmp,
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	227 svd_type<ComplexMatrix> (nargin, nargout),
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	228 svd_driver<ComplexMatrix> ());
4478 7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe] jwe parents: 3548 diff changeset	229
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	230 DiagMatrix sigma = result.singular_values ();
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	231
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	232 if (nargout == 0 \|\| nargout == 1)
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	233 retval(0) = sigma.extract_diag ();
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	234 else
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	235 retval = ovl (result.left_singular_matrix (),
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	236 sigma,
cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	237 result.right_singular_matrix ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	238 }
4478 7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe] jwe parents: 3548 diff changeset	239 else
21273 cbced1c09916 better use of templates for svd classes John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	240 err_wrong_type_arg ("svd", arg);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	241 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	242
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	243 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	244 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	245
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	246 /*
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	247 %!assert (svd ([1, 2; 2, 1]), [3; 1], sqrt (eps))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	248
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	249 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	250 %! [u, s, v] = svd ([1, 2; 2, 1]);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	251 %! x = 1 / sqrt (2);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	252 %! assert (u, [-x, -x; -x, x], sqrt (eps));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	253 %! assert (s, [3, 0; 0, 1], sqrt (eps));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	254 %! assert (v, [-x, x; -x, -x], sqrt (eps));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	255
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	256 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	257 %! a = [1, 2, 3; 4, 5, 6];
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	258 %! [u, s, v] = svd (a);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	259 %! assert (u * s * v', a, sqrt (eps));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	260
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	261 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	262 %! a = [1, 2; 3, 4; 5, 6];
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	263 %! [u, s, v] = svd (a);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	264 %! assert (u * s * v', a, sqrt (eps));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	265
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	266 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	267 %! a = [1, 2, 3; 4, 5, 6];
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	268 %! [u, s, v] = svd (a, 1);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	269 %! assert (u * s * v', a, sqrt (eps));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	270
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	271 %!test
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	272 %! a = [1, 2; 3, 4; 5, 6];
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	273 %! [u, s, v] = svd (a, 1);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	274 %! assert (u * s * v', a, sqrt (eps));
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	275
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	276 %!assert (svd (single ([1, 2; 2, 1])), single ([3; 1]), 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	277
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	278 %!test
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	279 %! [u, s, v] = svd (single ([1, 2; 2, 1]));
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	280 %! x = single (1 / sqrt (2));
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	281 %! assert (u, [-x, -x; -x, x], sqrt (eps ("single")));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	282 %! assert (s, single ([3, 0; 0, 1]), sqrt (eps ("single")));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	283 %! assert (v, [-x, x; -x, -x], 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	284
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	285 %!test
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	286 %! a = single ([1, 2, 3; 4, 5, 6]);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	287 %! [u, s, v] = svd (a);
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	288 %! assert (u * s * v', a, 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	289
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	290 %!test
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	291 %! a = single ([1, 2; 3, 4; 5, 6]);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	292 %! [u, s, v] = svd (a);
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	293 %! assert (u * s * v', a, 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	294
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	295 %!test
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	296 %! a = single ([1, 2, 3; 4, 5, 6]);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	297 %! [u, s, v] = svd (a, 1);
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	298 %! assert (u * s * v', a, 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	299
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	300 %!test
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	301 %! a = single ([1, 2; 3, 4; 5, 6]);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	302 %! [u, s, v] = svd (a, 1);
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	303 %! assert (u * s * v', a, 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	304
10185 455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	305 %!test
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	306 %! a = zeros (0, 5);
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	307 %! [u, s, v] = svd (a);
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	308 %! assert (size (u), [0, 0]);
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	309 %! assert (size (s), [0, 5]);
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	310 %! assert (size (v), [5, 5]);
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	311
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	312 %!test
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	313 %! a = zeros (5, 0);
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	314 %! [u, s, v] = svd (a, 1);
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	315 %! assert (size (u), [5, 0]);
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	316 %! assert (size (s), [0, 0]);
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	317 %! assert (size (v), [0, 0]);
455759a5fcbe fix norm and svd on empty matrices Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	318
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	319 %!error svd ()
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	320 %!error svd ([1, 2; 4, 5], 2, 3)
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	321 %!error [u, v] = svd ([1, 2; 3, 4])
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	322 */
10601 3ce0c530a9c9 implement svd_driver Jaroslav Hajek <highegg@gmail.com> parents: 10185 diff changeset	323
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	324 DEFUN (svd_driver, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	325 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	326 @deftypefn {} {@var{val} =} svd_driver ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	327 @deftypefnx {} {@var{old_val} =} svd_driver (@var{new_val})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	328 @deftypefnx {} {} svd_driver (@var{new_val}, "local")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	329 Query or set the underlying @sc{lapack} driver used by @code{svd}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	330
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	331 Currently recognized values are @qcode{"gesvd"} and @qcode{"gesdd"}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	332 The default is @qcode{"gesvd"}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	333
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	334 When called from inside a function with the @qcode{"local"} option, the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	335 variable is changed locally for the function and any subroutines it calls.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	336 The original variable value is restored when exiting the function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	337 @seealso{svd}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	338 @end deftypefn */)
10601 3ce0c530a9c9 implement svd_driver Jaroslav Hajek <highegg@gmail.com> parents: 10185 diff changeset	339 {
10640 5c594472f75e determine string enum length by trailing null rather than sizeof Jaroslav Hajek <highegg@gmail.com> parents: 10638 diff changeset	340 static const char *driver_names[] = { "gesvd", "gesdd", 0 };
10601 3ce0c530a9c9 implement svd_driver Jaroslav Hajek <highegg@gmail.com> parents: 10185 diff changeset	341
10638 e1559a8a60b4 general mechanism for string enum variables Jaroslav Hajek <highegg@gmail.com> parents: 10601 diff changeset	342 return SET_INTERNAL_VARIABLE_CHOICES (svd_driver, driver_names);
10601 3ce0c530a9c9 implement svd_driver Jaroslav Hajek <highegg@gmail.com> parents: 10185 diff changeset	343 }
15887 8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	344
8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	345 /*
8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	346 %!test
8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	347 %! A = [1+1i, 1-1i, 0; 0, 2, 0; 1i, 1i, 1+2i];
8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	348 %! old_driver = svd_driver ("gesvd");
8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	349 %! [U1, S1, V1] = svd (A);
8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	350 %! svd_driver ("gesdd");
8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	351 %! [U2, S2, V2] = svd (A);
8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	352 %! assert (U1, U2, 5*eps);
8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	353 %! assert (S1, S2, 5*eps);
8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	354 %! assert (V1, V2, 5*eps);
8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	355 %! svd_driver (old_driver);
8ced82e96b48 Fix segfaults with gesdd driver for svd (bug #37998). Rik <rik@octave.org> parents: 14138 diff changeset	356 */

Mercurial > octave

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