Mercurial > hg > octave-nkf
diff scripts/control/system/sysreorder.m @ 5016:bdbee5282954
[project @ 2004-09-22 02:50:35 by jwe]
author | jwe |
---|---|
date | Wed, 22 Sep 2004 02:50:36 +0000 |
parents | 22bd65326ec1 |
children | 4c8a2e4e0717 |
line wrap: on
line diff
--- a/scripts/control/system/sysreorder.m +++ b/scripts/control/system/sysreorder.m @@ -17,14 +17,22 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {} sysreorder (@var{vlen}, @var{list}) +## @deftypefn {Function File} {@var{pv} =} sysreorder (@var{vlen}, @var{list}) ## ## @strong{Inputs} -## @var{vlen}=vector length, @var{list}= a subset of @code{[1:vlen]}, +## @table @var +## @item vlen +## Vector length. +## @item list +## A subset of @code{[1:vlen]}. +## @end table ## -## @strong{Outputs} -## @var{pv}: a permutation vector to order elements of @code{[1:vlen]} in +## @strong{Output} +## @table @var +## @item pv +## A permutation vector to order elements of @code{[1:vlen]} in ## @code{list} to the end of a vector. +## @end table ## ## Used internally by @code{sysconnect} to permute vector elements to their ## desired locations.