Mercurial > octave-nkf
comparison libinterp/corefcn/det.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 | 9155bab86647 |
| children | f90c8372b7ba |
comparison
equal
deleted
inserted
replaced
| 20206:b70f8da6dcd3 | 20207:4f45eaf83908 |
|---|---|
| 53 @deftypefnx {Built-in Function} {[@var{d}, @var{rcond}] =} det (@var{A})\n\ | 53 @deftypefnx {Built-in Function} {[@var{d}, @var{rcond}] =} det (@var{A})\n\ |
| 54 Compute the determinant of @var{A}.\n\ | 54 Compute the determinant of @var{A}.\n\ |
| 55 \n\ | 55 \n\ |
| 56 Return an estimate of the reciprocal condition number if requested.\n\ | 56 Return an estimate of the reciprocal condition number if requested.\n\ |
| 57 \n\ | 57 \n\ |
| 58 Routines from @sc{lapack} are used for full matrices and code from\n\ | 58 Programming Notes: Routines from @sc{lapack} are used for full matrices and\n\ |
| 59 @sc{umfpack} is used for sparse matrices.\n\ | 59 code from @sc{umfpack} is used for sparse matrices.\n\ |
| 60 \n\ | 60 \n\ |
| 61 The determinant should not be used to check a matrix for singularity.\n\ | 61 The determinant should not be used to check a matrix for singularity.\n\ |
| 62 For that, use any of the condition number functions: @code{cond},\n\ | 62 For that, use any of the condition number functions: @code{cond},\n\ |
| 63 @code{condest}, @code{rcond}.\n\ | 63 @code{condest}, @code{rcond}.\n\ |
| 64 @seealso{cond, condest, rcond}\n\ | 64 @seealso{cond, condest, rcond}\n\ |