/[escript]/trunk/escript/py_src/util.py
ViewVC logotype

Diff of /trunk/escript/py_src/util.py

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 587 by gross, Fri Mar 10 02:26:50 2006 UTC revision 588 by gross, Fri Mar 10 04:45:04 2006 UTC
# Line 3610  def eigenvalues(arg): Line 3610  def eigenvalues(arg):
3610    
3611  def eigenvalues_and_eigenvectors(arg):  def eigenvalues_and_eigenvectors(arg):
3612      """      """
3613      returns the eigenvalues of the square matrix arg.      returns the eigenvalues and eigenvectors of the square matrix arg.
3614    
3615      @param arg: square matrix. Must have rank 2 and the first and second dimension must be equal.      @param arg: square matrix. Must have rank 2 and the first and second dimension must be equal.
3616                  arg must be symmetric, ie. transpose(arg)==arg (this is not checked).                  arg must be symmetric, ie. transpose(arg)==arg (this is not checked).
3617      @type arg: L{numarray.NumArray}, L{escript.Data}, L{Symbol}      @type arg: L{escript.Data}
3618      @return: the eigenvalues in increasing order.      @return: the eigenvalues and eigenvectors. The eigenvalues are ordered by increasing value. The
3619      @rtype: L{numarray.NumArray},L{escript.Data}, L{Symbol} depending on the input.               eigenvectors are orthogonal and normalized. If V are the eigenvectors than V[:,i] is
3620      @remark: for L{escript.Data} and L{Symbol} objects the dimension is restricted to 3.               the eigenvector coresponding to the i-th eigenvalue.
3621        @rtype: L{tuple} of L{escript.Data}.
3622        @remark: The dimension is restricted to 3.
3623      """      """
3624      if isinstance(arg,numarray.NumArray):      if isinstance(arg,numarray.NumArray):
3625        raise TypeError,"eigenvalues_and_eigenvectors is not supporting numarray arguments"        raise TypeError,"eigenvalues_and_eigenvectors is not supporting numarray arguments"

Legend:
Removed from v.587  
changed lines
  Added in v.588

  ViewVC Help
Powered by ViewVC 1.1.26