Mercurial > hg > octave-lyh

comparison scripts/general/circshift.m @ 9051:1bf0ce0930be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammar check TexInfo in all .m files Cleanup documentation sources to follow a few consistent rules. Spellcheck was NOT done. (but will be in another changeset)
author Rik <rdrider0-list@yahoo.com>
date Fri, 27 Mar 2009 22:31:03 -0700
parents 853f96e8008f
children 16f53d29049f
comparison
equal deleted inserted replaced
9044:656ad518f385 9051:1bf0ce0930be
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 shifts 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
27 ## 27 ##
28 ## @example 28 ## @example