Mercurial > octave
changeset 31373:da3ac42a143d stable
doc: Update doc for schur.cc
schur.cc: Remove references to non-existent functions "are" and "dare".
Remove repeated text about eigenvalues appearing along the diagonal.
Convert a paragraph of text to a short table of options.
author | Arun Giridhar <arungiridhar@gmail.com> |
---|---|
date | Mon, 31 Oct 2022 11:30:56 -0400 |
parents | 80bd450892b2 |
children | f2515895e3b6 b1ee095baa5b |
files | libinterp/corefcn/schur.cc |
diffstat | 1 files changed, 24 insertions(+), 25 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/schur.cc Sun Oct 30 23:42:04 2022 -0400 +++ b/libinterp/corefcn/schur.cc Mon Oct 31 11:30:56 2022 -0400 @@ -69,7 +69,8 @@ @cindex Schur decomposition Compute the Schur@tie{}decomposition of @var{A}. -The Schur@tie{}decomposition is defined as +The Schur@tie{}decomposition is an eigendecomposition of a square matrix +@var{A} defined as @tex $$ S = U^T A U @@ -100,34 +101,32 @@ @ifnottex @code{2 x 2} @end ifnottex -along the diagonal. The diagonal elements of @var{S} -(or the eigenvalues of the -@tex -$2 \times 2$ -@end tex -@ifnottex -@code{2 x 2} -@end ifnottex -blocks, when appropriate) are the eigenvalues of @var{A} and @var{S}. +along the diagonal. -The default for real matrices is a real Schur@tie{}decomposition. -A complex decomposition may be forced by passing the flag -@qcode{"complex"}. +The default for real matrices is a real Schur@tie{}decomposition. A complex +decomposition may be forced by passing the flag @qcode{"complex"}. The eigenvalues are optionally ordered along the diagonal according to the -value of @var{opt}. @code{@var{opt} = "a"} indicates that all eigenvalues -with negative real parts should be moved to the leading block of @var{S} -(used in @code{are}), @code{@var{opt} = "d"} indicates that all -eigenvalues with magnitude less than one should be moved to the leading -block of @var{S} (used in @code{dare}), and @code{@var{opt} = "u"}, the -default, indicates that no ordering of eigenvalues should occur. The -leading @var{k} columns of @var{U} always span the @var{A}-invariant +value of @var{opt}: + +@table @asis +@item @qcode{@var{opt} = "a"} +Move eigenvalues with negative real parts to the leading block of @var{S}. +Mnemonic: @qcode{"a"} for Algebraic @nospell{Riccati} Equations, where this +ordering is useful. + +@item @qcode{@var{opt} = "d"} +Move eigenvalues with magnitude less than one to the leading block of @var{S}. +Mnemonic: @qcode{"d"} for Discrete Algebraic @nospell{Riccati} Equations, +where this ordering is useful. + +@item @qcode{@var{opt} = "u"} +Unordered. No particular ordering of eigenvalues (default). +@end table + +The leading @var{k} columns of @var{U} always span the @var{A}-invariant subspace corresponding to the @var{k} leading eigenvalues of @var{S}. - -The Schur@tie{}decomposition is used to compute eigenvalues of a square -matrix, and has applications in the solution of algebraic @nospell{Riccati} -equations in control (see @code{are} and @code{dare}). -@seealso{rsf2csf, ordschur, ordeig, lu, chol, hess, qr, qz, svd} +@seealso{rsf2csf, ordschur, ordeig, lu, chol, hess, qr, qz, svd, eig} @end deftypefn */) { int nargin = args.length ();