Mercurial > octave-nkf
diff scripts/general/prepad.m @ 11539:6bac61388876
Add undocumented postpad function to documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Fri, 14 Jan 2011 18:39:23 -0800 |
parents | fd0a3ac60b0e |
children | 4d777e05d47c |
line wrap: on
line diff
--- a/scripts/general/prepad.m Fri Jan 14 16:58:44 2011 -0800 +++ b/scripts/general/prepad.m Fri Jan 14 18:39:23 2011 -0800 @@ -17,20 +17,21 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} prepad (@var{x}, @var{l}, @var{c}) +## @deftypefn {Function File} {} prepad (@var{x}, @var{l}) +## @deftypefnx {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} +## Prepend 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 +## If @code{length (@var{x}) > @var{l}}, elements from the beginning 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 +## If the optional argument @var{dim} is given, operate along this ## dimension. -## @seealso{postpad} +## @seealso{postpad, cat, resize} ## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us>