Mercurial > octave-antonio
diff libinterp/dldfcn/amd.cc @ 20163:075a5e2e1ba5 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value,
libinterp/parse-tree directories.
* build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc,
libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc,
libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc,
libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc,
libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc,
libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc,
libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc,
libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc,
libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll,
libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc,
libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc:
doc: Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 03 May 2015 21:52:42 -0700 |
| parents | 4197fc428c7d |
| children |
line wrap: on
line diff
--- a/libinterp/dldfcn/amd.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/amd.cc Sun May 03 21:52:42 2015 -0700 @@ -55,22 +55,23 @@ @deftypefn {Loadable Function} {@var{p} =} amd (@var{S})\n\ @deftypefnx {Loadable Function} {@var{p} =} amd (@var{S}, @var{opts})\n\ \n\ -Return the approximate minimum degree permutation of a matrix. This\n\ -permutation such that the Cholesky@tie{}factorization of @code{@var{S}\n\ -(@var{p}, @var{p})} tends to be sparser than the Cholesky@tie{}factorization\n\ -of @var{S} itself. @code{amd} is typically faster than @code{symamd} but\n\ -serves a similar purpose.\n\ +Return the approximate minimum degree permutation of a matrix.\n\ \n\ -The optional parameter @var{opts} is a structure that controls the\n\ -behavior of @code{amd}. The fields of the structure are\n\ +This is a permutation such that the Cholesky@tie{}factorization of\n\ +@code{@var{S} (@var{p}, @var{p})} tends to be sparser than the\n\ +Cholesky@tie{}factorization of @var{S} itself. @code{amd} is typically\n\ +faster than @code{symamd} but serves a similar purpose.\n\ +\n\ +The optional parameter @var{opts} is a structure that controls the behavior\n\ +of @code{amd}. The fields of the structure are\n\ \n\ @table @asis\n\ @item @var{opts}.dense\n\ Determines what @code{amd} considers to be a dense row or column of the\n\ input matrix. Rows or columns with more than @code{max (16, (dense *\n\ sqrt (@var{n})))} entries, where @var{n} is the order of the matrix @var{S},\n\ -are ignored by @code{amd} during the calculation of the permutation\n\ -The value of dense must be a positive scalar and its default value is 10.0\n\ +are ignored by @code{amd} during the calculation of the permutation.\n\ +The value of dense must be a positive scalar and the default value is 10.0\n\ \n\ @item @var{opts}.aggressive\n\ If this value is a nonzero scalar, then @code{amd} performs aggressive\n\ @@ -78,8 +79,8 @@ @end table\n\ \n\ The author of the code itself is Timothy A. Davis\n\ -@email{davis@@cise.ufl.edu}, University of Florida (see\n\ -@url{http://www.cise.ufl.edu/research/sparse/amd}).\n\ +@email{davis@@cise.ufl.edu}, University of Florida\n\ +(see @url{http://www.cise.ufl.edu/research/sparse/amd}).\n\ @seealso{symamd, colamd}\n\ @end deftypefn") {