octave_packages/control-2.3.52/@lti/xperm.m

   1 ## Copyright (C) 2009   Lukas F. Reichlin
   2 ##
   3 ## This file is part of LTI Syncope.
   4 ##
   5 ## LTI Syncope is free software: you can redistribute it and/or modify
   6 ## it under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation, either version 3 of the License, or
   8 ## (at your option) any later version.
   9 ##
  10 ## LTI Syncope is distributed in the hope that it will be useful,
  11 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 ## GNU General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 ## -*- texinfo -*-
  19 ## @deftypefn {Function File} {@var{sys} =} xperm (@var{sys}, @var{st_idx})
  20 ## Reorder states in state-space models.
  21 ## @end deftypefn
  22
  23 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
  24 ## Created: November 2009
  25 ## Version: 0.1
  26
  27 function sys = xperm (sys, st_idx)
  28
  29   if (nargin != 2)
  30     print_usage ();
  31   endif
  32
  33   if (! is_real_vector (st_idx))
  34     error ("xperm: second argument invalid");
  35   endif
  36
  37   if (! isa (sys, "ss"))
  38     warning ("xperm: system not in state-space form");
  39     sys = ss (sys);
  40   endif
  41
  42   sys = __sys_prune__ (sys, ":", ":", st_idx);
  43
  44 endfunction