Mercurial > octave

changeset 26156:a4a7e887ddb0 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
polyeig.m: Improve documentation (bug #53139). * polyeig.m: Use the correct polynomial expression that is being solved for in documentation. Make use of @var{} around variables in docstring.
author Rik <rik@octave.org>
date Sat, 01 Dec 2018 02:48:30 -0800
parents 80643ff8c8b7
children e2626799445f b9debf4436aa
files scripts/polynomial/polyeig.m
diffstat 1 files changed, 7 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/polynomial/polyeig.m	Thu Nov 22 07:26:58 2018 -0800
+++ b/scripts/polynomial/polyeig.m	Sat Dec 01 02:48:30 2018 -0800
@@ -22,17 +22,19 @@
 ##
 ## Solve the polynomial eigenvalue problem of degree @var{l}.
 ##
-## Given an @var{n*n} matrix polynomial
+## Given an @var{n}x@var{n} matrix polynomial
 ##
-## @code{@var{C}(s) = @var{C0} + @var{C1} s + @dots{} + @var{Cl} s^l}
+## @code{@var{C}(@var{s}) = @var{C0} + @var{C1} @var{s} + @dots{} + @var{Cl}
+## @var{s}^@var{l}}
 ##
 ## @code{polyeig} solves the eigenvalue problem
 ##
-## @code{(@var{C0} + @var{C1} + @dots{} + @var{Cl})v = 0}.
+## @code{(@var{C0} + @var{C1} @var{z} + @dots{} + @var{Cl} z^@var{l}) @var{v} =
+## 0}.
 ##
 ## Note that the eigenvalues @var{z} are the zeros of the matrix polynomial.
-## @var{z} is a row vector with @var{n*l} elements.  @var{v} is a matrix
-## (@var{n} x @var{n}*@var{l}) with columns that correspond to the
+## @var{z} is a row vector with @code{@var{n}*@var{l}} elements.  @var{v} is a
+## matrix (@var{n} x @var{n}*@var{l}) with columns that correspond to the
 ## eigenvectors.
 ##
 ## @seealso{eig, eigs, compan}