Mercurial > octave

comparison scripts/general/circshift.m @ 20852:516bb87ea72e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
2015 Code Sprint: remove class of function from docstring for all m-files.
author Rik <rik@octave.org>
date Sat, 12 Dec 2015 07:31:00 -0800
parents 74cc8ae4e2b0
children bac0d6f07a3e
comparison
equal deleted inserted replaced
20851:0828bf20d105 20852:516bb87ea72e
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
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 {} {@var{y} =} circshift (@var{x}, @var{n})
21 ## @deftypefnx {Function File} {@var{y} =} circshift (@var{x}, @var{n}, @var{dim}) 21 ## @deftypefnx {} {@var{y} =} circshift (@var{x}, @var{n}, @var{dim})
22 ## Circularly shift the values of the array @var{x}. 22 ## Circularly shift the values of the array @var{x}.
23 ## 23 ##
24 ## @var{n} must be a vector of integers no longer than the number of dimensions 24 ## @var{n} must be a vector of integers no longer than the number of dimensions
25 ## in @var{x}. The values of @var{n} can be either positive or negative, which 25 ## in @var{x}. The values of @var{n} can be either positive or negative, which
26 ## determines the direction in which the values of @var{x} are shifted. If an 26 ## determines the direction in which the values of @var{x} are shifted. If an