Mercurial > octave
diff libinterp/corefcn/eig.cc @ 23565:3a730821e4a2
doc: Peridoc grammarcheck of documentation.
* container.txi, external.txi, install.txi, oop.txi, plot.txi, testfun.txi,
eig.cc, graphics.cc, gsvd.cc, hex2num.cc, pr-output.cc, sub2ind.cc,
__ode15__.cc, Map.m, __publish_html_output__.m, __publish_latex_output__.m,
odeset.m, ode_event_handler.m, runge_kutta_45_dorpri.m, xlim.m, ylim.m, zlim.m,
hgtransform.m, eigs.m, native2unicode.m, unicode2native.m:
grammarcheck documentation.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 08 Jun 2017 17:41:32 -0700 |
parents | 855122b993da |
children | 80c42f4cca13 |
line wrap: on
line diff
--- a/libinterp/corefcn/eig.cc Thu Jun 08 15:56:46 2017 -0700 +++ b/libinterp/corefcn/eig.cc Thu Jun 08 17:41:32 2017 -0700 @@ -46,14 +46,13 @@ @deftypefnx {} {[@dots{}] =} eig (@var{A}, @var{B}, @var{algorithm}) @deftypefnx {} {[@dots{}] =} eig (@dots{}, @var{eigvalOption}) Compute the eigenvalues (@var{lambda}) and optionally the right eigenvectors -(@var{V}) and the left eigenvectors (@var{W}) of a matrix or a pair of -matrices. +(@var{V}) and the left eigenvectors (@var{W}) of a matrix or pair of matrices. The flag @var{balanceOption} can be one of: @table @asis -@item @qcode{"balance"} -Preliminary balancing is on. (default) +@item @qcode{"balance"} (default) +Preliminary balancing is on. @item @qcode{"nobalance"} Disables preliminary balancing. @@ -63,24 +62,23 @@ @table @asis @item @qcode{"matrix"} -Return the eigenvalues in a diagonal matrix. (default if 2 or 3 outputs -are specified) +Return the eigenvalues in a diagonal matrix. (default if 2 or 3 outputs +are requested) @item @qcode{"vector"} -Return the eigenvalues in a column vector. (default if 1 output is -specified, e.g. @var{lambda} = eig (@var{A})) +Return the eigenvalues in a column vector. (default if only 1 output is +requested, e.g., @var{lambda} = eig (@var{A})) @end table The flag @var{algorithm} can be one of: @table @asis @item @qcode{"chol"} -Uses the Cholesky factorization of B. (default if A is symmetric (Hermitian) -and B is symmetric (Hermitian) positive definite) +Use the Cholesky factorization of B. (default if @var{A} is symmetric +(Hermitian) and @var{B} is symmetric (Hermitian) positive definite) @item @qcode{"qz"} -Uses the QZ algorithm. (When A or B are not symmetric always the -QZ algorithm will be used) +Use the QZ algorithm. (used whenever @var{A} or @var{B} are not symmetric) @end table @multitable @columnfractions .31 .23 .23 .23