add deprecated methods to deprecated.jl

Author: ytdHuang

src/deprecated.jl

@@ -19,3 +19,87 @@ export FFTCorrelation
 FFTCorrelation() = error(
     "`FFTCorrelation` has been deprecated and will be removed in next major release, please use `spectrum_correlation_fft` to calculate the spectrum with FFT method instead.",
 )
+
+correlation_3op_2t(
+    H::QuantumObject{<:AbstractArray{T1},HOpType},
+    ψ0::QuantumObject{<:AbstractArray{T2},StateOpType},
+    t_l::AbstractVector,
+    τ_l::AbstractVector,
+    A::QuantumObject{<:AbstractArray{T3},OperatorQuantumObject},
+    B::QuantumObject{<:AbstractArray{T4},OperatorQuantumObject},
+    C::QuantumObject{<:AbstractArray{T5},OperatorQuantumObject},
+    c_ops::Union{Nothing,AbstractVector,Tuple} = nothing;
+    kwargs...,
+) where {
+    T1,
+    T2,
+    T3,
+    T4,
+    T5,
+    HOpType<:Union{OperatorQuantumObject,SuperOperatorQuantumObject},
+    StateOpType<:Union{KetQuantumObject,OperatorQuantumObject},
+} = error(
+    "The parameter order of `correlation_3op_2t` has been changed, please use `?correlation_3op_2t` to check the updated docstring.",
+)
+
+correlation_3op_1t(
+    H::QuantumObject{<:AbstractArray{T1},HOpType},
+    ψ0::QuantumObject{<:AbstractArray{T2},StateOpType},
+    τ_l::AbstractVector,
+    A::QuantumObject{<:AbstractArray{T3},OperatorQuantumObject},
+    B::QuantumObject{<:AbstractArray{T4},OperatorQuantumObject},
+    C::QuantumObject{<:AbstractArray{T5},OperatorQuantumObject},
+    c_ops::Union{Nothing,AbstractVector,Tuple} = nothing;
+    kwargs...,
+) where {
+    T1,
+    T2,
+    T3,
+    T4,
+    T5,
+    HOpType<:Union{OperatorQuantumObject,SuperOperatorQuantumObject},
+    StateOpType<:Union{KetQuantumObject,OperatorQuantumObject},
+} = error(
+    "The parameter order of `correlation_3op_1t` has been changed, please use `?correlation_3op_1t` to check the updated docstring.",
+)
+
+correlation_2op_2t(
+    H::QuantumObject{<:AbstractArray{T1},HOpType},
+    ψ0::QuantumObject{<:AbstractArray{T2},StateOpType},
+    t_l::AbstractVector,
+    τ_l::AbstractVector,
+    A::QuantumObject{<:AbstractArray{T3},OperatorQuantumObject},
+    B::QuantumObject{<:AbstractArray{T4},OperatorQuantumObject},
+    c_ops::Union{Nothing,AbstractVector,Tuple} = nothing;
+    reverse::Bool = false,
+    kwargs...,
+) where {
+    T1,
+    T2,
+    T3,
+    T4,
+    HOpType<:Union{OperatorQuantumObject,SuperOperatorQuantumObject},
+    StateOpType<:Union{KetQuantumObject,OperatorQuantumObject},
+} = error(
+    "The parameter order of `correlation_2op_2t` has been changed, please use `?correlation_2op_2t` to check the updated docstring.",
+)
+
+correlation_2op_1t(
+    H::QuantumObject{<:AbstractArray{T1},HOpType},
+    ψ0::QuantumObject{<:AbstractArray{T2},StateOpType},
+    τ_l::AbstractVector,
+    A::QuantumObject{<:AbstractArray{T3},OperatorQuantumObject},
+    B::QuantumObject{<:AbstractArray{T4},OperatorQuantumObject},
+    c_ops::Union{Nothing,AbstractVector,Tuple} = nothing;
+    reverse::Bool = false,
+    kwargs...,
+) where {
+    T1,
+    T2,
+    T3,
+    T4,
+    HOpType<:Union{OperatorQuantumObject,SuperOperatorQuantumObject},
+    StateOpType<:Union{KetQuantumObject,OperatorQuantumObject},
+} = error(
+    "The parameter order of `correlation_2op_1t` has been changed, please use `?correlation_2op_1t` to check the updated docstring.",
+)

test/core-test/correlations_and_spectrum.jl

@@ -1,6 +1,7 @@
 @testset "Correlations and Spectrum" begin
-    Id = qeye(10)
-    a = destroy(10)
+    N = 10
+    Id = qeye(N)
+    a = destroy(N)
     H = a' * a
     c_ops = [sqrt(0.1 * (0.01 + 1)) * a, sqrt(0.1 * (0.01)) * a']
 
@@ -33,6 +34,7 @@
         @inferred spectrum(H, ω_l2, c_ops, a', a; solver = PseudoInverse())
     end
 
+    # tlist and τlist checks
     t_wrong1 = [1, 2, 3]
     t_wrong2 = [-1, 0, 1]
     @test_throws ArgumentError correlation_3op_2t(H, nothing, t_l, t_wrong1, c_ops, Id, a', a)
@@ -43,5 +45,13 @@
     @test_throws ArgumentError correlation_3op_2t(H, nothing, t_wrong1, t_wrong2, c_ops, Id, a', a)
     @test_throws ArgumentError correlation_3op_2t(H, nothing, t_wrong2, t_wrong1, c_ops, Id, a', a)
     @test_throws ArgumentError correlation_3op_2t(H, nothing, t_wrong2, t_wrong2, c_ops, Id, a', a)
-    @test_throws ErrorException FFTCorrelation()
+
+    @testset "Deprecated Errors" begin
+        ρ0 = rand_dm(N)
+        @test_throws ErrorException FFTCorrelation()
+        @test_throws ErrorException correlation_3op_2t(H, ρ0, t_l, t_l, a, a', a, c_ops)
+        @test_throws ErrorException correlation_3op_1t(H, ρ0, t_l, a, a', a, c_ops)
+        @test_throws ErrorException correlation_2op_2t(H, ρ0, t_l, t_l, a', a, c_ops)
+        @test_throws ErrorException correlation_2op_1t(H, ρ0, t_l, a', a, c_ops)
+    end
 end