rename field tlist as times, and times as times_states

Author: ytdHuang

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Implement `EnrSpace` and corresponding functionality. ([#500])
 - Check for orthogonality breakdown in `Lanczos` solver for `spectrum`. ([#501])
-- Store both `tlist` and `times` in time evolution solutions. ([#506], [#504])
+- Store both `times` and `times_states` in time evolution solutions. ([#506], [#504])
 - Fix errors in `Julia v1.12`. ([#507])
 
 ## [v0.32.1]

docs/src/users_guide/time_evolution/sesolve.md

@@ -59,8 +59,8 @@ sol = sesolve(H, ψ0, tlist, e_ops = [sigmaz(), sigmay()])
     Here, we call [`sesolve`](@ref) directly instead of pre-defining [`sesolveProblem`](@ref) first (as shown previously).
 
 ```@example sesolve
-println(size(sol.tlist)) # time points corresponds to stored expectation values 
-println(size(sol.times)) # time points corresponds to stored states
+println(size(sol.times)) # time points corresponds to stored expectation values 
+println(size(sol.times_states)) # time points corresponds to stored states
 ```
 
 ```@example sesolve
@@ -91,8 +91,8 @@ If the keyword argument `e_ops` is not specified (or given as an empty `Vector`)
 tlist = [0, 10]
 sol = sesolve(H, ψ0, tlist) # or specify: e_ops = []
 
-println(size(sol.tlist))
 println(size(sol.times))
+println(size(sol.times_states))
 
 sol.states
 ```
@@ -107,11 +107,11 @@ sol = sesolve(H, ψ0, tlist, e_ops = [sigmay()], saveat = tlist)
 ```
 
 ```@example sesolve
-println(size(sol.tlist))
+println(size(sol.times))
 sol.expect
 ```
 
 ```@example sesolve
-println(size(sol.times))
+println(size(sol.times_states))
 sol.states
 ```

docs/src/users_guide/time_evolution/solution.md

@@ -12,10 +12,10 @@ CairoMakie.enable_only_mime!(MIME"image/svg+xml"())
 
 | **Fields (Attributes)** | **Description** |
 |:------------------------|:----------------|
-| `sol.times` | The list of time points at which the states are stored during the evolution. |
-| `sol.tlist` | The list of time points at which the expectation values are calculated during the evolution. |
-| `sol.states` | The list of result states corresponding to each time point in `times`. |
-| `sol.expect` | The expectation values corresponding to each time point in `sol.tlist`. |
+| `sol.times` | The list of time points at which the expectation values are calculated during the evolution. |
+| `sol.times_states` | The list of time points at which the states are stored during the evolution. |
+| `sol.states` | The list of result states corresponding to each time point in `sol.times_states`. |
+| `sol.expect` | The expectation values corresponding to each time point in `sol.times`. |
 | `sol.alg` | The algorithm which is used during the solving process. |
 | `sol.abstol` | The absolute tolerance which is used during the solving process. |
 | `sol.reltol` | The relative tolerance which is used during the solving process. |
@@ -58,7 +58,7 @@ Recall that `Julia` uses `Fortran`-style indexing that begins with one (i.e., `[
 Together with the list of time points at which these expectation values are calculated:
 
 ```@example TE-solution
-tlist = sol.tlist
+times = sol.times
 nothing # hide
 ```
 
@@ -68,9 +68,9 @@ we can plot the resulting expectation values:
 # plot by CairoMakie.jl
 fig = Figure(size = (500, 350))
 ax = Axis(fig[1, 1], xlabel = L"t")
-lines!(ax, tlist, expt1, label = L"\langle 0 | \rho(t) | 0 \rangle")
-lines!(ax, tlist, expt2, label = L"\langle 1 | \rho(t) | 1 \rangle")
-lines!(ax, tlist, expt3, label = L"\langle 0 | \rho(t) | 1 \rangle")
+lines!(ax, times, expt1, label = L"\langle 0 | \rho(t) | 0 \rangle")
+lines!(ax, times, expt2, label = L"\langle 1 | \rho(t) | 1 \rangle")
+lines!(ax, times, expt3, label = L"\langle 0 | \rho(t) | 1 \rangle")
 
 ylims!(ax, (-0.5, 1.0))
 axislegend(ax, position = :lb)
@@ -87,7 +87,7 @@ sol.states
 Together with the list of time points at which these states are stored:
 
 ```@example TE-solution
-times = sol.times
+times = sol.times_states
 nothing # hide
 ```
 

src/time_evolution/lr_mesolve.jl

@@ -7,11 +7,11 @@ A structure storing the results and some information from solving low-rank maste
 
 # Fields (Attributes)
 
-- `times::AbstractVector`: The list of time points at which the states are stored during the evolution.
-- `tlist::AbstractVector`: The list of time points at which the expectation values are calculated during the evolution.
-- `states::Vector{QuantumObject}`: The list of result states corresponding to each time point in `times`.
-- `expect::Matrix`: The expectation values corresponding to each time point in `tlist`.
-- `fexpect::Matrix`: The function values corresponding to each time point in `tlist`.
+- `times::AbstractVector`: The list of time points at which the expectation values are calculated during the evolution.
+- `times_states::AbstractVector`: The list of time points at which the states are stored during the evolution.
+- `states::Vector{QuantumObject}`: The list of result states corresponding to each time point in `times_states`.
+- `expect::Matrix`: The expectation values corresponding to each time point in `times`.
+- `fexpect::Matrix`: The function values corresponding to each time point in `times`.
 - `retcode`: The return code from the solver.
 - `alg`: The algorithm which is used during the solving process.
 - `abstol::Real`: The absolute tolerance which is used during the solving process.
@@ -32,7 +32,7 @@ struct TimeEvolutionLRSol{
     TM<:Vector{<:Integer},
 }
     times::TT1
-    tlist::TT2
+    times_states::TT2
     states::TS
     expect::TE
     fexpect::TE
@@ -147,19 +147,19 @@ function _periodicsave_func(integrator)
     return u_modified!(integrator, false)
 end
 
-_save_control_lr_mesolve(u, t, integrator) = t in integrator.p.tlist
+_save_control_lr_mesolve(u, t, integrator) = t in integrator.p.times
 
 function _save_affect_lr_mesolve!(integrator)
     ip = integrator.p
     N, M = ip.N, ip.M
-    idx = select(integrator.t, ip.tlist)
+    idx = select(integrator.t, ip.times)
 
     @views z = reshape(integrator.u[1:(N*M)], N, M)
     @views B = reshape(integrator.u[(N*M+1):end], M, M)
     _calculate_expectation!(ip, z, B, idx)
 
     if integrator.p.opt.progress
-        print("\rProgress: $(round(Int, 100*idx/length(ip.tlist)))%")
+        print("\rProgress: $(round(Int, 100*idx/length(ip.times)))%")
         flush(stdout)
     end
     return u_modified!(integrator, false)
@@ -433,7 +433,7 @@ function lr_mesolveProblem(
         e_ops = e_ops,
         f_ops = f_ops,
         opt = opt,
-        tlist = t_l,
+        times = t_l,
         expvals = expvals,
         funvals = funvals,
         Ml = Ml,
@@ -540,7 +540,7 @@ function lr_mesolve(
 end
 
 function lr_mesolve(prob::ODEProblem; kwargs...)
-    sol = solve(prob, prob.p.opt.alg, tstops = prob.p.tlist)
+    sol = solve(prob, prob.p.opt.alg, tstops = prob.p.times)
     prob.p.opt.progress && print("\n")
 
     N = prob.p.N
@@ -552,8 +552,8 @@ function lr_mesolve(prob::ODEProblem; kwargs...)
     ρt = map(x -> Qobj(x[1] * x[2] * x[1]', type = Operator(), dims = prob.p.Hdims), zip(zt, Bt))
 
     return TimeEvolutionLRSol(
+        prob.p.times,
         sol.t,
-        prob.p.tlist,
         ρt,
         prob.p.expvals,
         prob.p.funvals,

src/time_evolution/mcsolve.jl

@@ -254,7 +254,7 @@ function mcsolveEnsembleProblem(
 
     ensemble_prob = TimeEvolutionProblem(
         EnsembleProblem(prob_mc.prob, prob_func = _prob_func, output_func = _output_func[1], safetycopy = false),
-        prob_mc.tlist,
+        prob_mc.times,
         prob_mc.dimensions,
         (progr = _output_func[2], channel = _output_func[3]),
     )
@@ -411,8 +411,8 @@ function mcsolve(
 
     return TimeEvolutionMCSol(
         ntraj,
+        ens_prob_mc.times,
         _sol_1.t,
-        ens_prob_mc.tlist,
         states,
         expvals,
         expvals, # This is average_expect

src/time_evolution/mesolve.jl

@@ -205,8 +205,8 @@ function mesolve(prob::TimeEvolutionProblem, alg::OrdinaryDiffEqAlgorithm = Tsit
     end
 
     return TimeEvolutionSol(
+        prob.times,
         sol.t,
-        prob.tlist,
         ρt,
         _get_expvals(sol, SaveFuncMESolve),
         sol.retcode,

src/time_evolution/sesolve.jl

@@ -155,8 +155,8 @@ function sesolve(prob::TimeEvolutionProblem, alg::OrdinaryDiffEqAlgorithm = Tsit
     ψt = map(ϕ -> QuantumObject(ϕ, type = Ket(), dims = prob.dimensions), sol.u)
 
     return TimeEvolutionSol(
+        prob.times,
         sol.t,
-        prob.tlist,
         ψt,
         _get_expvals(sol, SaveFuncSESolve),
         sol.retcode,

src/time_evolution/smesolve.jl

@@ -269,7 +269,7 @@ function smesolveEnsembleProblem(
 
     ensemble_prob = TimeEvolutionProblem(
         EnsembleProblem(prob_sme, prob_func = _prob_func, output_func = _output_func[1], safetycopy = true),
-        prob_sme.tlist,
+        prob_sme.times,
         prob_sme.dimensions,
         merge(prob_sme.kwargs, (progr = _output_func[2], channel = _output_func[3])),
     )
@@ -424,8 +424,8 @@ function smesolve(
 
     return TimeEvolutionStochasticSol(
         ntraj,
+        ens_prob.times,
         _sol_1.t,
-        ens_prob.tlist,
         states,
         expvals,
         expvals, # This is average_expect

src/time_evolution/ssesolve.jl

@@ -262,7 +262,7 @@ function ssesolveEnsembleProblem(
 
     ensemble_prob = TimeEvolutionProblem(
         EnsembleProblem(prob_sme, prob_func = _prob_func, output_func = _output_func[1], safetycopy = true),
-        prob_sme.tlist,
+        prob_sme.times,
         prob_sme.dimensions,
         (progr = _output_func[2], channel = _output_func[3]),
     )
@@ -418,8 +418,8 @@ function ssesolve(
 
     return TimeEvolutionStochasticSol(
         ntraj,
+        ens_prob.times,
         _sol_1.t,
-        ens_prob.tlist,
         states,
         expvals,
         expvals, # This is average_expect

src/time_evolution/time_evolution.jl

@@ -14,7 +14,7 @@ A Julia constructor for handling the `ODEProblem` of the time evolution of quant
 # Fields (Attributes)
 
 - `prob::AbstractSciMLProblem`: The `ODEProblem` of the time evolution.
-- `tlist::AbstractVector`: The time list of the evolution.
+- `times::AbstractVector`: The time list of the evolution.
 - `dimensions::AbstractDimensions`: The dimensions of the Hilbert space.
 - `kwargs::KWT`: Generic keyword arguments.
 
@@ -23,7 +23,7 @@ A Julia constructor for handling the `ODEProblem` of the time evolution of quant
 """
 struct TimeEvolutionProblem{PT<:AbstractSciMLProblem,TT<:AbstractVector,DT<:AbstractDimensions,KWT}
     prob::PT
-    tlist::TT
+    times::TT
     dimensions::DT
     kwargs::KWT
 end
@@ -37,7 +37,7 @@ function Base.getproperty(prob::TimeEvolutionProblem, key::Symbol)
     end
 end
 
-TimeEvolutionProblem(prob, tlist, dims) = TimeEvolutionProblem(prob, tlist, dims, nothing)
+TimeEvolutionProblem(prob, times, dims) = TimeEvolutionProblem(prob, times, dims, nothing)
 
 @doc raw"""
     struct TimeEvolutionSol
@@ -46,10 +46,10 @@ A structure storing the results and some information from solving time evolution
 
 # Fields (Attributes)
 
-- `times::AbstractVector`: The list of time points at which the states are stored during the evolution.
-- `tlist::AbstractVector`: The list of time points at which the expectation values are calculated during the evolution.
-- `states::Vector{QuantumObject}`: The list of result states corresponding to each time point in `times`.
-- `expect::Union{AbstractMatrix,Nothing}`: The expectation values corresponding to each time point in `tlist`.
+- `times::AbstractVector`: The list of time points at which the expectation values are calculated during the evolution.
+- `times_states::AbstractVector`: The list of time points at which the states are stored during the evolution.
+- `states::Vector{QuantumObject}`: The list of result states corresponding to each time point in `times_states`.
+- `expect::Union{AbstractMatrix,Nothing}`: The expectation values corresponding to each time point in `times`.
 - `retcode`: The return code from the solver.
 - `alg`: The algorithm which is used during the solving process.
 - `abstol::Real`: The absolute tolerance which is used during the solving process.
@@ -66,7 +66,7 @@ struct TimeEvolutionSol{
     RT<:Real,
 }
     times::TT1
-    tlist::TT2
+    times_states::TT2
     states::TS
     expect::TE
     retcode::RETT
@@ -99,12 +99,12 @@ A structure storing the results and some information from solving quantum trajec
 # Fields (Attributes)
 
 - `ntraj::Int`: Number of trajectories
-- `times::AbstractVector`: The list of time points at which the states are stored during the evolution.
-- `tlist::AbstractVector`: The list of time points at which the expectation values are calculated during the evolution.
-- `states::Vector{Vector{QuantumObject}}`: The list of result states in each trajectory and each time point in `times`.
-- `expect::Union{AbstractMatrix,Nothing}`: The expectation values (averaging all trajectories) corresponding to each time point in `tlist`.
-- `average_expect::Union{AbstractMatrix,Nothing}`: The expectation values (averaging all trajectories) corresponding to each time point in `tlist`.
-- `runs_expect::Union{AbstractArray,Nothing}`: The expectation values corresponding to each trajectory and each time point in `tlist`
+- `times::AbstractVector`: The list of time points at which the expectation values are calculated during the evolution.
+- `times_states::AbstractVector`: The list of time points at which the states are stored during the evolution.
+- `states::Vector{Vector{QuantumObject}}`: The list of result states in each trajectory and each time point in `times_states`.
+- `expect::Union{AbstractMatrix,Nothing}`: The expectation values (averaging all trajectories) corresponding to each time point in `times`.
+- `average_expect::Union{AbstractMatrix,Nothing}`: The expectation values (averaging all trajectories) corresponding to each time point in `times`.
+- `runs_expect::Union{AbstractArray,Nothing}`: The expectation values corresponding to each trajectory and each time point in `times`
 - `col_times::Vector{Vector{Real}}`: The time records of every quantum jump occurred in each trajectory.
 - `col_which::Vector{Vector{Int}}`: The indices of which collapse operator was responsible for each quantum jump in `col_times`.
 - `converged::Bool`: Whether the solution is converged or not.
@@ -126,7 +126,7 @@ struct TimeEvolutionMCSol{
 }
     ntraj::Int
     times::TT1
-    tlist::TT2
+    times_states::TT2
     states::TS
     expect::TE
     average_expect::TE # Currently just a synonym for `expect`
@@ -164,12 +164,12 @@ A structure storing the results and some information from solving trajectories o
 # Fields (Attributes)
 
 - `ntraj::Int`: Number of trajectories
-- `times::AbstractVector`: The list of time points at which the states are stored during the evolution.
-- `tlist::AbstractVector`: The list of time points at which the expectation values are calculated during the evolution.
-- `states::Vector{Vector{QuantumObject}}`: The list of result states in each trajectory and each time point in `times`.
-- `expect::Union{AbstractMatrix,Nothing}`: The expectation values (averaging all trajectories) corresponding to each time point in `tlist`.
-- `average_expect::Union{AbstractMatrix,Nothing}`: The expectation values (averaging all trajectories) corresponding to each time point in `tlist`.
-- `runs_expect::Union{AbstractArray,Nothing}`: The expectation values corresponding to each trajectory and each time point in `tlist`
+- `times::AbstractVector`: The list of time points at which the expectation values are calculated during the evolution.
+- `times_states::AbstractVector`: The list of time points at which the states are stored during the evolution.
+- `states::Vector{Vector{QuantumObject}}`: The list of result states in each trajectory and each time point in `times_states`.
+- `expect::Union{AbstractMatrix,Nothing}`: The expectation values (averaging all trajectories) corresponding to each time point in `times`.
+- `average_expect::Union{AbstractMatrix,Nothing}`: The expectation values (averaging all trajectories) corresponding to each time point in `times`.
+- `runs_expect::Union{AbstractArray,Nothing}`: The expectation values corresponding to each trajectory and each time point in `times`
 - `converged::Bool`: Whether the solution is converged or not.
 - `alg`: The algorithm which is used during the solving process.
 - `abstol::Real`: The absolute tolerance which is used during the solving process.
@@ -188,7 +188,7 @@ struct TimeEvolutionStochasticSol{
 }
     ntraj::Int
     times::TT1
-    tlist::TT2
+    times_states::TT2
     states::TS
     expect::TE
     average_expect::TE # Currently just a synonym for `expect`