Skip to content

Relax method for sigma from Real to Number and order eigenvalues at the end of the computation #582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 1, 2025
Merged

Relax method for sigma from Real to Number and order eigenvalues at the end of the computation #582

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2690b27
Relax method for `sigma` from `Real` to `Number` and order eigenvalue…
albertomercurio Oct 31, 2025
0e09f92
Change docstrings
albertomercurio Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions src/qobj/eigsolve.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,12 @@ function _eigsolve(
vals = diag(view(Tₘ, 1:k, 1:k))
VR = _schur_right_eigenvectors(Tₘ, k)
mul!(cache1₁ₖ, Vₘ, M(Uₘ * VR))
vecs = copy(cache1₁ₖ)

# Order the eigenvalues and eigenvectors
idxs = sortperm(vals, by = sortby, rev = rev)
vals = vals[idxs]
vecs = cache1₁ₖ[:, idxs]

settings.auto_tidyup && tidyup!(vecs)

return EigsolveResult(vals, vecs, type, dimensions, iter, numops, (iter < maxiter))
Expand All @@ -275,7 +280,7 @@ end
@doc raw"""
eigsolve(A::QuantumObject;
v0::Union{Nothing,AbstractVector}=nothing,
sigma::Union{Nothing, Real}=nothing,
sigma::Union{Nothing, Number}=nothing,
eigvals::Int = 1,
krylovdim::Int = max(20, 2*k+1),
tol::Real = 1e-8,
Expand All @@ -290,7 +295,7 @@ Solve for the eigenvalues and eigenvectors of a matrix `A` using the Arnoldi met
# Arguments
- `A::QuantumObject`: the [`QuantumObject`](@ref) to solve eigenvalues and eigenvectors.
- `v0::Union{Nothing,AbstractVector}`: the initial vector for the Arnoldi method. Default is a random vector.
- `sigma::Union{Nothing, Real}`: the shift for the eigenvalue problem. Default is `nothing`.
- `sigma::Union{Nothing, Number}`: the shift for the eigenvalue problem. Default is `nothing`.
- `eigvals::Int`: the number of eigenvalues to compute. Default is `1`.
- `krylovdim::Int`: the dimension of the Krylov subspace. Default is `max(20, 2*k+1)`.
- `tol::Real`: the tolerance for the Arnoldi method. Default is `1e-8`.
Expand All @@ -309,7 +314,7 @@ Solve for the eigenvalues and eigenvectors of a matrix `A` using the Arnoldi met
function eigsolve(
A::QuantumObject;
v0::Union{Nothing,AbstractVector} = nothing,
sigma::Union{Nothing,Real} = nothing,
sigma::Union{Nothing,Number} = nothing,
eigvals::Int = 1,
krylovdim::Int = max(20, 2 * eigvals + 1),
tol::Real = 1e-8,
Expand Down Expand Up @@ -341,7 +346,7 @@ function eigsolve(
v0::Union{Nothing,AbstractVector} = nothing,
type::Union{Nothing,Operator,SuperOperator} = nothing,
dimensions = nothing,
sigma::Union{Nothing,Real} = nothing,
sigma::Union{Nothing,Number} = nothing,
eigvals::Int = 1,
krylovdim::Int = max(20, 2 * eigvals + 1),
tol::Real = 1e-8,
Expand Down
Loading