annotate scripts/polynomial/polyeig.m @ 16933:e39f00a32dc7

maint: Use parentheses around condition for switch(),while(),if() statements. * libinterp/corefcn/dirfns.cc, libinterp/octave-value/ov-fcn-handle.cc, liboctave/array/Sparse.cc, scripts/image/rgb2ind.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/optimization/fminbnd.m, scripts/optimization/sqp.m, scripts/plot/graphics_toolkit.m, scripts/plot/hdl2struct.m, scripts/plot/legend.m, scripts/plot/print.m, scripts/plot/printd.m, scripts/plot/private/__contour__.m, scripts/plot/private/__go_draw_axes__.m, scripts/plot/struct2hdl.m, scripts/polynomial/polyeig.m, scripts/sparse/bicg.m, scripts/specfun/ellipke.m, scripts/special-matrix/gallery.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m, scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use parentheses around condition for switch(),while(),if() statements.
author Rik <rik@octave.org>
date Tue, 09 Jul 2013 14:04:05 -0700
parents e3dc9ff8e0f2
children 1c89599167a6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15189
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
1 ## Copyright (C) 2012 Fotios Kasolis
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
2 ##
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
3 ## This file is part of Octave.
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
4 ##
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
6 ## under the terms of the GNU General Public License as published by
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
8 ## your option) any later version.
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
9 ##
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
13 ## General Public License for more details.
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
14 ##
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
15 ## You should have received a copy of the GNU General Public License
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
17 ## <http://www.gnu.org/licenses/>.
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
18
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
19 ## -*- texinfo -*-
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
20 ## @deftypefn {Function File} {@var{z} =} polyeig (@var{C0}, @var{C1}, @dots{}, @var{Cl})
15222
e3dc9ff8e0f2 polyeig.m: Use @code, not @var, macro to silence warnings from texinfo.
Rik <rik@octave.org>
parents: 15197
diff changeset
21 ## @deftypefnx {Function File} {[@var{v}, @var{z}] =} polyeig (@var{C0}, @var{C1}, @dots{}, @var{Cl})
15190
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
22 ##
15189
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
23 ## Solve the polynomial eigenvalue problem of degree @var{l}.
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
24 ##
15222
e3dc9ff8e0f2 polyeig.m: Use @code, not @var, macro to silence warnings from texinfo.
Rik <rik@octave.org>
parents: 15197
diff changeset
25 ## Given an @var{n*n} matrix polynomial
e3dc9ff8e0f2 polyeig.m: Use @code, not @var, macro to silence warnings from texinfo.
Rik <rik@octave.org>
parents: 15197
diff changeset
26 ## @code{@var{C}(s) = @var{C0} + @var{C1} s + @dots{} + @var{Cl} s^l}
e3dc9ff8e0f2 polyeig.m: Use @code, not @var, macro to silence warnings from texinfo.
Rik <rik@octave.org>
parents: 15197
diff changeset
27 ## polyeig solves the eigenvalue problem
e3dc9ff8e0f2 polyeig.m: Use @code, not @var, macro to silence warnings from texinfo.
Rik <rik@octave.org>
parents: 15197
diff changeset
28 ## @code{(@var{C0} + @var{C1} + @dots{} + @var{Cl})v = 0}.
e3dc9ff8e0f2 polyeig.m: Use @code, not @var, macro to silence warnings from texinfo.
Rik <rik@octave.org>
parents: 15197
diff changeset
29 ## Note that the eigenvalues @var{z} are the zeros of the matrix polynomial.
e3dc9ff8e0f2 polyeig.m: Use @code, not @var, macro to silence warnings from texinfo.
Rik <rik@octave.org>
parents: 15197
diff changeset
30 ## @var{z} is an @var{lxn} vector and @var{v} is an (@var{n} x @var{n})l matrix
e3dc9ff8e0f2 polyeig.m: Use @code, not @var, macro to silence warnings from texinfo.
Rik <rik@octave.org>
parents: 15197
diff changeset
31 ## with columns that correspond to the eigenvectors.
15190
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
32 ##
15189
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
33 ## @seealso{eig, eigs, compan}
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
34 ## @end deftypefn
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
35
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
36 ## Author: Fotios Kasolis
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
37
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
38 function [ z, varargout ] = polyeig (varargin)
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
39
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
40 if ( nargout > 2 )
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
41 print_usage ();
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
42 endif
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
43
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
44 nin = numel (varargin);
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
45
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
46 n = zeros (1, nin);
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
47
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
48 for cnt = 1 : nin
16933
e39f00a32dc7 maint: Use parentheses around condition for switch(),while(),if() statements.
Rik <rik@octave.org>
parents: 15222
diff changeset
49 if (! issquare (varargin{cnt}))
15189
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
50 error ("polyeig: coefficients must be square matrices");
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
51 endif
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
52 n(cnt) = size (varargin{cnt}, 1);
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
53 endfor
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
54
16933
e39f00a32dc7 maint: Use parentheses around condition for switch(),while(),if() statements.
Rik <rik@octave.org>
parents: 15222
diff changeset
55 if (numel (unique (n)) > 1)
15189
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
56 error ("polyeig: coefficients must have the same dimensions");
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
57 endif
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
58 n = unique (n);
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
59
15190
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
60 ## matrix polynomial degree
15189
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
61 l = nin - 1;
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
62
15190
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
63 ## form needed matrices
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
64 C = [ zeros(n * (l - 1), n), eye(n * (l - 1));
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
65 -cell2mat(varargin(1 : end - 1)) ];
15189
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
66
15190
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
67 D = [ eye(n * (l - 1)), zeros(n * (l - 1), n);
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
68 zeros(n, n * (l - 1)), varargin{end} ];
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
69
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
70 ## solve generalized eigenvalue problem
15189
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
71 if ( isequal (nargout, 1) )
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
72 z = eig (C, D);
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
73 else
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
74 [ z, v ] = eig (C, D);
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
75 varargout{1} = v;
15190
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
76 ## return n-element eigenvectors normalized so
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
77 ## that the infinity-norm = 1
15189
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
78 z = z(1:n,:);
15190
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
79 ## max() takes the abs if complex:
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
80 t = max (z);
ee9b1270c25a polyeig.m: Style fixes
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15189
diff changeset
81 z /= diag (t);
15189
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
82 endif
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
83
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
84 endfunction
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
85
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
86 %!test
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
87 %! C0 = [8, 0; 0, 4]; C1 = [1, 0; 0, 1];
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
88 %! [v,z] = polyeig (C0, C1);
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
89 %! assert (isequal (z(1), -8), true);
15197
0c0f4eef30f4 * polyeig.m: Missing semicolon in test.
John W. Eaton <jwe@octave.org>
parents: 15190
diff changeset
90 %! d = C0*v + C1*v*z;
15189
2ad5e6212cd7 polyeig: remove DOS newlines
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15187
diff changeset
91 %! assert (isequal (norm(d), 0.0), true);