Mercurial > octave-antonio

comparison libinterp/dldfcn/symrcm.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
413 // An implementation of the Cuthill-McKee algorithm. 413 // An implementation of the Cuthill-McKee algorithm.
414 DEFUN_DLD (symrcm, args, , 414 DEFUN_DLD (symrcm, args, ,
415 "-*- texinfo -*-\n\ 415 "-*- texinfo -*-\n\
416 @deftypefn {Loadable Function} {@var{p} =} symrcm (@var{S})\n\ 416 @deftypefn {Loadable Function} {@var{p} =} symrcm (@var{S})\n\
417 Return the symmetric reverse @nospell{Cuthill-McKee} permutation of @var{S}.\n\ 417 Return the symmetric reverse @nospell{Cuthill-McKee} permutation of @var{S}.\n\
418 \n\
418 @var{p} is a permutation vector such that\n\ 419 @var{p} is a permutation vector such that\n\
419 @code{@var{S}(@var{p}, @var{p})} tends to have its diagonal elements\n\ 420 @code{@var{S}(@var{p}, @var{p})} tends to have its diagonal elements closer\n\
420 closer to the diagonal than @var{S}. This is a good preordering for LU\n\ 421 to the diagonal than @var{S}. This is a good preordering for LU or\n\
421 or Cholesky@tie{}factorization of matrices that come from ``long, skinny''\n\ 422 Cholesky@tie{}factorization of matrices that come from ``long, skinny''\n\
422 problems. It works for both symmetric and asymmetric @var{S}.\n\ 423 problems. It works for both symmetric and asymmetric @var{S}.\n\
423 \n\ 424 \n\
424 The algorithm represents a heuristic approach to the NP-complete\n\ 425 The algorithm represents a heuristic approach to the NP-complete bandwidth\n\
425 bandwidth minimization problem. The implementation is based in the\n\ 426 minimization problem. The implementation is based in the descriptions found\n\
426 descriptions found in\n\ 427 in\n\
427 \n\ 428 \n\
428 @nospell{E. Cuthill, J. McKee}. @cite{Reducing the Bandwidth of Sparse\n\ 429 @nospell{E. Cuthill, J. McKee}. @cite{Reducing the Bandwidth of Sparse\n\
429 Symmetric Matrices}. Proceedings of the 24th ACM National Conference,\n\ 430 Symmetric Matrices}. Proceedings of the 24th ACM National Conference,\n\
430 157--172 1969, Brandon Press, New Jersey.\n\ 431 157--172 1969, Brandon Press, New Jersey.\n\
431 \n\ 432 \n\