Skip to content

DOC: clarification on the `which` parameter of ARPACK. #388

Merged
merged 1 commit into from Dec 21, 2012

2 participants

@fabianp
SciPy member
fabianp commented Dec 18, 2012

I've had a hard time understanding the which parameter of ARPACK, so
I'm submitting this patch with the hope that it becomes clearer.

Changes:

  • Eigenvectors have all norm 1, thus the parameter which is
    applied to eigenvalues and not eigenvectors.

  • Clarification on what magnitude means in the context of
    complex eigenvalues.

  • Clarification on what 'LA', 'SA' means. ARPACK docs refer to them
    as Largest/Smallest Algebraic value: those are real numbers with
    its respective sign (not in absolute value). I could not understand
    what was meant before as Largest Amplitude.

@fabianp fabianp DOC: clarification on the `which` parameter of ARPACK.
I've had a hard time understanding the `which` parameter of ARPACK, so
I'm submitting this patch with the hope that it becomes clearer.

Changes:

   * Eigenvectors have all norm 1, thus the parameter `which` is
     applied to eigenvalues and not eigenvectors.

   * Clarification on what magnitude means in the context of
     complex eigenvalues.

   * Clarification on what 'LA', 'SA' means. ARPACK docs refer to them
     as Largest/Smallest Algebraic value: those are real numbers with
     its respective sign (not in absolute value). I could not understand
     what was meant before as `Largest Amplitude`.
2d9a5f0
@jakevdp
SciPy member
jakevdp commented Dec 18, 2012

Nice - I think that is much clearer - Thanks! I'm fine to merge this - I'll give it a couple days to see if there are other comments.

@fabianp
SciPy member
fabianp commented Dec 18, 2012

OK glad you liked it!

@jakevdp
SciPy member
jakevdp commented Dec 21, 2012

Merging - thanks Fabian

@jakevdp jakevdp merged commit a7c0e1e into scipy:master Dec 21, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.