Mercurial > octave
diff scripts/general/shift.m @ 3369:f37ca3017116
[project @ 1999-11-21 16:26:02 by jwe]
author | jwe |
---|---|
date | Sun, 21 Nov 1999 16:26:08 +0000 |
parents | 7d80b56e0dc8 |
children | f8dde1807dee |
line wrap: on
line diff
--- a/scripts/general/shift.m Sat Nov 20 17:23:01 1999 +0000 +++ b/scripts/general/shift.m Sun Nov 21 16:26:08 1999 +0000 @@ -14,12 +14,13 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: y = shift (x, b) -## -## If x is a vector, perform a circular shift of length b of the -## elements of x. -## -## If x is a matrix, do the same for each column of x. +## -*- texinfo -*- +## @deftypefn {Function File} {} shift (@var{x}, @var{b}) +## If @var{x} is a vector, perform a circular shift of length @var{b} of +## the elements of @var{x}. +## +## If @var{x} is a matrix, do the same for each column of @var{x}. +## @end deftypefn ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 14 September 1994