[Scipy-tickets] [SciPy] #1264: Incorrect docstring for scipy.sparse.linalg.eigen

SciPy Trac scipy-tickets@scipy....
Fri Aug 13 16:53:18 CDT 2010


#1264: Incorrect docstring for scipy.sparse.linalg.eigen
--------------------+-------------------------------------------------------
 Reporter:  lutz    |       Owner:  somebody
     Type:  defect  |      Status:  new     
 Priority:  normal  |   Milestone:  0.9.0   
Component:  Other   |     Version:  0.7.0   
 Keywords:          |  
--------------------+-------------------------------------------------------
 The docstring of scipy.sparse.linalg.eigen describes the  function's
 return values as:

     w : array
         Array of k eigenvalues

     v : array
         An array of k eigenvectors
         The v[i] is the eigenvector corresponding to the eigenvector w[i]

 I think the description of the indexing of the object v is incorrect, and
 should read

     v : array
         An array of k eigenvectors
         The v[:,i] is the eigenvector corresponding to the eigenvalue w[i]

 instead.

-- 
Ticket URL: <http://projects.scipy.org/scipy/ticket/1264>
SciPy <http://www.scipy.org>
SciPy is open-source software for mathematics, science, and engineering.


More information about the Scipy-tickets mailing list