Mercurial > octave-antonio
comparison libinterp/dldfcn/dmperm.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 |
comparison
equal
deleted
inserted
replaced
| 20162:2645f9ef8c88 | 20163:075a5e2e1ba5 |
|---|---|
| 192 DEFUN_DLD (sprank, args, nargout, | 192 DEFUN_DLD (sprank, args, nargout, |
| 193 "-*- texinfo -*-\n\ | 193 "-*- texinfo -*-\n\ |
| 194 @deftypefn {Loadable Function} {@var{p} =} sprank (@var{S})\n\ | 194 @deftypefn {Loadable Function} {@var{p} =} sprank (@var{S})\n\ |
| 195 @cindex structural rank\n\ | 195 @cindex structural rank\n\ |
| 196 \n\ | 196 \n\ |
| 197 Calculate the structural rank of the sparse matrix @var{S}. Note that\n\ | 197 Calculate the structural rank of the sparse matrix @var{S}.\n\ |
| 198 only the structure of the matrix is used in this calculation based on\n\ | 198 \n\ |
| 199 a @nospell{Dulmage-Mendelsohn} permutation to block triangular form. As\n\ | 199 Note that only the structure of the matrix is used in this calculation based\n\ |
| 200 on a @nospell{Dulmage-Mendelsohn} permutation to block triangular form. As\n\ | |
| 200 such the numerical rank of the matrix @var{S} is bounded by\n\ | 201 such the numerical rank of the matrix @var{S} is bounded by\n\ |
| 201 @code{sprank (@var{S}) >= rank (@var{S})}. Ignoring floating point errors\n\ | 202 @code{sprank (@var{S}) >= rank (@var{S})}. Ignoring floating point errors\n\ |
| 202 @code{sprank (@var{S}) == rank (@var{S})}.\n\ | 203 @code{sprank (@var{S}) == rank (@var{S})}.\n\ |
| 203 @seealso{dmperm}\n\ | 204 @seealso{dmperm}\n\ |
| 204 @end deftypefn") | 205 @end deftypefn") |