octave: libinterp/corefcn/schur.cc annotate

annotate libinterp/corefcn/schur.cc @ 21266:e69eaee28737

make better use of templates for Schur decomposition * liboctave/numeric/schur.h, liboctave/numeric/schur.cc: New files generated from SCHUR.h, SCHUR.cc, CmplxSCHUR.h, CmplxSCHUR.cc, dbleSCHUR.h, dbleSCHUR.cc, fCmplxSCHUR.h, fCmplxSCHUR.cc, floatSCHUR.h, and floatSCHUR.cc and making them templates. * liboctave/numeric/module.mk: Update. * libinterp/corefcn/schur.cc, sqrtm.cc, CMatrix.cc, dMatrix.cc, fCMatrix.cc, fMatrix.cc, mx-defs.h, mx-ext.h: Use new template classes and header file.

author	John W. Eaton <jwe@octave.org>
date	Mon, 15 Feb 2016 20:06:12 -0500
parents	fcac5dbbf9ed
children	40de9f8f23a6

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: 19403 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
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	23 #ifdef HAVE_CONFIG_H
21200 fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp. Rik <rik@octave.org> parents: 21139 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
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	27 #include <string>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	28
21266 e69eaee28737 make better use of templates for Schur decomposition John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	29 #include "schur.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	30
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	31 #include "defun.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	32 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21055 diff changeset	33 #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	34 #include "ovl.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	35 #include "utils.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	36
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21120 diff changeset	37 template <typename Matrix>
10617 9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	38 static octave_value
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	39 mark_upper_triangular (const Matrix& a)
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	40 {
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	41 octave_value retval = a;
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	42
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	43 octave_idx_type n = a.rows ();
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	44 assert (a.columns () == n);
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	45
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	46 const typename Matrix::element_type zero = typename Matrix::element_type ();
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	47
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	48 for (octave_idx_type i = 0; i < n; i++)
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	49 if (a(i,i) == zero)
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	50 return retval;
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	51
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	52 retval.matrix_type (MatrixType::Upper);
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	53
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	54 return retval;
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	55 }
9c9e07f5eb1c make schur mark triangular matrices on output Jaroslav Hajek <highegg@gmail.com> parents: 10607 diff changeset	56
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	57 DEFUN (schur, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	58 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20802 diff changeset	59 @deftypefn {} {@var{S} =} schur (@var{A})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20802 diff changeset	60 @deftypefnx {} {@var{S} =} schur (@var{A}, \"real\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20802 diff changeset	61 @deftypefnx {} {@var{S} =} schur (@var{A}, \"complex\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20802 diff changeset	62 @deftypefnx {} {@var{S} =} schur (@var{A}, @var{opt})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20802 diff changeset	63 @deftypefnx {} {[@var{U}, @var{S}] =} schur (@dots{})\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	64 @cindex Schur decomposition\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	65 Compute the Schur@tie{}decomposition of @var{A}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	66 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	67 The Schur@tie{}decomposition is defined as\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	68 @tex\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	69 $$\n\
7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	70 S = U^T A U\n\
7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	71 $$\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	72 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7814 diff changeset	73 @ifnottex\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	74 \n\
7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	75 @example\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	76 @code{@var{S} = @var{U}' * @var{A} * @var{U}}\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	77 @end example\n\
7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	78 \n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7814 diff changeset	79 @end ifnottex\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	80 where @var{U} is a unitary matrix\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	81 @tex\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	82 ($U^T U$ is identity)\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	83 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7814 diff changeset	84 @ifnottex\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	85 (@code{@var{U}'* @var{U}} is identity)\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7814 diff changeset	86 @end ifnottex\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	87 and @var{S} is upper triangular. The eigenvalues of @var{A} (and @var{S})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	88 are the diagonal elements of @var{S}. If the matrix @var{A} is real, then\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	89 the real Schur@tie{}decomposition is computed, in which the matrix @var{U}\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	90 is orthogonal and @var{S} is block upper triangular with blocks of size at\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	91 most\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	92 @tex\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	93 $2 \\times 2$\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	94 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7814 diff changeset	95 @ifnottex\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	96 @code{2 x 2}\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7814 diff changeset	97 @end ifnottex\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	98 along the diagonal. The diagonal elements of @var{S}\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	99 (or the eigenvalues of the\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	100 @tex\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	101 $2 \\times 2$\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	102 @end tex\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7814 diff changeset	103 @ifnottex\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	104 @code{2 x 2}\n\
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7814 diff changeset	105 @end ifnottex\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	106 blocks, when appropriate) are the eigenvalues of @var{A} and @var{S}.\n\
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	107 \n\
13224 0a67c717c652 Add support for additional argument "real" to schur() (Bug #34012). Rik <octave@nomad.inbox5.com> parents: 12642 diff changeset	108 The default for real matrices is a real Schur@tie{}decomposition.\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	109 A complex decomposition may be forced by passing the flag\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17268 diff changeset	110 @qcode{\"complex\"}.\n\
10607 f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	111 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	112 The eigenvalues are optionally ordered along the diagonal according to the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	113 value of @var{opt}. @code{@var{opt} = \"a\"} indicates that all eigenvalues\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	114 with negative real parts should be moved to the leading block of @var{S}\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	115 (used in @code{are}), @code{@var{opt} = \"d\"} indicates that all\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	116 eigenvalues with magnitude less than one should be moved to the leading\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	117 block of @var{S} (used in @code{dare}), and @code{@var{opt} = \"u\"}, the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	118 default, indicates that no ordering of eigenvalues should occur. The\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	119 leading @var{k} columns of @var{U} always span the @var{A}-invariant\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	120 subspace corresponding to the @var{k} leading eigenvalues of @var{S}.\n\
7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	121 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	122 The Schur@tie{}decomposition is used to compute eigenvalues of a square\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	123 matrix, and has applications in the solution of algebraic Riccati equations\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19747 diff changeset	124 in control (see @code{are} and @code{dare}).\n\
19747 56157a7505ed Add new ordschur function. Sébastien Villemot <sebastien@debian.org> parents: 19697 diff changeset	125 @seealso{rsf2csf, ordschur, lu, chol, hess, qr, qz, svd}\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3014 diff changeset	126 @end deftypefn")
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	127 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	128 int nargin = args.length ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	129
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	130 if (nargin < 1 \|\| nargin > 2 \|\| nargout > 2)
20802 8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	131 print_usage ();
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 octave_value arg = args(0);
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	134
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3372 diff changeset	135 std::string ord;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	136 if (nargin == 2)
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20582 diff changeset	137 ord = args(1).xstring_value ("schur: second argument must be a string");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	138
10607 f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	139 bool force_complex = false;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	140
13224 0a67c717c652 Add support for additional argument "real" to schur() (Bug #34012). Rik <octave@nomad.inbox5.com> parents: 12642 diff changeset	141 if (ord == "real")
0a67c717c652 Add support for additional argument "real" to schur() (Bug #34012). Rik <octave@nomad.inbox5.com> parents: 12642 diff changeset	142 {
21017 93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 20941 diff changeset	143 ord = "";
13224 0a67c717c652 Add support for additional argument "real" to schur() (Bug #34012). Rik <octave@nomad.inbox5.com> parents: 12642 diff changeset	144 }
0a67c717c652 Add support for additional argument "real" to schur() (Bug #34012). Rik <octave@nomad.inbox5.com> parents: 12642 diff changeset	145 else if (ord == "complex")
10607 f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	146 {
f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	147 force_complex = true;
21017 93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 20941 diff changeset	148 ord = "";
10607 f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	149 }
f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	150 else
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	151 {
10607 f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	152 char ord_char = ord.empty () ? 'U' : ord[0];
f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	153
f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	154 if (ord_char != 'U' && ord_char != 'A' && ord_char != 'D'
f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	155 && ord_char != 'u' && ord_char != 'a' && ord_char != 'd')
f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	156 {
19016 b155fad47055 Fix error messages and %!fail tests for schur(). Rik <rik@octave.org> parents: 17787 diff changeset	157 warning ("schur: incorrect ordered schur argument '%s'",
10607 f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	158 ord.c_str ());
20941 a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()". Rik <rik@octave.org> parents: 20940 diff changeset	159 return ovl ();
10607 f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	160 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	161 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	162
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5008 diff changeset	163 octave_idx_type nr = arg.rows ();
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5008 diff changeset	164 octave_idx_type nc = arg.columns ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	165
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	166 if (nr != nc)
21110 3d0d84305600 Use err_square_matrix_required more widely. Rik <rik@octave.org> parents: 21100 diff changeset	167 err_square_matrix_required ("schur", "A");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	168
21120 499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	169 if (! arg.is_numeric_type ())
499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	170 err_wrong_type_arg ("schur", arg);
499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	171
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	172 octave_value_list retval;
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	173
21120 499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	174 if (arg.is_single_type ())
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	175 {
10607 f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	176 if (! force_complex && arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	177 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	178 FloatMatrix tmp = arg.float_matrix_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	179
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	180 if (nargout <= 1)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	181 {
21266 e69eaee28737 make better use of templates for Schur decomposition John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	182 schur<FloatMatrix> result (tmp, ord, false);
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	183 retval = ovl (result.schur_matrix ());
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	184 }
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	185 else
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	186 {
21266 e69eaee28737 make better use of templates for Schur decomposition John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	187 schur<FloatMatrix> result (tmp, ord, true);
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	188 retval = ovl (result.unitary_matrix (),
c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	189 result.schur_matrix ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	190 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	191 }
10607 f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	192 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	193 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	194 FloatComplexMatrix ctmp = arg.float_complex_matrix_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	195
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	196 if (nargout <= 1)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	197 {
21266 e69eaee28737 make better use of templates for Schur decomposition John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	198 schur<FloatComplexMatrix> result (ctmp, ord, false);
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	199 retval = ovl (mark_upper_triangular (result.schur_matrix ()));
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	200 }
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	201 else
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	202 {
21266 e69eaee28737 make better use of templates for Schur decomposition John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	203 schur<FloatComplexMatrix> result (ctmp, ord, true);
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	204 retval = ovl (result.unitary_matrix (),
c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	205 mark_upper_triangular (result.schur_matrix ()));
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	206 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	207 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	208 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	209 else
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	210 {
10607 f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	211 if (! force_complex && arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	212 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	213 Matrix tmp = arg.matrix_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	214
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	215 if (nargout <= 1)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	216 {
21266 e69eaee28737 make better use of templates for Schur decomposition John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	217 schur<Matrix> result (tmp, ord, false);
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	218 retval = ovl (result.schur_matrix ());
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	219 }
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	220 else
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	221 {
21266 e69eaee28737 make better use of templates for Schur decomposition John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	222 schur<Matrix> result (tmp, ord, true);
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	223 retval = ovl (result.unitary_matrix (),
c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	224 result.schur_matrix ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	225 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	226 }
10607 f7501986e42d make schur more Matlab compatible Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	227 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	228 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	229 ComplexMatrix ctmp = arg.complex_matrix_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	230
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	231 if (nargout <= 1)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	232 {
21266 e69eaee28737 make better use of templates for Schur decomposition John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	233 schur<ComplexMatrix> result (ctmp, ord, false);
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	234 retval = ovl (mark_upper_triangular (result.schur_matrix ()));
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	235 }
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	236 else
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	237 {
21266 e69eaee28737 make better use of templates for Schur decomposition John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	238 schur<ComplexMatrix> result (ctmp, ord, true);
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	239 retval = ovl (result.unitary_matrix (),
c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	240 mark_upper_triangular (result.schur_matrix ()));
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	241 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9758 diff changeset	242 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	243 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	244
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	245 return retval;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	246 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	247
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	248 /*
7814 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 %! a = [1, 2, 3; 4, 5, 9; 7, 8, 6];
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	251 %! [u, s] = schur (a);
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14460 diff changeset	252 %! assert (u' * a * u, s, 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	253
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	254 %!test
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14460 diff changeset	255 %! a = single ([1, 2, 3; 4, 5, 9; 7, 8, 6]);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	256 %! [u, s] = schur (a);
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14460 diff changeset	257 %! assert (u' * a * u, s, 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	258
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14460 diff changeset	259 %!error schur ()
19016 b155fad47055 Fix error messages and %!fail tests for schur(). Rik <rik@octave.org> parents: 17787 diff changeset	260 %!error schur (1,2,3)
b155fad47055 Fix error messages and %!fail tests for schur(). Rik <rik@octave.org> parents: 17787 diff changeset	261 %!error [a,b,c] = schur (1)
21110 3d0d84305600 Use err_square_matrix_required more widely. Rik <rik@octave.org> parents: 21100 diff changeset	262 %!error <must be a square matrix> schur ([1, 2, 3; 4, 5, 6])
19016 b155fad47055 Fix error messages and %!fail tests for schur(). Rik <rik@octave.org> parents: 17787 diff changeset	263 %!error <wrong type argument 'cell'> schur ({1})
19034 f707835af867 Rewrite schur built-in test as a %!warning to stop failure during 'make check' Rik <rik@octave.org> parents: 19016 diff changeset	264 %!warning <incorrect ordered schur argument> schur ([1, 2; 3, 4], "bad_opt");
f707835af867 Rewrite schur built-in test as a %!warning to stop failure during 'make check' Rik <rik@octave.org> parents: 19016 diff changeset	265
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	266 */
10822 23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	267
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	268 DEFUN (rsf2csf, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	269 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20802 diff changeset	270 @deftypefn {} {[@var{U}, @var{T}] =} rsf2csf (@var{UR}, @var{TR})\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	271 Convert a real, upper quasi-triangular Schur@tie{}form @var{TR} to a complex,\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	272 upper triangular Schur@tie{}form @var{T}.\n\
10822 23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	273 \n\
12642 f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	274 Note that the following relations hold:\n\
10822 23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	275 \n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	276 @tex\n\
7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	277 $UR \\cdot TR \\cdot {UR}^T = U T U^{\\dagger}$ and\n\
7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	278 $U^{\\dagger} U$ is the identity matrix I.\n\
7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	279 @end tex\n\
7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	280 @ifnottex\n\
17268 1c21f264d26f doc: Rename @xcode macro to @tcode (transpose code) for clarity. Rik <rik@octave.org> parents: 16920 diff changeset	281 @tcode{@var{UR} * @var{TR} * @var{UR}' = @var{U} * @var{T} * @var{U}'} and\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	282 @code{@var{U}' * @var{U}} is the identity matrix I.\n\
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	283 @end ifnottex\n\
10822 23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	284 \n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	285 Note also that @var{U} and @var{T} are not unique.\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	286 @seealso{schur}\n\
10822 23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	287 @end deftypefn")
23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	288 {
20802 8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	289 if (args.length () != 2 \|\| nargout > 2)
8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	290 print_usage ();
8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	291
8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	292 if (! args(0).is_numeric_type ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21055 diff changeset	293 err_wrong_type_arg ("rsf2csf", args(0));
21120 499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	294 if (! args(1).is_numeric_type ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21055 diff changeset	295 err_wrong_type_arg ("rsf2csf", args(1));
21120 499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	296 if (args(0).is_complex_type () \|\| args(1).is_complex_type ())
20802 8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	297 error ("rsf2csf: UR and TR must be real matrices");
21120 499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	298
499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	299 if (args(0).is_single_type () \|\| args(1).is_single_type ())
499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	300 {
499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	301 FloatMatrix u = args(0).float_matrix_value ();
499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	302 FloatMatrix t = args(1).float_matrix_value ();
499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	303
21266 e69eaee28737 make better use of templates for Schur decomposition John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	304 schur<FloatComplexMatrix> cs
e69eaee28737 make better use of templates for Schur decomposition John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	305 = rsf2csf<FloatComplexMatrix, FloatMatrix> (t, u);
21120 499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	306
499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	307 return ovl (cs.unitary_matrix (), cs.schur_matrix ());
499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	308 }
20802 8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	309 else
10822 23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	310 {
21120 499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	311 Matrix u = args(0).matrix_value ();
499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	312 Matrix t = args(1).matrix_value ();
20802 8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	313
21266 e69eaee28737 make better use of templates for Schur decomposition John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	314 schur<ComplexMatrix> cs = rsf2csf<ComplexMatrix, Matrix> (t, u);
10822 23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	315
21120 499b851fbfae Replace pattern if/err_XXX/else/code with if/err_XXX/ code. Rik <rik@octave.org> parents: 21110 diff changeset	316 return ovl (cs.unitary_matrix (), cs.schur_matrix ());
10822 23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	317 }
23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	318 }
23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	319
23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	320 /*
23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	321 %!test
23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	322 %! A = [1, 1, 1, 2; 1, 2, 1, 1; 1, 1, 3, 1; -2, 1, 1, 1];
23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	323 %! [u, t] = schur (A);
23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	324 %! [U, T] = rsf2csf (u, t);
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14460 diff changeset	325 %! assert (norm (u * t * u' - U * T * U'), 0, 1e-12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14460 diff changeset	326 %! assert (norm (A - U * T * U'), 0, 1e-12);
10822 23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	327
23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	328 %!test
23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	329 %! A = rand (10);
23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	330 %! [u, t] = schur (A);
23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	331 %! [U, T] = rsf2csf (u, t);
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14460 diff changeset	332 %! assert (norm (tril (T, -1)), 0);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14460 diff changeset	333 %! assert (norm (U * U'), 1, 1e-14);
10822 23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	334
14460 6c3441f3146b Fix logm for complex matrix with real eigenvalues (bug #34893). Marco Caliari <marco.caliari@univr.it> parents: 14138 diff changeset	335 %!test
6c3441f3146b Fix logm for complex matrix with real eigenvalues (bug #34893). Marco Caliari <marco.caliari@univr.it> parents: 14138 diff changeset	336 %! A = [0, 1;-1, 0];
6c3441f3146b Fix logm for complex matrix with real eigenvalues (bug #34893). Marco Caliari <marco.caliari@univr.it> parents: 14138 diff changeset	337 %! [u, t] = schur (A);
6c3441f3146b Fix logm for complex matrix with real eigenvalues (bug #34893). Marco Caliari <marco.caliari@univr.it> parents: 14138 diff changeset	338 %! [U, T] = rsf2csf (u,t);
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14460 diff changeset	339 %! assert (U * T * U', A, 1e-14);
10822 23d2378512a0 implement rsf2csf Jaroslav Hajek <highegg@gmail.com> parents: 10617 diff changeset	340 */

Mercurial > octave

annotate libinterp/corefcn/schur.cc @ 21266:e69eaee28737