Diff of /inst/@lti/xperm.m [2c098b] .. [b109d7]  Maximize  Restore

  Switch to side-by-side view

--- a/inst/@lti/xperm.m
+++ b/inst/@lti/xperm.m
@@ -1,4 +1,4 @@
-## Copyright (C) 2009   Lukas F. Reichlin
+## Copyright (C) 2009, 2013   Lukas F. Reichlin
 ##
 ## This file is part of LTI Syncope.
 ##
@@ -16,22 +16,41 @@
 ## along with LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{sys} =} xperm (@var{sys}, @var{st_idx})
+## @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.1
+## Version: 0.2
 
 function sys = xperm (sys, st_idx)
 
   if (nargin != 2)
     print_usage ();
-  endif
-
-  if (! is_real_vector (st_idx))
-    error ("xperm: second argument invalid");
   endif
 
   if (! isa (sys, "ss"))