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

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 7ef7e20057fa
children de90542b7afc
comparison
equal deleted inserted replaced
12639:4d777e05d47c 12642:f96b9b9f141b
59 @code{@var{DD} = @var{P} * @var{D}}, in which @var{P} is a permutation\n\ 59 @code{@var{DD} = @var{P} * @var{D}}, in which @var{P} is a permutation\n\
60 matrix and @var{D} is a diagonal matrix of powers of two. This allows the\n\ 60 matrix and @var{D} is a diagonal matrix of powers of two. This allows the\n\
61 equilibration to be computed without round-off. Results of eigenvalue\n\ 61 equilibration to be computed without round-off. Results of eigenvalue\n\
62 calculation are typically improved by balancing first.\n\ 62 calculation are typically improved by balancing first.\n\
63 \n\ 63 \n\
64 If two output values are requested, @code{balance} returns \n\ 64 If two output values are requested, @code{balance} returns\n\
65 the diagonal @var{D} and the permutation @var{P} separately as vectors.\n\ 65 the diagonal @var{D} and the permutation @var{P} separately as vectors.\n\
66 In this case, @code{@var{DD} = eye(n)(:,@var{P}) * diag (@var{D})}, where\n\ 66 In this case, @code{@var{DD} = eye(n)(:,@var{P}) * diag (@var{D})}, where\n\
67 @math{n} is the matrix size. \n\ 67 @math{n} is the matrix size.\n\
68 \n\ 68 \n\
69 If four output values are requested, compute @code{@var{AA} =\n\ 69 If four output values are requested, compute @code{@var{AA} =\n\
70 @var{CC}*@var{A}*@var{DD}} and @code{@var{BB} = @var{CC}*@var{B}*@var{DD}},\n\ 70 @var{CC}*@var{A}*@var{DD}} and @code{@var{BB} = @var{CC}*@var{B}*@var{DD}},\n\
71 in which @var{AA} and @var{BB} have non-zero elements of approximately the\n\ 71 in which @var{AA} and @var{BB} have non-zero elements of approximately the\n\
72 same magnitude and @var{CC} and @var{DD} are permuted diagonal matrices as\n\ 72 same magnitude and @var{CC} and @var{DD} are permuted diagonal matrices as\n\