[Octave-bug-tracker] [bug #61851] Error in function reference for eig at Octave Forge

[Daniel Hatton]

URL:
  <https://savannah.gnu.org/bugs/?61851>

                 Summary: Error in function reference for eig at Octave Forge
                 Project: GNU Octave
            Submitted by: danhatton
            Submitted on: Tue 18 Jan 2022 09:02:41 PM UTC
                Category: Octave Forge website
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
         Originator Name: Daniel Hatton
        Originator Email: 
             Open/Closed: Open
                 Release: 5.2.0
         Discussion Lock: Any
        Operating System: Any

    _______________________________________________________

Details:

The function reference for eig, at
<https://octave.sourceforge.io/octave/function/eig.html>, erroneously
describes the operation of eig as

> Compute the right eigenvalues(V) and optionally the eigenvectors(lambda) and
the left eigenvalues(W) of a matrix or a pair of matrices.

This has eigenvectors and eigenvalues the wrong way round.  The correct
version, which appears when one issues "help eig" at the Octave prompt in
Octave 5.2.0, is

> Compute the eigenvalues (LAMBDA) and optionally the right eigenvectors (V)
and the left eigenvectors (W) of a matrix or pair of matrices.

TIA for any fix.





    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?61851>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/