Mercurial > hg > octave-terminal
changeset 14886:cca0a52be4fa
doc: corrected eig doc
author | Ed Meyer <eem2314@gmail.com> |
---|---|
date | Thu, 19 Jul 2012 12:08:46 -0700 |
parents | f10cddda37c5 |
children | 577df411e0c7 |
files | src/DLD-FUNCTIONS/eig.cc |
diffstat | 1 files changed, 5 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/eig.cc +++ b/src/DLD-FUNCTIONS/eig.cc @@ -39,12 +39,12 @@ @deftypefnx {Loadable Function} {@var{lambda} =} eig (@var{A}, @var{B})\n\ @deftypefnx {Loadable Function} {[@var{V}, @var{lambda}] =} eig (@var{A})\n\ @deftypefnx {Loadable Function} {[@var{V}, @var{lambda}] =} eig (@var{A}, @var{B})\n\ -Compute the eigenvalues and eigenvectors of a matrix.\n\ +Compute the eigenvalues (and optionally the eigenvectors) of a matrix\n\ +or a pair of matrices\n\ \n\ -Eigenvalues are computed in a several step process which begins with a\n\ -Hessenberg decomposition, followed by a Schur@tie{}decomposition, from which\n\ -the eigenvalues are apparent. The eigenvectors, when desired, are computed\n\ -by further manipulations of the Schur@tie{}decomposition.\n\ +The algorithm used depends on whether there are one or two input\n\ +matrices, if they are real or complex and if they are symmetric\n\ +(Hermitian if complex) or nonsymmetric.\n\ \n\ The eigenvalues returned by @code{eig} are not ordered.\n\ @seealso{eigs, svd}\n\