Mercurial > hg > octave-nkf
changeset 11539:6bac61388876
Add undocumented postpad function to documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Fri, 14 Jan 2011 18:39:23 -0800 |
parents | 6eded7561d9d |
children | b0ef6f28e09a |
files | doc/ChangeLog doc/interpreter/matrix.txi scripts/ChangeLog scripts/general/postpad.m scripts/general/prepad.m |
diffstat | 5 files changed, 30 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2011-01-14 Rik <octave@nomad.inbox5.com> + + * interpreter/matrix.txi: Add undocumented postpad to documentation. + 2011-01-14 Rik <octave@nomad.inbox5.com> * interpreter/octave.texi, interpreter/poly.txi: Add undocumented
--- a/doc/interpreter/matrix.txi +++ b/doc/interpreter/matrix.txi @@ -150,9 +150,10 @@ @DOCSTRING(vech) -@anchor{doc-postpad} @DOCSTRING(prepad) +@DOCSTRING(postpad) + @DOCSTRING(diag) @DOCSTRING(blkdiag)
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,7 @@ +2011-01-14 Rik <octave@nomad.inbox5.com> + + * general/postpad.m, general/prepad.m: Improve docstring. + 2011-01-14 Rik <octave@nomad.inbox5.com> * ploynomial/polyaffine.m: Improve docstring.
--- a/scripts/general/postpad.m +++ b/scripts/general/postpad.m @@ -17,9 +17,21 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} postpad (@var{x}, @var{l}, @var{c}) +## @deftypefn {Function File} {} postpad (@var{x}, @var{l}) +## @deftypefnx {Function File} {} postpad (@var{x}, @var{l}, @var{c}) ## @deftypefnx {Function File} {} postpad (@var{x}, @var{l}, @var{c}, @var{dim}) -## @seealso{prepad, resize} +## 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 end of +## @var{x} are removed until a vector of length @var{l} is obtained. +## +## If @var{x} is a matrix, elements are appended or removed from each row. +## +## If the optional argument @var{dim} is given, operate along this +## dimension. +## @seealso{prepad, cat, resize} ## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/general/prepad.m +++ b/scripts/general/prepad.m @@ -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>