Mercurial > octave-nkf
comparison libinterp/corefcn/tril.cc @ 20207:4f45eaf83908 stable
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 | 4197fc428c7d |
| children | b2100e1659ac |
comparison
equal
deleted
inserted
replaced
| 20206:b70f8da6dcd3 | 20207:4f45eaf83908 |
|---|---|
| 353 @deftypefnx {Function File} {} triu (@var{A})\n\ | 353 @deftypefnx {Function File} {} triu (@var{A})\n\ |
| 354 @deftypefnx {Function File} {} triu (@var{A}, @var{k})\n\ | 354 @deftypefnx {Function File} {} triu (@var{A}, @var{k})\n\ |
| 355 @deftypefnx {Function File} {} triu (@var{A}, @var{k}, @var{pack})\n\ | 355 @deftypefnx {Function File} {} triu (@var{A}, @var{k}, @var{pack})\n\ |
| 356 Return a new matrix formed by extracting the lower (@code{tril})\n\ | 356 Return a new matrix formed by extracting the lower (@code{tril})\n\ |
| 357 or upper (@code{triu}) triangular part of the matrix @var{A}, and\n\ | 357 or upper (@code{triu}) triangular part of the matrix @var{A}, and\n\ |
| 358 setting all other elements to zero. The second argument is optional,\n\ | 358 setting all other elements to zero.\n\ |
| 359 and specifies how many diagonals above or below the main diagonal should\n\ | 359 \n\ |
| 360 also be set to zero.\n\ | 360 The second argument is optional, and specifies how many diagonals above or\n\ |
| 361 \n\ | 361 below the main diagonal should also be set to zero.\n\ |
| 362 The default value of @var{k} is zero, so that @code{triu} and\n\ | 362 \n\ |
| 363 @code{tril} normally include the main diagonal as part of the result.\n\ | 363 The default value of @var{k} is zero, so that @code{triu} and @code{tril}\n\ |
| 364 \n\ | 364 normally include the main diagonal as part of the result.\n\ |
| 365 If the value of @var{k} is nonzero integer, the selection of elements\n\ | 365 \n\ |
| 366 starts at an offset of @var{k} diagonals above or below the main\n\ | 366 If the value of @var{k} is nonzero integer, the selection of elements starts\n\ |
| 367 diagonal; above for positive @var{k} and below for negative @var{k}.\n\ | 367 at an offset of @var{k} diagonals above or below the main diagonal; above\n\ |
| 368 for positive @var{k} and below for negative @var{k}.\n\ | |
| 368 \n\ | 369 \n\ |
| 369 The absolute value of @var{k} must not be greater than the number of\n\ | 370 The absolute value of @var{k} must not be greater than the number of\n\ |
| 370 subdiagonals or superdiagonals.\n\ | 371 subdiagonals or superdiagonals.\n\ |
| 371 \n\ | 372 \n\ |
| 372 For example:\n\ | 373 For example:\n\ |
| 405 "-*- texinfo -*-\n\ | 406 "-*- texinfo -*-\n\ |
| 406 @deftypefn {Function File} {} triu (@var{A})\n\ | 407 @deftypefn {Function File} {} triu (@var{A})\n\ |
| 407 @deftypefnx {Function File} {} triu (@var{A}, @var{k})\n\ | 408 @deftypefnx {Function File} {} triu (@var{A}, @var{k})\n\ |
| 408 @deftypefnx {Function File} {} triu (@var{A}, @var{k}, @var{pack})\n\ | 409 @deftypefnx {Function File} {} triu (@var{A}, @var{k}, @var{pack})\n\ |
| 409 See the documentation for the @code{tril} function (@pxref{tril}).\n\ | 410 See the documentation for the @code{tril} function (@pxref{tril}).\n\ |
| 411 @seealso{tril}\n\ | |
| 410 @end deftypefn") | 412 @end deftypefn") |
| 411 { | 413 { |
| 412 return do_trilu ("triu", args); | 414 return do_trilu ("triu", args); |
| 413 } | 415 } |
| 414 | 416 |