From 56221508b32e2be8cc041733f32f1fd669ba1490 Mon Sep 17 00:00:00 2001 From: Harmen Stoppels Date: Thu, 22 Feb 2024 11:08:58 +0100 Subject: [PATCH] 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. --- src/ArnoldiMethod.jl | 2 +- src/run.jl | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/ArnoldiMethod.jl b/src/ArnoldiMethod.jl index 122fd9b..daaf166 100644 --- 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 index d40d5f0..ee3a99c 100644 --- 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