help eig?

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

help eig?

vicnorton
octave> help eig

'eig' is a built-in function from the file libinterp/corefcn/eig.cc

 -- LAMBDA = eig (A)
 -- LAMBDA = eig (A, B)
 -- [V, LAMBDA] = eig (A)
 -- [V, LAMBDA] = eig (A, B)
 -- [V, LAMBDA, W] = eig (A)
 -- [V, LAMBDA, W] = eig (A, B)
 -- [...] = eig (A, BALANCEOPTION)
 -- [...] = eig (A, B, ALGORITHM)
 -- [...] = eig (..., EIGVALOPTION)
     Compute the right eigenvalues(V) and optionally the
     eigenvectors(lambda) and the left eigenvalues(W) of a matrix or a
     pair of matrices.

...

comment: someone needs to rewrite this "help" description. When
   [V, LAMBDA] = eig (A);
V contains the eigenvectors of A and LAMBDA contains the eigenvalues.


Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: help eig?

siko1056
Thank you for the report. I file a bug and provide a cset in a minute. The docstring was changed half year ago http://hg.savannah.gnu.org/hgweb/octave/rev/510886d03ef2 and never checked ever since.

Best,
Kai
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: help eig?

siko1056
See https://savannah.gnu.org/bugs/index.php?50524 ready for a review:

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

As I haven't found your name "Victor Thane Norton" (right?) in http://hg.savannah.gnu.org/hgweb/octave/file/tip/doc/interpreter/contributors.in, would you like to be credited for your observation?

Kai
Loading...