breaking: do not export LM, SR, LR, SI, LI (#144)

Cause users can pass `:LM`, `:SR`, `:LR`, `:SI`, `:LI` instead, and it's not nice to export those two character structs.
JuliaLinearAlgebra · Feb 22, 2024 · 5622150 · 5622150
1 parent fa80d1f
commit 5622150
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/src/ArnoldiMethod.jl b/src/ArnoldiMethod.jl
@@ -5,7 +5,7 @@ using StaticArrays
 
 using Base: RefValue, OneTo
 
-export partialschur, partialschur!, LM, SR, LR, SI, LI, partialeigen, ArnoldiWorkspace
+export partialschur, partialschur!, partialeigen, ArnoldiWorkspace
 
 """
     ArnoldiWorkspace(n, k) → ArnoldiWorkspace

diff --git a/src/run.jl b/src/run.jl
@@ -47,6 +47,9 @@ The target `which` can be any of:
 | `:LI` or `LI()` | Largest imaginary part: `imag(λ)` is largest   |
 | `:SI` or `SI()` | Smallest imaginary part: `imag(λ)` is smallest |
 
+Note that as of ArnoldiMethod v0.4, you have to import `using ArnoldiMethod: LM` explicitly if you
+do not want to use symbols.
+
 !!! note
 
     The targets `:LI` and `:SI` only make sense in complex arithmetic. In real