Mercurial > octave-nkf
view scripts/general/prepad.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 | faccdb98d953 |
children | eb63fbe60fab |
line wrap: on
line source
## Copyright (C) 1994, 1995, 1996, 1997, 1998, 2000, 2002, 2004, 2005, ## 2006, 2007 John W. Eaton ## ## 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} {} prepad (@var{x}, @var{l}, @var{c}) ## @deftypefnx {Function File} {} prepad (@var{x}, @var{l}, @var{c}, @var{dim}) ## Prepend (append) the scalar value @var{c} to the vector @var{x} ## until it is of length @var{l}. If the third argument is not ## supplied, a value of 0 is used. ## ## If @code{length (@var{x}) > @var{l}}, elements from the beginning (end) of ## @var{x} are removed until a vector of length @var{l} is obtained. ## ## If @var{x} is a matrix, elements are prepended or removed from each row. ## ## If the optional @var{dim} argument is given, then operate along this ## dimension. ## @seealso{postpad} ## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: June 1994 function y = prepad (x, l, c, dim) if (nargin < 2 || nargin > 4) print_usage (); endif if (nargin < 3 || isempty (c)) c = 0; else if (! isscalar (c)) error ("prepad: third argument must be empty or a scalar"); endif endif nd = ndims (x); sz = size (x); if (nargin < 4) %% 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 else if (! (isscalar (dim) && dim == round (dim)) && dim > 0 && dim < (nd + 1)) error ("prepad: dim must be an integer and valid dimension"); endif endif if (! isscalar (l) || l < 0) error ("second argument must be a positive scaler"); endif if (dim > nd) sz(nd+1:dim) = 1; endif d = sz (dim); if (d >= l) idx = cell (); for i = 1:nd idx{i} = 1:sz(i); endfor idx{dim} = d-l+1:d; y = x(idx{:}); else sz (dim) = l - d; y = cat (dim, c * ones (sz), x); endif endfunction