annotate scripts/control/lyap.m @ 3397:1a8e2c0d627a

[project @ 1999-12-18 03:02:18 by jwe]
author jwe
date Sat, 18 Dec 1999 03:02:45 +0000
parents 8dd4718801fd
children 0f515bc98460
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3397
1a8e2c0d627a [project @ 1999-12-18 03:02:18 by jwe]
jwe
parents: 3346
diff changeset
1 ## Copyright (C) 1996, 1997 Auburn University. All rights reserved.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
6 ## under the terms of the GNU General Public License as published by
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
8 ## any later version.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
15 ## You should have received a copy of the GNU General Public License
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
18 ## 02111-1307, USA.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 73
diff changeset
19
3346
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
20 ## -*- texinfo -*-
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
21 ## @deftypefn {Function File} {} lyap (@var{a}, @var{b}, @var{c})
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
22 ## @deftypefnx {Function File} {} lyap (@var{a}, @var{b})
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
23 ## Solve the Lyapunov (or Sylvester) equation via the Bartels-Stewart
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
24 ## algorithm (Communications of the ACM, 1972).
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
25 ##
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
26 ## If @var{a}, @var{b}, and @var{c} are specified, then @code{lyap} returns
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
27 ## the solution of the Sylvester equation
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
28 ## @iftex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
29 ## @tex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
30 ## $$ A X + X B + C = 0 $$
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
31 ## @end tex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
32 ## @end iftex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
33 ## @ifinfo
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
34 ## @example
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
35 ## a x + x b + c = 0
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
36 ## @end example
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
37 ## @end ifinfo
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
38 ## If only @code{(a, b)} are specified, then @code{lyap} returns the
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
39 ## solution of the Lyapunov equation
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
40 ## @iftex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
41 ## @tex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
42 ## $$ A^T X + X A + B = 0 $$
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
43 ## @end tex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
44 ## @end iftex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
45 ## @ifinfo
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
46 ## @example
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
47 ## a' x + x a + b = 0
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
48 ## @end example
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
49 ## @end ifinfo
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
50 ## If @var{b} is not square, then @code{lyap} returns the solution of either
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
51 ## @iftex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
52 ## @tex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
53 ## $$ A^T X + X A + B^T B = 0 $$
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
54 ## @end tex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
55 ## @end iftex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
56 ## @ifinfo
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
57 ## @example
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
58 ## a' x + x a + b' b = 0
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
59 ## @end example
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
60 ## @end ifinfo
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
61 ## @noindent
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
62 ## or
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
63 ## @iftex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
64 ## @tex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
65 ## $$ A X + X A^T + B B^T = 0 $$
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
66 ## @end tex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
67 ## @end iftex
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
68 ## @ifinfo
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
69 ## @example
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
70 ## a x + x a' + b b' = 0
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
71 ## @end example
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
72 ## @end ifinfo
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
73 ## @noindent
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
74 ## whichever is appropriate.
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
75 ##
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
76 ## Solves by using the Bartels-Stewart algorithm (1972).
3346
8dd4718801fd [project @ 1999-11-09 18:18:12 by jwe]
jwe
parents: 3279
diff changeset
77 ## @end deftypefn
40
adade67872a7 [project @ 1993-08-10 22:15:36 by jwe]
jwe
parents:
diff changeset
78
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
79 ## Author: A. S. Hodel <scotte@eng.auburn.edu>
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
80 ## Created: August 1993
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
81 ## Adapted-By: jwe
73
f3c9042fd609 [project @ 1993-08-30 14:49:08 by jwe]
jwe
parents: 57
diff changeset
82
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
83 function x = lyap (a, b, c)
40
adade67872a7 [project @ 1993-08-10 22:15:36 by jwe]
jwe
parents:
diff changeset
84
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
85 if (nargin != 3 && nargin != 2)
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 245
diff changeset
86 usage ("lyap (a, b {,c})");
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
87 endif
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
88
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
89 if ((n = is_square(a)) == 0)
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
90 error ("lyap: a is not square");
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
91 endif
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
92
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
93 if (nargin == 2)
40
adade67872a7 [project @ 1993-08-10 22:15:36 by jwe]
jwe
parents:
diff changeset
94
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
95 ## Transform Lyapunov equation to Sylvester equation form.
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
96
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
97 if ((m = is_square (b)) == 0)
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
98 if ((m = rows (b)) == n)
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
99
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
100 ## solve a x + x a' + b b' = 0
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
101
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
102 b = b * b';
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
103 a = a';
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
104 else
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
105
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
106 ## Try to solve a'x + x a + b' b = 0.
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
107
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
108 m = columns (b);
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
109 b = b' * b;
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
110 endif
40
adade67872a7 [project @ 1993-08-10 22:15:36 by jwe]
jwe
parents:
diff changeset
111
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
112 if (m != n)
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
113 error ("lyap: a, b not conformably dimensioned");
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
114 endif
40
adade67872a7 [project @ 1993-08-10 22:15:36 by jwe]
jwe
parents:
diff changeset
115 endif
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
116
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
117 ## Set up Sylvester equation.
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
118
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
119 c = b;
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
120 b = a;
1194
621fef7bcca1 [project @ 1995-03-31 05:11:53 by jwe]
jwe
parents: 1014
diff changeset
121 a = b';
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
122
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
123 else
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
124
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
125 ## Check dimensions.
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
126
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
127 if ((m = is_square (b)) == 0)
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
128 error ("lyap: b must be square in a sylvester equation");
40
adade67872a7 [project @ 1993-08-10 22:15:36 by jwe]
jwe
parents:
diff changeset
129 endif
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
130
73
f3c9042fd609 [project @ 1993-08-30 14:49:08 by jwe]
jwe
parents: 57
diff changeset
131 [n1, m1] = size(c);
53
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
132
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
133 if (n != n1 || m != m1)
4565ad8b4697 [project @ 1993-08-11 21:21:34 by jwe]
jwe
parents: 40
diff changeset
134 error("lyap: a,b,c not conformably dimensioned");
1194
621fef7bcca1 [project @ 1995-03-31 05:11:53 by jwe]
jwe
parents: 1014
diff changeset
135 endif
40
adade67872a7 [project @ 1993-08-10 22:15:36 by jwe]
jwe
parents:
diff changeset
136 endif
adade67872a7 [project @ 1993-08-10 22:15:36 by jwe]
jwe
parents:
diff changeset
137
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
138 ## Call octave built-in function.
40
adade67872a7 [project @ 1993-08-10 22:15:36 by jwe]
jwe
parents:
diff changeset
139
73
f3c9042fd609 [project @ 1993-08-30 14:49:08 by jwe]
jwe
parents: 57
diff changeset
140 x = syl (a, b, c);
40
adade67872a7 [project @ 1993-08-10 22:15:36 by jwe]
jwe
parents:
diff changeset
141
adade67872a7 [project @ 1993-08-10 22:15:36 by jwe]
jwe
parents:
diff changeset
142 endfunction