Mercurial > octave-nkf
view scripts/general/shift.m @ 8828:8463d1a2e544
Doc fixes.
* 2]$$. => 2].$$
* @var{extrapval} => @var{extrapval}.
* call helloworld.oct => called @file{helloworld.oct}
* @itemize => @table @code
* shows. => shows:
* save => @code{save}
* @ref{Breakpoints} => @pxref{Breakpoints}
* add @noindent following example
* which is computed => and compute it
* clarify wording
* remove comma
* good => well
* set => number
* by writing => with the command
* has the option of directly calling => can call
* [-like-] {+of the right size,+}
* solvers => routines
* handle => test for
* add introductory section
* add following
* {+the+} [0..bitmax] => [0,bitmax]
* of the => with
* number => value
* add usual
* Besides when doing comparisons, logical => Logical {+also+}
* array comparison => array, comparisons
* param => parameter
* works very similar => is similar
* strings, => strings
* most simple => simplest
* easier => more easily
* like => as
* called => called,
* clarify wording
* you should simply type => use
* clarify wording
* means => way
* equally => also
* [-way much-] {+way+}
* add with mean value parameter given by the first argument, @var{l}
* add Functions described as @dfn{mapping functions} apply the given
operation to each element when given a matrix argument.
* in this brief introduction => here
* It is worth noticing => Note
* add following
* means => ways
author | Brian Gough <bjg@network-theory.co.uk> |
---|---|
date | Fri, 20 Feb 2009 11:17:01 -0500 |
parents | 83a8781b529d |
children | eb63fbe60fab |
line wrap: on
line source
## Copyright (C) 1995, 1996, 1999, 2000, 2002, 2003, 2004, 2005, 2006, ## 2007 Kurt Hornik ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} shift (@var{x}, @var{b}) ## @deftypefnx {Function File} {} shift (@var{x}, @var{b}, @var{dim}) ## 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}. ## If the optional @var{dim} argument is given, operate along this ## dimension ## @end deftypefn ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 14 September 1994 ## Adapted-By: jwe function y = shift (x, b, dim) if (nargin != 2 && nargin != 3) print_usage (); endif if (! (isscalar (b) && b == round (b))) error ("shift: b must be an integer"); endif nd = ndims (x); sz = size (x); if (nargin == 3) if (! (isscalar (dim) && dim == round (dim)) && dim > 0 && dim < (nd + 1)) error ("shift: dim must be an integer and valid dimension"); endif else ## Find the first non-singleton dimension dim = 1; while (dim < nd + 1 && sz (dim) == 1) dim = dim + 1; endwhile if (dim > nd) dim = 1; endif endif if (numel (x) < 1) error ("shift: x must not be empty"); endif d = sz (dim); idx = cell (); for i = 1:nd idx{i} = 1:sz(i); endfor if (b >= 0) b = rem (b, d); idx{dim} = [d-b+1:d, 1:d-b]; elseif (b < 0) b = rem (abs (b), d); idx{dim} = [b+1:d, 1:b]; endif y = x(idx{:}); endfunction %!test %! a = [1, 2, 3]; %! b = [4, 5, 6]; %! c = [7, 8, 9]; %! %! r = [a, b, c]; %! m = [a; b; c]; %! %! assert((shift (r, 3) == [c, a, b] %! && shift (r, -6) == [c, a, b] %! && shift (r, -3) == [b, c, a] %! && shift (m, 1) == [c; a; b] %! && shift (m, -2) == [c; a; b])); %!error shift (); %!error shift (1, 2, 3, 4);