Mercurial > octave-antonio

comparison libinterp/dldfcn/amd.cc @ 20163:075a5e2e1ba5 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 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
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
53 DEFUN_DLD (amd, args, nargout, 53 DEFUN_DLD (amd, args, nargout,
54 "-*- texinfo -*-\n\ 54 "-*- texinfo -*-\n\
55 @deftypefn {Loadable Function} {@var{p} =} amd (@var{S})\n\ 55 @deftypefn {Loadable Function} {@var{p} =} amd (@var{S})\n\
56 @deftypefnx {Loadable Function} {@var{p} =} amd (@var{S}, @var{opts})\n\ 56 @deftypefnx {Loadable Function} {@var{p} =} amd (@var{S}, @var{opts})\n\
57 \n\ 57 \n\
58 Return the approximate minimum degree permutation of a matrix. This\n\ 58 Return the approximate minimum degree permutation of a matrix.\n\
59 permutation such that the Cholesky@tie{}factorization of @code{@var{S}\n\ 59 \n\
60 (@var{p}, @var{p})} tends to be sparser than the Cholesky@tie{}factorization\n\ 60 This is a permutation such that the Cholesky@tie{}factorization of\n\
61 of @var{S} itself. @code{amd} is typically faster than @code{symamd} but\n\ 61 @code{@var{S} (@var{p}, @var{p})} tends to be sparser than the\n\
62 serves a similar purpose.\n\ 62 Cholesky@tie{}factorization of @var{S} itself. @code{amd} is typically\n\
63 \n\ 63 faster than @code{symamd} but serves a similar purpose.\n\
64 The optional parameter @var{opts} is a structure that controls the\n\ 64 \n\
65 behavior of @code{amd}. The fields of the structure are\n\ 65 The optional parameter @var{opts} is a structure that controls the behavior\n\
66 of @code{amd}. The fields of the structure are\n\
66 \n\ 67 \n\
67 @table @asis\n\ 68 @table @asis\n\
68 @item @var{opts}.dense\n\ 69 @item @var{opts}.dense\n\
69 Determines what @code{amd} considers to be a dense row or column of the\n\ 70 Determines what @code{amd} considers to be a dense row or column of the\n\
70 input matrix. Rows or columns with more than @code{max (16, (dense *\n\ 71 input matrix. Rows or columns with more than @code{max (16, (dense *\n\
71 sqrt (@var{n})))} entries, where @var{n} is the order of the matrix @var{S},\n\ 72 sqrt (@var{n})))} entries, where @var{n} is the order of the matrix @var{S},\n\
72 are ignored by @code{amd} during the calculation of the permutation\n\ 73 are ignored by @code{amd} during the calculation of the permutation.\n\
73 The value of dense must be a positive scalar and its default value is 10.0\n\ 74 The value of dense must be a positive scalar and the default value is 10.0\n\
74 \n\ 75 \n\
75 @item @var{opts}.aggressive\n\ 76 @item @var{opts}.aggressive\n\
76 If this value is a nonzero scalar, then @code{amd} performs aggressive\n\ 77 If this value is a nonzero scalar, then @code{amd} performs aggressive\n\
77 absorption. The default is not to perform aggressive absorption.\n\ 78 absorption. The default is not to perform aggressive absorption.\n\
78 @end table\n\ 79 @end table\n\
79 \n\ 80 \n\
80 The author of the code itself is Timothy A. Davis\n\ 81 The author of the code itself is Timothy A. Davis\n\
81 @email{davis@@cise.ufl.edu}, University of Florida (see\n\ 82 @email{davis@@cise.ufl.edu}, University of Florida\n\
82 @url{http://www.cise.ufl.edu/research/sparse/amd}).\n\ 83 (see @url{http://www.cise.ufl.edu/research/sparse/amd}).\n\
83 @seealso{symamd, colamd}\n\ 84 @seealso{symamd, colamd}\n\
84 @end deftypefn") 85 @end deftypefn")
85 { 86 {
86 octave_value_list retval; 87 octave_value_list retval;
87 88