Mercurial > octave-nkf

comparison src/DLD-FUNCTIONS/colamd.cc @ 12642:f96b9b9f141b stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Periodic grammarcheck and spellcheck of documentation. * func.txi: Correct two misspellings * cumtrapz.m, dblquad.m, quadgk.m, quadl.m, quadv.m, trapz.m, triplequad.m, cond.m, gmres.m, bzip2.m, compare_versions.m, getappdata.m, unpack.m, ver.m, glpk.m, pkg.m, axis.m, uigetdir.m, uigetfile.m, view.m, prctile.m, quantile.m, unidcdf.m, unidinv.m, isstrprop.m, balance.cc, besselj.cc, cellfun.cc, colamd.cc, dot.cc, eigs.cc, fftw.cc, matrix_type.cc, pinv.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, regexp.cc, schur.cc, time.cc (gmtime), typecast.cc urlwrite.cc bitfcns.cc (bitshift), data.cc (rem, norm, merge) debug.cc (dbstatus), dirfns.cc (glob), file-io.cc (freport), load-path.cc (genpath), load-save.cc (save), mappers.cc (islower, isupper, tolower, toupper) oct-hist.cc (edit_history), ov-fcn-inline.cc (vectorize), ov.cc (subsref), syscalls.cc (stat), variables.cc (whos, clear): Improve docstrings. Removed trailing whitespace characters on line.
author Rik <octave@nomad.inbox5.com>
date Sun, 01 May 2011 11:39:50 -0700
parents d0b799dafede
children cf5ebc0e47e4
comparison
equal deleted inserted replaced
12639:4d777e05d47c 12642:f96b9b9f141b
457 \n\ 457 \n\
458 For a symmetric positive definite matrix @var{S}, returns the permutation\n\ 458 For a symmetric positive definite matrix @var{S}, returns the permutation\n\
459 vector p such that @code{@var{S}(@var{p}, @var{p})} tends to have a\n\ 459 vector p such that @code{@var{S}(@var{p}, @var{p})} tends to have a\n\
460 sparser Cholesky@tie{}factor than @var{S}. Sometimes @code{symamd} works\n\ 460 sparser Cholesky@tie{}factor than @var{S}. Sometimes @code{symamd} works\n\
461 well for symmetric indefinite matrices too. The matrix @var{S} is assumed\n\ 461 well for symmetric indefinite matrices too. The matrix @var{S} is assumed\n\
462 to be symmetric; only the strictly lower triangular part is referenced. \n\ 462 to be symmetric; only the strictly lower triangular part is referenced.\n\
463 @var{S} must be square.\n\ 463 @var{S} must be square.\n\
464 \n\ 464 \n\
465 @var{knobs} is an optional one- to two-element input vector. If @var{S} is\n\ 465 @var{knobs} is an optional one- to two-element input vector. If @var{S} is\n\
466 n-by-n, then rows and columns with more than\n\ 466 n-by-n, then rows and columns with more than\n\
467 @code{max(16,@var{knobs}(1)*sqrt(n))} entries are removed prior to ordering,\n\ 467 @code{max(16,@var{knobs}(1)*sqrt(n))} entries are removed prior to ordering,\n\
468 and ordered last in the output permutation @var{p}. No rows/columns are\n\ 468 and ordered last in the output permutation @var{p}. No rows/columns are\n\
469 removed if @code{@var{knobs}(1) < 0}. If @code{@var{knobs} (2)} is nonzero,\n\ 469 removed if @code{@var{knobs}(1) < 0}. If @code{@var{knobs} (2)} is nonzero,\n\
470 @code{stats} and @var{knobs} are printed. The default is @code{@var{knobs} \n\ 470 @code{stats} and @var{knobs} are printed. The default is @code{@var{knobs}\n\
471 = [10 0]}. Note that @var{knobs} differs from earlier versions of symamd.\n\ 471 = [10 0]}. Note that @var{knobs} differs from earlier versions of symamd.\n\
472 \n\ 472 \n\
473 @var{stats} is an optional 20-element output vector that provides data\n\ 473 @var{stats} is an optional 20-element output vector that provides data\n\
474 about the ordering and the validity of the input matrix @var{S}. Ordering\n\ 474 about the ordering and the validity of the input matrix @var{S}. Ordering\n\
475 statistics are in @code{@var{stats}(1:3)}. @code{@var{stats}(1) =\n\ 475 statistics are in @code{@var{stats}(1:3)}. @code{@var{stats}(1) =\n\