[14f77c]: inst / @lti / xperm.m Maximize Restore History

Download this file

xperm.m    64 lines (56 with data), 2.0 kB

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
## Copyright (C) 2009, 2013 Lukas F. Reichlin
##
## This file is part of LTI Syncope.
##
## LTI Syncope is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## LTI Syncope is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with LTI Syncope. If not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} {@var{retsys} =} xperm (@var{sys}, @var{idx})
## Reorder states in state-space models.
##
## @strong{Inputs}
## @table @var
## @item sys
## State-space model.
## @item idx
## Vector containing the state indices in the desired order.
## Alternatively, a cell vector containing the state names
## is possible as well. See @code{sys.stname}. State names
## only work if they were assigned explicitly before, i.e.
## @code{sys.stname} contains no empty strings.
## Note that if certain state indices of @var{sys} are
## missing or appear multiple times in @var{idx}, these
## states will be pruned or duplicated accordingly in the
## resulting state-space model @var{retsys}.
## @end table
##
## @strong{Outputs}
## @table @var
## @item retsys
## Resulting state-space model with states reordered according to @var{idx}.
## @end table
##
## @end deftypefn
## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
## Created: November 2009
## Version: 0.2
function sys = xperm (sys, st_idx)
if (nargin != 2)
print_usage ();
endif
if (! isa (sys, "ss"))
warning ("xperm: system not in state-space form");
sys = ss (sys);
endif
sys = __sys_prune__ (sys, ":", ":", st_idx);
endfunction