change Settings to mutable struct

Author: ytdHuang

docs/src/users_guide/settings.md

@@ -29,8 +29,8 @@ QuantumToolbox.settings
 Next, one can overwrite the default settings by
 
 ```@example settings
-QuantumToolbox.settings.tidyup_tol[] = 1e-10
-QuantumToolbox.settings.auto_tidyup[] = false
+QuantumToolbox.settings.tidyup_tol = 1e-10
+QuantumToolbox.settings.auto_tidyup = false
 
 QuantumToolbox.settings
 ```

src/qobj/arithmetic_and_attributes.jl

@@ -629,28 +629,28 @@ purity(ρ::QuantumObject{ObjType}) where {ObjType<:Union{Ket,Bra}} = sum(abs2, 
 purity(ρ::QuantumObject{Operator}) = real(tr(ρ.data^2))
 
 @doc raw"""
-    tidyup(A::QuantumObject, tol::Real=settings.tidyup_tol[])
+    tidyup(A::QuantumObject, tol::Real=settings.tidyup_tol)
 
 Given a [`QuantumObject`](@ref) `A`, check the real and imaginary parts of each element separately. Remove the real or imaginary value if its absolute value is less than `tol`.
 """
-tidyup(A::QuantumObject, tol::T = settings.tidyup_tol[]) where {T<:Real} =
+tidyup(A::QuantumObject, tol::T = settings.tidyup_tol) where {T<:Real} =
     QuantumObject(tidyup(A.data, tol), A.type, A.dimensions)
-tidyup(A::AbstractArray, tol::T2 = settings.tidyup_tol[]) where {T2<:Real} = tidyup!(copy(A), tol)
+tidyup(A::AbstractArray, tol::T2 = settings.tidyup_tol) where {T2<:Real} = tidyup!(copy(A), tol)
 
 @doc raw"""
-    tidyup!(A::QuantumObject, tol::Real=settings.tidyup_tol[])
+    tidyup!(A::QuantumObject, tol::Real=settings.tidyup_tol)
 
 Given a [`QuantumObject`](@ref) `A`, check the real and imaginary parts of each element separately. Remove the real or imaginary value if its absolute value is less than `tol`.
 
 Note that this function is an in-place version of [`tidyup`](@ref).
 """
-tidyup!(A::QuantumObject, tol::T = settings.tidyup_tol[]) where {T<:Real} = (tidyup!(A.data, tol); A)
-function tidyup!(A::AbstractSparseArray, tol::T2 = settings.tidyup_tol[]) where {T2<:Real}
+tidyup!(A::QuantumObject, tol::T = settings.tidyup_tol) where {T<:Real} = (tidyup!(A.data, tol); A)
+function tidyup!(A::AbstractSparseArray, tol::T2 = settings.tidyup_tol) where {T2<:Real}
     tidyup!(nonzeros(A), tol) # tidyup A.nzval in-place (also support for CUDA sparse arrays)
     return dropzeros!(A)
 end
-tidyup!(A::AbstractArray{T}, tol::T2 = settings.tidyup_tol[]) where {T<:Real,T2<:Real} = @. A = T(abs(A) > tol) * A
-tidyup!(A::AbstractArray{T}, tol::T2 = settings.tidyup_tol[]) where {T,T2<:Real} =
+tidyup!(A::AbstractArray{T}, tol::T2 = settings.tidyup_tol) where {T<:Real,T2<:Real} = @. A = T(abs(A) > tol) * A
+tidyup!(A::AbstractArray{T}, tol::T2 = settings.tidyup_tol) where {T,T2<:Real} =
     @. A = T(abs(real(A)) > tol) * real(A) + 1im * T(abs(imag(A)) > tol) * imag(A)
 
 @doc raw"""

src/qobj/eigsolve.jl

@@ -249,7 +249,7 @@ function _eigsolve(
     end
     mul!(cache1, Vₘ, M(Uₘ * VR))
     vecs = cache1[:, 1:k]
-    settings.auto_tidyup[] && tidyup!(vecs)
+    settings.auto_tidyup && tidyup!(vecs)
 
     return EigsolveResult(vals, vecs, type, dimensions, iter, numops, (iter < maxiter))
 end
@@ -351,7 +351,7 @@ function eigsolve(
     end
 
     vecs = res.vectors
-    settings.auto_tidyup[] && tidyup!(vecs)
+    settings.auto_tidyup && tidyup!(vecs)
 
     return EigsolveResult(vals, vecs, res.type, res.dimensions, res.iter, res.numops, res.converged)
 end
@@ -434,7 +434,7 @@ function eigsolve_al(
         @. vecs[:, i] = vec * exp(-1im * angle(vec[1]))
     end
 
-    settings.auto_tidyup[] && tidyup!(vecs)
+    settings.auto_tidyup && tidyup!(vecs)
 
     return EigsolveResult(vals, vecs, res.type, res.dimensions, res.iter, res.numops, res.converged)
 end
@@ -479,7 +479,7 @@ function LinearAlgebra.eigen(A::QuantumObject{OpType}; kwargs...) where {OpType<
     # This fixes a type inference issue. But doesn't work for GPU arrays
     E::mat2vec(to_dense(MT)) = F.values
     U::to_dense(MT) = F.vectors
-    settings.auto_tidyup[] && tidyup!(U)
+    settings.auto_tidyup && tidyup!(U)
 
     return EigsolveResult(E, U, A.type, A.dimensions, 0, 0, true)
 end

src/settings.jl

@@ -1,12 +1,12 @@
-Base.@kwdef struct Settings
-    tidyup_tol::RefValue{Float64} = 1e-14
-    auto_tidyup::RefValue{Bool} = true
+Base.@kwdef mutable struct Settings
+    tidyup_tol::Float64 = 1e-14
+    auto_tidyup::Bool = true
 end
 
 function Base.show(io::IO, s::Settings)
     println(io, "QuantumToolbox.jl Settings")
     println(io, "--------------------------")
-    map(x -> println(io, "$x[] = ", getfield(s, x)[]), fieldnames(Settings))
+    map(x -> println(io, "$x = ", getfield(s, x)), fieldnames(Settings))
     return nothing
 end
 
@@ -29,8 +29,8 @@ One can overwrite the default global settings by
 ```julia
 using QuantumToolbox
 
-QuantumToolbox.settings.tidyup_tol[] = 1e-10
-QuantumToolbox.settings.auto_tidyup[] = false
+QuantumToolbox.settings.tidyup_tol = 1e-10
+QuantumToolbox.settings.auto_tidyup = false
 ```
 """
 const settings = Settings()