annotate scripts/control/system/sysdup.m @ 7135:8aa770b6c5bf

[project @ 2007-11-08 18:54:10 by jwe]
author jwe
date Thu, 08 Nov 2007 18:54:10 +0000
parents a1dbe9d80eee
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1996, 1998, 2000, 2002, 2004, 2005, 2006, 2007
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## Auburn University. All rights reserved.
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
3 ##
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
4 ## This file is part of Octave.
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
5 ##
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
7 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
9 ## your option) any later version.
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
10 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
14 ## General Public License for more details.
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
15 ##
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
16 ## 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: 6046
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
18 ## <http://www.gnu.org/licenses/>.
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
19
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4771
diff changeset
21 ## @deftypefn {Function File} {@var{retsys} =} sysdup (@var{asys}, @var{out_idx}, @var{in_idx})
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
22 ## Duplicate specified input/output connections of a system
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
23 ##
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
24 ## @strong{Inputs}
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
25 ## @table @var
3502
b5238ac1dca9 [project @ 2000-01-31 07:40:53 by jwe]
jwe
parents: 3500
diff changeset
26 ## @item asys
3439
3234a698073a [project @ 2000-01-14 09:51:14 by jwe]
jwe
parents: 3430
diff changeset
27 ## system data structure
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
28 ## @item out_idx
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
29 ## @itemx in_idx
3462
04aef7306dca [project @ 2000-01-19 17:16:43 by hodelas]
hodelas
parents: 3439
diff changeset
30 ## indices or names of desired signals (see @code{sigidx}).
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
31 ## duplicates are made of @code{y(out_idx(ii))} and @code{u(in_idx(ii))}.
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
32 ## @end table
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
33 ##
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4771
diff changeset
34 ## @strong{Output}
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4771
diff changeset
35 ## @table @var
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4771
diff changeset
36 ## @item retsys
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4771
diff changeset
37 ## Resulting closed loop system:
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
38 ## duplicated i/o names are appended with a @code{"+"} suffix.
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4771
diff changeset
39 ## @end table
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
40 ##
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
41 ## @strong{Method}
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4771
diff changeset
42 ##
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
43 ## @code{sysdup} creates copies of selected inputs and outputs as
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4771
diff changeset
44 ## shown below. @var{u1}, @var{y1} is the set of original inputs/outputs, and
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4771
diff changeset
45 ## @var{u2}, @var{y2} is the set of duplicated inputs/outputs in the order
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4771
diff changeset
46 ## specified in @var{in_idx}, @var{out_idx}, respectively
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
47 ## @example
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
48 ## @group
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
49 ## ____________________
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
50 ## u1 ----->| |----> y1
3502
b5238ac1dca9 [project @ 2000-01-31 07:40:53 by jwe]
jwe
parents: 3500
diff changeset
51 ## | asys |
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
52 ## u2 ------>| |----->y2
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4771
diff changeset
53 ## (in_idx) -------------------- (out_idx)
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
54 ## @end group
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
55 ## @end example
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
56 ## @end deftypefn
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
57
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
58 ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu>
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
59 ## Created: August 1995
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
60 ## modified by John Ingram July 1996
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
61
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
62 function retsys = sysdup (Asys, output_list, input_list)
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
63
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
64 if (nargin != 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5443
diff changeset
65 print_usage ();
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
66 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
67
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
68 if (! isstruct (Asys))
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
69 error ("Asys must be a system data structure (see ss, tf, or zp)")
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
70 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
71
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
72 Asys = sysupdate (Asys, "ss");
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
73 [nn, nz, mm, pp] = sysdimensions (Asys);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
74 [aa, bb, cc, dd] = sys2ss (Asys);
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
75
3462
04aef7306dca [project @ 2000-01-19 17:16:43 by hodelas]
hodelas
parents: 3439
diff changeset
76 ## check for signal names
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
77 if (is_signal_list (input_list) || ischar (input_list))
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
78 input_list = sysidx (Asys, "in", input_list);
3462
04aef7306dca [project @ 2000-01-19 17:16:43 by hodelas]
hodelas
parents: 3439
diff changeset
79 endif
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
80 if (is_signal_list (output_list) || ischar (output_list))
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
81 output_list = sysidx (Asys, "out", output_list);
3462
04aef7306dca [project @ 2000-01-19 17:16:43 by hodelas]
hodelas
parents: 3439
diff changeset
82 endif
04aef7306dca [project @ 2000-01-19 17:16:43 by hodelas]
hodelas
parents: 3439
diff changeset
83
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
84 ## first duplicate inputs
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
85 if (isvector (input_list))
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
86 for ii = 1:length(input_list);
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
87 bb(:,mm+ii) = bb(:,input_list(ii));
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
88 dd(:,mm+ii) = dd(:,input_list(ii));
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
89 endfor
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
90 elseif (! isempty (input_list))
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
91 error ("input_list must be a vector or empty");
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
92 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
93
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
94
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
95 ## now duplicate outputs
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
96 osize = min (size (output_list));
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
97 if (osize == 1)
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
98 for ii = 1:length(output_list);
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
99 cc(pp+ii,:) = cc(output_list(ii),:);
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
100 dd(pp+ii,:) = dd(output_list(ii),:);
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
101 endfor
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
102 elseif (osize != 0)
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
103 error ("output_list must be a vector or empty");
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
104 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
105
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
106 [stnam, innam, outnam, yd] = sysgetsignals (Asys);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
107 tsam = sysgettsam (Asys);
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
108
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
109 ## pack system and then rename signals
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
110 retsys = ss (aa, bb, cc, dd, tsam, nn, nz);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
111 retsys = syssetsignals (retsys, "in", innam, 1:mm);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
112 retsys = syssetsignals (retsys, "out", outnam, 1:pp);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
113 retsys = syssetsignals (retsys, "yd", yd, 1:pp);
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
114
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
115 ## update added input names
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
116 for ii = (mm+1):(mm+length(input_list))
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
117 onum = input_list(ii-mm);
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
118 strval = sprintf ("%s(dup)", sysgetsignals (retsys, "in", onum, 1));
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
119 retsys = syssetsignals (retsys, "in", strval, ii);
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
120 endfor
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
121
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
122 ## update added output names/discrete flags
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
123 ## give default names to the added outputs
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
124 for jj = (pp+1):(pp+length(output_list))
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
125 onum = output_list(jj-pp);
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
126 strval = sprintf ("%s(dup)", sysgetsignals (retsys, "out", onum, 1));
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
127 retsys = syssetsignals (retsys, "out", strval, jj);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
128 dflg = sysgetsignals (retsys, "yd", onum);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7017
diff changeset
129 retsys = syssetsignals (retsys, "yd", dflg, jj);
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
130 endfor
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
131
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
132 endfunction