Mercurial > hg > octave-lyh
comparison scripts/general/circshift.m @ 12575:d0b799dafede
Grammarcheck files for 3.4.1 release.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 04 Apr 2011 15:33:46 -0700 |
parents | ca1190196d26 |
children | 9f2e568123ea |
comparison
equal
deleted
inserted
replaced
12574:89604fa96d2f | 12575:d0b799dafede |
---|---|
16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {@var{y} =} circshift (@var{x}, @var{n}) | 20 ## @deftypefn {Function File} {@var{y} =} circshift (@var{x}, @var{n}) |
21 ## Circularly shifts the values of the array @var{x}. @var{n} must be | 21 ## Circularly shift the values of the array @var{x}. @var{n} must be |
22 ## a vector of integers no longer than the number of dimensions in | 22 ## a vector of integers no longer than the number of dimensions in |
23 ## @var{x}. The values of @var{n} can be either positive or negative, | 23 ## @var{x}. The values of @var{n} can be either positive or negative, |
24 ## which determines the direction in which the values or @var{x} are | 24 ## which determines the direction in which the values or @var{x} are |
25 ## shifted. If an element of @var{n} is zero, then the corresponding | 25 ## shifted. If an element of @var{n} is zero, then the corresponding |
26 ## dimension of @var{x} will not be shifted. For example: | 26 ## dimension of @var{x} will not be shifted. For example: |