comparison scripts/general/postpad.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
comparison
equal deleted inserted replaced
11538:6eded7561d9d 11539:6bac61388876
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} {} postpad (@var{x}, @var{l}, @var{c}) 20 ## @deftypefn {Function File} {} postpad (@var{x}, @var{l})
21 ## @deftypefnx {Function File} {} postpad (@var{x}, @var{l}, @var{c})
21 ## @deftypefnx {Function File} {} postpad (@var{x}, @var{l}, @var{c}, @var{dim}) 22 ## @deftypefnx {Function File} {} postpad (@var{x}, @var{l}, @var{c}, @var{dim})
22 ## @seealso{prepad, resize} 23 ## Append the scalar value @var{c} to the vector @var{x}
24 ## until it is of length @var{l}. If the third argument is not
25 ## supplied, a value of 0 is used.
26 ##
27 ## If @code{length (@var{x}) > @var{l}}, elements from the end of
28 ## @var{x} are removed until a vector of length @var{l} is obtained.
29 ##
30 ## If @var{x} is a matrix, elements are appended or removed from each row.
31 ##
32 ## If the optional argument @var{dim} is given, operate along this
33 ## dimension.
34 ## @seealso{prepad, cat, resize}
23 ## @end deftypefn 35 ## @end deftypefn
24 36
25 ## Author: Tony Richardson <arichard@stark.cc.oh.us> 37 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
26 ## Created: June 1994 38 ## Created: June 1994
27 39