Skip to content

Commit 0e09f92

Browse files
Change docstrings
1 parent 2690b27 commit 0e09f92

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/qobj/eigsolve.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ end
280280
@doc raw"""
281281
eigsolve(A::QuantumObject;
282282
v0::Union{Nothing,AbstractVector}=nothing,
283-
sigma::Union{Nothing, Real}=nothing,
283+
sigma::Union{Nothing, Number}=nothing,
284284
eigvals::Int = 1,
285285
krylovdim::Int = max(20, 2*k+1),
286286
tol::Real = 1e-8,
@@ -295,7 +295,7 @@ Solve for the eigenvalues and eigenvectors of a matrix `A` using the Arnoldi met
295295
# Arguments
296296
- `A::QuantumObject`: the [`QuantumObject`](@ref) to solve eigenvalues and eigenvectors.
297297
- `v0::Union{Nothing,AbstractVector}`: the initial vector for the Arnoldi method. Default is a random vector.
298-
- `sigma::Union{Nothing, Real}`: the shift for the eigenvalue problem. Default is `nothing`.
298+
- `sigma::Union{Nothing, Number}`: the shift for the eigenvalue problem. Default is `nothing`.
299299
- `eigvals::Int`: the number of eigenvalues to compute. Default is `1`.
300300
- `krylovdim::Int`: the dimension of the Krylov subspace. Default is `max(20, 2*k+1)`.
301301
- `tol::Real`: the tolerance for the Arnoldi method. Default is `1e-8`.

0 commit comments

Comments
 (0)