Mercurial > octave-nkf

comparison libinterp/corefcn/strfns.cc @ 20207:4f45eaf83908 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed libinterp/corefcn directory. * libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc, libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc, libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc, libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc, libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc, libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc, libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc, libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc, libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, scripts/polynomial/spline.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sat, 09 May 2015 17:19:30 -0700
parents 19755f4fc851
children 5212cda4ac0e aa36fb998a4d
comparison
equal deleted inserted replaced
20206:b70f8da6dcd3 20207:4f45eaf83908
45 @deftypefn {Built-in Function} {} char (@var{x})\n\ 45 @deftypefn {Built-in Function} {} char (@var{x})\n\
46 @deftypefnx {Built-in Function} {} char (@var{x}, @dots{})\n\ 46 @deftypefnx {Built-in Function} {} char (@var{x}, @dots{})\n\
47 @deftypefnx {Built-in Function} {} char (@var{s1}, @var{s2}, @dots{})\n\ 47 @deftypefnx {Built-in Function} {} char (@var{s1}, @var{s2}, @dots{})\n\
48 @deftypefnx {Built-in Function} {} char (@var{cell_array})\n\ 48 @deftypefnx {Built-in Function} {} char (@var{cell_array})\n\
49 Create a string array from one or more numeric matrices, character\n\ 49 Create a string array from one or more numeric matrices, character\n\
50 matrices, or cell arrays. Arguments are concatenated vertically.\n\ 50 matrices, or cell arrays.\n\
51 The returned values are padded with blanks as needed to make each row\n\ 51 \n\
52 of the string array have the same length. Empty input strings are\n\ 52 Arguments are concatenated vertically. The returned values are padded with\n\
53 significant and will concatenated in the output.\n\ 53 blanks as needed to make each row of the string array have the same length. \n\
54 \n\ 54 Empty input strings are significant and will concatenated in the output.\n\
55 For numerical input, each element is converted\n\ 55 \n\
56 to the corresponding ASCII character. A range error results if an input\n\ 56 For numerical input, each element is converted to the corresponding ASCII\n\
57 is outside the ASCII range (0-255).\n\ 57 character. A range error results if an input is outside the ASCII range\n\
58 (0-255).\n\
58 \n\ 59 \n\
59 For cell arrays, each element is concatenated separately. Cell arrays\n\ 60 For cell arrays, each element is concatenated separately. Cell arrays\n\
60 converted through\n\ 61 converted through @code{char} can mostly be converted back with\n\
61 @code{char} can mostly be converted back with @code{cellstr}.\n\ 62 @code{cellstr}. For example:\n\
62 For example:\n\
63 \n\ 63 \n\
64 @example\n\ 64 @example\n\
65 @group\n\ 65 @group\n\
66 char ([97, 98, 99], \"\", @{\"98\", \"99\", 100@}, \"str1\", [\"ha\", \"lf\"])\n\ 66 char ([97, 98, 99], \"\", @{\"98\", \"99\", 100@}, \"str1\", [\"ha\", \"lf\"])\n\
67 @result{} [\"abc \"\n\ 67 @result{} [\"abc \"\n\
176 @deftypefn {Built-in Function} {} strvcat (@var{x})\n\ 176 @deftypefn {Built-in Function} {} strvcat (@var{x})\n\
177 @deftypefnx {Built-in Function} {} strvcat (@var{x}, @dots{})\n\ 177 @deftypefnx {Built-in Function} {} strvcat (@var{x}, @dots{})\n\
178 @deftypefnx {Built-in Function} {} strvcat (@var{s1}, @var{s2}, @dots{})\n\ 178 @deftypefnx {Built-in Function} {} strvcat (@var{s1}, @var{s2}, @dots{})\n\
179 @deftypefnx {Built-in Function} {} strvcat (@var{cell_array})\n\ 179 @deftypefnx {Built-in Function} {} strvcat (@var{cell_array})\n\
180 Create a character array from one or more numeric matrices, character\n\ 180 Create a character array from one or more numeric matrices, character\n\
181 matrices, or cell arrays. Arguments are concatenated vertically.\n\ 181 matrices, or cell arrays.\n\
182 The returned values are padded with blanks as needed to make each row\n\ 182 \n\
183 of the string array have the same length. Unlike @code{char}, empty\n\ 183 Arguments are concatenated vertically. The returned values are padded with\n\
184 strings are removed and will not appear in the output.\n\ 184 blanks as needed to make each row of the string array have the same length. \n\
185 \n\ 185 Unlike @code{char}, empty strings are removed and will not appear in the\n\
186 For numerical input, each element is converted\n\ 186 output.\n\
187 to the corresponding ASCII character. A range error results if an input\n\ 187 \n\
188 is outside the ASCII range (0-255).\n\ 188 For numerical input, each element is converted to the corresponding ASCII\n\
189 character. A range error results if an input is outside the ASCII range\n\
190 (0-255).\n\
189 \n\ 191 \n\
190 For cell arrays, each element is concatenated separately. Cell arrays\n\ 192 For cell arrays, each element is concatenated separately. Cell arrays\n\
191 converted through\n\ 193 converted through @code{strvcat} can mostly be converted back with\n\
192 @code{strvcat} can mostly be converted back with @code{cellstr}.\n\ 194 @code{cellstr}. For example:\n\
193 For example:\n\
194 \n\ 195 \n\
195 @example\n\ 196 @example\n\
196 @group\n\ 197 @group\n\
197 strvcat ([97, 98, 99], \"\", @{\"98\", \"99\", 100@}, \"str1\", [\"ha\", \"lf\"])\n\ 198 strvcat ([97, 98, 99], \"\", @{\"98\", \"99\", 100@}, \"str1\", [\"ha\", \"lf\"])\n\
198 @result{} [\"abc \"\n\ 199 @result{} [\"abc \"\n\
868 */ 869 */
869 870
870 DEFUN (list_in_columns, args, , 871 DEFUN (list_in_columns, args, ,
871 "-*- texinfo -*-\n\ 872 "-*- texinfo -*-\n\
872 @deftypefn {Built-in Function} {} list_in_columns (@var{arg}, @var{width}, @var{prefix})\n\ 873 @deftypefn {Built-in Function} {} list_in_columns (@var{arg}, @var{width}, @var{prefix})\n\
873 Return a string containing the elements of @var{arg} listed in\n\ 874 Return a string containing the elements of @var{arg} listed in columns with\n\
874 columns with an overall maximum width of @var{width} and optional\n\ 875 an overall maximum width of @var{width} and optional prefix @var{prefix}.\n\
875 prefix @var{prefix}. The argument @var{arg} must be a cell array\n\ 876 \n\
876 of character strings or a character array. If @var{width} is not\n\ 877 The argument @var{arg} must be a cell array of character strings or a\n\
877 specified or is an empty matrix, or less than or equal to zero,\n\ 878 character array.\n\
878 the width of the terminal screen is used.\n\ 879 \n\
879 Newline characters are used to break the lines in the output string.\n\ 880 If @var{width} is not specified or is an empty matrix, or less than or equal\n\
880 For example:\n\ 881 to zero, the width of the terminal screen is used. Newline characters are\n\
882 used to break the lines in the output string. For example:\n\
881 @c Set example in small font to prevent overfull line\n\ 883 @c Set example in small font to prevent overfull line\n\
882 \n\ 884 \n\
883 @smallexample\n\ 885 @smallexample\n\
884 @group\n\ 886 @group\n\
885 list_in_columns (@{\"abc\", \"def\", \"ghijkl\", \"mnop\", \"qrs\", \"tuv\"@}, 20)\n\ 887 list_in_columns (@{\"abc\", \"def\", \"ghijkl\", \"mnop\", \"qrs\", \"tuv\"@}, 20)\n\